API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > API 网关 > 服务相关接口 > 创建服务

创建服务

最近更新时间：2024-03-25 01:07:49

我的收藏

本页目录：

1. 接口描述

接口请求域名： apigateway.tencentcloudapi.com 。

本接口（CreateService）用于创建服务。
API 网关使用的最大单元为服务，每个服务中可创建多个 API 接口。每个服务有一个默认域名供客户调用，用户也可绑定自定义域名到此服务中。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：CreateService。
Version 是 String 公共参数，本接口取值：2018-08-08。
Region 是 String 公共参数，详见产品支持的 地域列表。
ServiceName 是 String 用户自定义的服务名称。
示例值：test_https
Protocol 是 String 服务的前端请求类型。如 http、https、http&https。
示例值：https
ServiceDesc 否 String 用户自定义的服务描述。
示例值：https
NetTypes.N 否 Array of String 网络类型列表，用于指定支持的访问类型，INNER为内网访问，OUTER为外网访问。默认为OUTER。
示例值：xxx
IpVersion 否 String IP版本号，仅支持IPv4。
示例值：xxxx
SetServerName 否 String 集群名称。保留字段，tsf serverless类型使用。
示例值：xxxx
AppIdType 否 String 用户类型。保留类型，serverless用户使用。
示例值：xxxx
Tags.N 否 Array of Tag 标签。
InstanceId 否 String 独享实例id
示例值：instance-12345
UniqVpcId 否 String vpc属性，选择VPC后不可修改，为服务选择VPC后，可对接该VPC下的后端资源
示例值：vpc-quyenan

3. 输出参数

参数名称 类型 描述
ServiceId String 服务唯一ID。
示例值：service-0c96l2bo
ServiceName String 用户自定义服务名称。
示例值：test_https
ServiceDesc String 用户自定义服务描述。
示例值：https
OuterSubDomain String 外网默认域名。
示例值：service-0c96l2bo-1251006373.ap-guangzhou.apigateway.myqcloud.com
InnerSubDomain String vpc内网默认域名。
示例值：service-0c96l2bo-1251006373.ap-guangzhou.apigateway.myqcloud.com
CreatedTime Timestamp ISO8601 服务创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。
示例值：2020-09-22T00:00:00+00:00
NetTypes Array of String 网络类型列表，INNER为内网访问，OUTER为外网访问。
示例值：["OUTER"]
IpVersion String IP版本号。
注意：此字段可能返回 null，表示取不到有效值。
示例值：IPv4
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 CreateService

创建服务时使用

输入示例

https://apigateway.tencentcloudapi.com/?Action=CreateService
&ServiceName=test_https
&ServiceDesc=https
&Protocol=https
&<公共请求参数>

输出示例

{
    "Response": {
        "ServiceId": "service-0c96l2bo",
        "ServiceName": "test_https",
        "ServiceDesc": "https",
        "OuterSubDomain": "service-0c96l2bo-1251006373.ap-guangzhou.apigateway.myqcloud.com",
        "InnerSubDomain": "",
        "IpVersion": "IPv4",
        "CreatedTime": "2020-09-22T00:00:00+00:00",
        "NetTypes": [
            "OUTER"
        ],
        "RequestId": "e3705d00-bfe0-4fde-942c-cebd6b12431b"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
AuthFailure CAM签名/鉴权错误。
DryRunOperation DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。
FailedOperation 操作失败。
FailedOperation.InstanceNotExist 实例不存在，或者无效状态。
FailedOperation.TagBindServiceError 标签绑定服务失败。
InternalError 内部错误。
InternalError.ApigwException API网关内部请求错误，请稍后重试。若无法解决，请联系智能客服或提交工单。
InternalError.CauthException CAuth内部请求错误，请稍后重试。若无法解决，请联系智能客服或提交工单。
InternalError.OssException oss内部请求错误，请稍后重试。若无法解决，请联系智能客服或提交工单。
InternalError.VpcException vpc内部请求错误，请稍后重试。若无法解决，请联系智能客服或提交工单。
InvalidParameter.FormatError 参数格式错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.InvalidRegion 地域错误。
InvalidParameterValue.InvalidVpcConfig 无效vpc信息。
InvalidParameterValue.NotInOptions 参数取值错误。当前值不在可选范围内。
InvalidParameterValue.ParameterValueLimitExceeded 参数个数超过限制。
LimitExceeded 超过配额限制。
LimitExceeded.IpStrategyLimitExceeded IP策略数量超出限制。
LimitExceeded.ServiceCountLimitExceeded 服务数量超过限制，请删除服务或提升限额后重试。
MissingParameter 缺少参数错误。
RequestLimitExceeded 请求的次数超过了频率限制。
ResourceInUse 资源被占用。
ResourceInsufficient 资源不足。
ResourceNotFound 资源不存在。
UnauthorizedOperation.UncertifiedUser 用户未实名制。
UnsupportedOperation.AccountArrears 账号余额不足
UnsupportedOperation.InvalidAction 接口错误。
UnsupportedOperation.UnpackError Unpack函数错误
中国站