DescribeServiceSubDomainMappings

Last updated: 2022-01-20 14:23:46

1. API Description

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.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

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.

3. Output Parameters

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.

4. Example

Example1 Querying the path mapping of a custom domain name

Input Example

https://apigateway.tencentcloudapi.com/?Action=DescribeServiceSubDomainMappings
&ServiceId=service-19c5fnhy
&SubDomain=xxxxxx
&<Common request parameters>

Output Example

{
  "Response": {
    "Result": {
      "IsDefaultMapping": false,
      "PathMappingSet": [
        {
          "Path": "/",
          "Environment": "release"
        }
      ]
    },
    "RequestId": "01c56ec2-6a40-46bc-bdf6-8b273d4bec93"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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.