创建服务
最近更新时间: 2024-10-18 10:38:33
1. 接口描述
接口请求域名： apigateway.api3.fincloud.tencent.cn。
本接口（CreateService）用于创建服务。 API 网关使用的最大单元为服务，每个服务中可创建多个 API 接口。每个服务有一个默认域名供客户调用，用户也可绑定自定义域名到此服务中。
默认接口请求频率限制：20次/秒。
接口更新时间：2021-11-23 12:10:29。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CreateService |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-08-08 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| ServiceName | 是 | 否 | String | 用户自定义的服务名称。 |
| ServiceDesc | 否 | 否 | String | 用户自定义的服务描述。 |
| Protocol | 是 | 否 | String | 服务的前端请求类型。如 http、https、http&https。 |
| ExclusiveSetName | 否 | 否 | String | 独立集群名称，用于指定创建服务所在的独立集群。 |
| NetTypes | 否 | 否 | Array of String | 网络类型列表，用于指定支持的访问类型，INNER为内网访问，OUTER为外网访问。默认为OUTER。 |
| IpVersion | 否 | 否 | String | IP版本号，支持IPv4和IPv6，默认为IPv4。 |
| SetServerName | 否 | 否 | String | 集群名称。保留字段，tsf serverlss类型使用。 |
| AppIdType | 否 | 否 | String | 用户类型。保留类型，serverless用户使用。 |
| Tags | 否 | 否 | Array of Tag | 标签。 |
| InstanceId | 否 | 否 | String | 独享实例id |
| ProjectId | 否 | 否 | String | 项目ID |
| TceArch | 否 | 否 | String | CPU架构，可选项[arm, x86] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ServiceId | String | 服务唯一ID。 |
| ServiceName | String | 用户自定义服务名称。 |
| ServiceDesc | String | 用户自定义服务描述。 |
| OuterSubDomain | String | 外网默认域名。 |
| InnerSubDomain | String | vpc内网默认域名。 |
| CreatedTime | Datetime_iso | 服务创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。 |
| NetTypes | String | 网络类型列表，INNER为内网访问，OUTER为外网访问。 |
| IpVersion | String | IP版本号。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| ResourceNotFound | |
| InvalidParameterValue | |
| InvalidParameter.FormatError | |
| LimitExceeded.IpStrategyLimitExceeded | |
| MissingParameter | |
| InternalError | |
| InternalError.OssException | |
| UnauthorizedOperation.UncertifiedUser | |
| InternalError.VpcException | |
| ResourceInUse | |
| AuthFailure | |
| RequestLimitExceeded | |
| ResourceInsufficient | |
| LimitExceeded | |
| DryRunOperation | |
| FailedOperation | |
| FailedOperation.TagBindServiceError | |
| InvalidParameterValue.ParameterValueLimitExceeded | |
| InvalidParameterValue.InvalidRegion | |
| InternalError.CauthException | |
| LimitExceeded.ServiceCountLimitExceeded | |
| UnsupportedOperation.InvalidAction | |
| FailedOperation.InstanceNotExist |