查询服务环境列表

最近更新时间:2019-04-26 15:21:37

接口描述

本接口(DescribeServiceEnvironmentList)用于查询一个服务的环境列表,可查询到此服务下所有环境及其状态。

输入参数

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

参数名称 是否必选 类型 描述
serviceId String 待查询的服务唯一 ID。
limit Int 返回数量。
offset Int 偏移量。

输出参数

参数名称 类型 描述
code Int 公共错误码, 0 表示成功,其他值表示失败。详见错误码页面的 公共错误码
codeDesc String 业务侧错误码。成功时返回 Success,错误时返回具体业务错误原因。
message String 模块错误信息描述,与接口相关。
totalCount String 环境总数。
environmentList List of Array 环境列表。

environmentList 是环境列表,它是由 environmentAttribute 组成的数组,environmentAttribute 构成如下:

参数名称 类型 描述
environmentName String 环境名称。
url String 访问路径。
status Int 发布状态,1 表示已发布,0 表示未发布
verisonName String 运行版本。

示例

https://apigateway.api.qcloud.com/v2/index.php?
&<公共请求参数>
&Action=DescribeServiceEnvironmentList
&serviceId=service-XX

返回示例如下:

{
    "code":"0",
    "message":"",
    "codeDesc":"Success",      
    "totalCount":2,
    "environmentList":[
        {
            "environmentName":"test",
            "url":"hahah.ap-guangzhou.1251000011.tencentyunapi.com/test",
            "status":0,
            "verisonName":""
        },
        {
            "environmentName":"pre",
            "url":"hahah.ap-guangzhou.1251000011.tencentyunapi.com/pre",
            "status":1,
            "verisonName":"version-20170904xx"
        }
    ]
}