Help & DocumentationAPIsAPI GatewayService APIsQuery the list of custom domain names

Query the list of custom domain names

Last updated: 2020-02-21 16:28:53

Interface description

This API (DescribeServiceSubDomains) is used to query custom lists.
The API gateway can bind a custom domain name to a service for service invocation. This API is used to query the list of custom domain names bound to the service.

Input Parameter

The following request parameter list only lists the API request parameters. For other parameters, please see Common Request Parameters .

Parameter name Required Type Description
ServiceId Yes String Service unique ID

Output Parameter

Parameter name Type Description
Code Int Common error code, 0 indicates success, other values indicate failure. For more information, please see the error code page Common error code
CodeDesc String Error code on the business side. Return the specific cause of the business error when a Success, error is returned on success.
TotalCount Int Number of custom domain names under the service
DomainSet List of Array Domain List

Where domainSet is a list of domain names, which is composed of domainStatus. The composition of domainStatus is as follows:

Parameter name Type Description
DomainName String Domain name
Status String Domain name resolution status. True indicates normal resolution, while Flase indicates resolution failed
CertificateId String Certificate ID

Example

https://apigateway.api.qcloud.com/v2/index.php?
&<Common request parameters>
&Action=DescribeSubDomain
&serviceId=service-XXXX

The returned results are as below:

{
    "code": "0",
    "message": "",
    "codeDesc": "Success",
    "totalCount": 2,
    "domainSet": [{
            "domainName": "domain1",
            "status": "True",
            "certificateId": "XXXX"
        },
        {
            "domainName": "domain2",
            "status": "Flase",
            "certificateId": "XXXX"
        }
    ]
}