查询服务列表

最近更新时间:2019-04-26 15:20:46

接口描述

本接口(DescribeServicesStatus)用于搜索查询某一个服务或多个服务的列表,并返回服务相关的域名、时间等信息。

输入参数

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

参数名称 是否必选 类型 描述
serviceIds.n Array of Strings 按照一个或者多个服务唯一 ID 查询
offset Int 偏移量,默认为 0。当服务数量极多时,可使用 offset 选择从第几个服务开始返回详细信息
limit Int 返回数量,默认为 20,最大值为 100
orderby String 根据哪个字段排序
order String 排序方式。默认为 desc
searchName String 按照服务名字模糊搜索
searchId String 按照服务唯一 ID 精确搜索

输出参数

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

其中,serviceStatusSet 是 serviceStatus 构成的数组,serviceStatus 的构成如下:

参数名称 类型 描述
serviceId String 服务唯一 ID
serviceName String 用户自定义的服务名称
serviceDescription String 用户自定义的服务描述
subDomain String 系统给该服务自动分配的域名
protocol String 服务的前端请求类型。如 HTTP 和 HTTPS
createdTime Timestamp 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ
modifiedTime Timestamp 最后修改时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ
availableEnvironments List Of String 已经发布的环境列表,如 Test,Pre,release

示例

https://apigateway.api.qcloud.com/v2/index.php?
&<公共请求参数>
&Action=DescribeServicesStatus
&serviceIds.0=service-XX
&serviceIds.1=service-XXXX
&offset=0
&limit=2
&orderby=createdTime
&order=desc
&searchKey=aa

返回示例如下:

{
    "code": "0",
    "message": "",
    "codeDesc": "Success",
    "totalCount": 2,
    "serviceStatusSet": [{
            "serviceId": "service-XX",
            "serviceName": "test1",
            "serviceDescription": "test1",
            "subDomain": "523e8dc7bbe04613b5b1d726c2a7889d-apigateway.ap-guangzhou.qcloud.com",
            "protocol": "http",
            "createdTime": "2017-08-07T00:00:00Z",
            "modifiedTime": "2017-08-07T00:00:00Z",
            "availableEnvironments": [
                "Pre",
                "release"
            ]
        },
        {
            "serviceId": "service-XXXX",
            "serviceName": "test2",
            "serviceDescription": "test2",
            "subDomain": "523e8dc7bbe04613b5b1d726c2a7889d-apigateway.ap-guangzhou.qcloud.com",
            "protocol": "https",
            "createdTime": "2017-08-07T00:10:00Z",
            "modifiedTime": "2017-08-07T00:10:00Z",
            "availableEnvironments": [
                "Test",
                "Pre"
            ]
        }
    ]
}