Domain name for API request: apigateway.tencentcloudapi.com.
This API is used to query the list of custom domain names.
In API Gateway, you can bind custom domain names to a service for service call. This API is used to query the list of custom domain names bound to a service.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: DescribeServiceSubDomains. |
Version | Yes | String | Common Params. The value used for this API: 2018-08-08. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
ServiceId | Yes | String | Unique service ID. |
Limit | No | Integer | Number of results to be returned. Default value: 20. Maximum value: 100. |
Offset | No | Integer | Offset. Default value: 0. |
Parameter Name | Type | Description |
---|---|---|
Result | DomainSets | Custom service domain name query. |
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
https://apigateway.tencentcloudapi.com/?Action=DescribeServiceSubDomains
&ServiceId=service-19c5fnhy
&<Common request parameters>
{
"Response": {
"Result": {
"TotalCount": 1,
"DomainSet": [
{
"Status": 1,
"CertificateId": "xx",
"Protocol": "xx",
"IsDefaultMapping": false,
"DomainName": "xx",
"IsForcedHttps": true,
"NetType": "xx",
"RegistrationStatus": true
}
]
},
"RequestId": "xx"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation.DescribeServiceSubDomainsError | The custom domain name of the service is incorrect. |
FailedOperation.ServiceNotExist | The service does not exist. |
InvalidParameter.FormatError | Incorrect parameter format. |
InvalidParameterValue.InvalidRegion | Incorrect region. |
ResourceNotFound.InvalidService | The corresponding service is invisible. |
Was this page helpful?