Domain name for API request: apigateway.tencentcloudapi.com.
This API is used to query the path mappings of a custom domain name.
In API Gateway, you can bind a custom domain name to a service and map its paths. You can customize different path mappings to up to 3 environments under the service. This API is used to query the list of path mappings of a custom domain name bound to a service.
A maximum of 20 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: apigateway.ap-shanghai-fsi.tencentcloudapi.com
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 parameter. The value used for this API: DescribeServiceSubDomainMappings. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-08-08. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| ServiceId | Yes | String | Unique service ID. |
| SubDomain | Yes | String | Custom domain name bound to service. |
| Parameter Name | Type | Description |
|---|---|---|
| Result | ServiceSubDomainMappings | Custom path mapping list. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://apigateway.tencentcloudapi.com/?Action=DescribeServiceSubDomainMappings
&ServiceId=service-19c5fnhy
&SubDomain=xxxxxx
&<Common request parameters>{
"Response": {
"Result": {
"IsDefaultMapping": false,
"PathMappingSet": [
{
"Path": "/",
"Environment": "release"
}
]
},
"RequestId": "01c56ec2-6a40-46bc-bdf6-8b273d4bec93"
}
}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.ServiceError | Service error. |
| FailedOperation.ServiceNotExist | The service does not exist. |
| InvalidParameter.FormatError | Incorrect parameter format. |
Was this page helpful?