Help & DocumentationAPIsAPI GatewayService APIsQuery Service List

Query Service List

Last updated: 2019-07-24 16:23:21

Contents：

API Description

This API (DescribeServicesStatus) is used to query the list of a service/services and return the domain name, time and other information related to the service(s).

Input Parameters

The following request parameter list only provides API request parameters. Other parameters can be found in Common Request Parameters.

Parameter Name Required Type Description
serviceIds.n No Array of Strings Queries by the unique ID of a service/services.
offset No Int Offset. Default is 0. offset can be used to choose to return information from which service when there is a large number of services.
limit No Int Number of returned results. Default is 20. Maximum is 100.
orderby No String Sorting field.
order No String Sorting mode. Default is desc.
searchName No String Conducts fuzzy search based on the service name.
searchId No String Conducts exact search based on the unique ID of the service.

Output Parameters

Parameter Name Type Description
code Int Common error code. 0: Successful; other values: Failed. For more information, see Common Error Codes on the Error Codes page.
codeDesc String Error code at business side. For a successful operation, "Success" is returned. In case of an error, a message describing the reason for the error is returned.
message String Module error message description depending on API.
totalCount Int Number of service statuses matching the filter condition.
serviceStatusSet List of Array List of service statuses.

"serviceStatusSet" is an array of "serviceStatus", which is composed as follows:

Parameter Name Type Description
serviceId String The unique ID of the service.
serviceName String User-defined service name.
serviceDescription String User-defined service description.
subDomain String The domain name that the system assigns to the service automatically.
protocol String Frontend request type of the service, such as HTTP and HTTPS.
createdTime Timestamp Creation time. It is in the format of YYYY-MM-DDThh:mm:ssZ according to the ISO8601 standard. UTC time is used.
modifiedTime Timestamp Last modification time. It is in the format of YYYY-MM-DDThh:mm:ssZ according to the ISO8601 standard. UTC time is used.
availableEnvironments List Of String The list of published environments, such as Test, Pre, release.

Example

https://apigateway.api.qcloud.com/v2/index.php?
&<Common request parameters>
&Action=DescribeServicesStatus
&serviceIds.0=service-XX
&serviceIds.1=service-XXXX
&offset=0
&limit=2
&orderby=createdTime
&order=desc
&searchKey=aa

The returned results are as below:

{
    "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"
            ],
        }
    ]
}