创建服务

最近更新时间:2019-04-26 15:17:40

接口描述

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

输入参数

以下请求参数列表仅列出了接口请求参数,其它参数可参考 公共请求参数

参数名称 是否必选 类型 描述
serviceName String 用户自定义的服务名称。如果没传,则系统自动生成一个唯一名称。
serviceDesc String 用户自定义的服务描述。
protocol String 服务的前端请求类型。如 HTTP、HTTPS、HTTP 和 HTTPS。

输出参数

参数名称 类型 描述
code Int 公共错误码,0表示成功,其他值表示失败。详见错误码页面的 公共错误码
codeDesc String 业务侧错误码。成功时返回 Success,错误时返回具体业务错误原因
message String 模块错误信息描述,与接口相关
serviceName String 服务名称
serviceDesc String 服务描述
subDomain String 服务的域名,由系统自动生成
serviceId String 服务唯一 Id,由系统生成,全局唯一
createdTime Timestamp 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ

示例

https://apigateway.api.qcloud.com/v2/index.php?
&<公共请求参数>
&Action=CreateService
&serviceName=test
&serviceDescription=testDescription
&protocol=http

返回示例如下:

{
    "code": "0",
    "message": "",
    "codeDesc": "Success",
    "serviceId": "service-XXXX",
    "serviceName": "test",
    "serviceDesc": "desc",
    "subDomain": "523e8dc7bbe04613b5b1d726c2a7889d-apigateway.ap-guangzhou.qcloud.com",
    "createdTime": "2017-08-07T00:00:00Z"
}