Help & DocumentationAPI GatewayAPI DocumentationService APIsQuery the path mapping of a custom domain name

Query the path mapping of a custom domain name

Last updated: 2020-02-21 16:29:50

PDF

Interface description

This API (DescribeServiceSubDomainMappings) is used to query the path mapping of custom domain names.
API gateway can bind custom domain names to services, and map the paths of custom domain names. You can customize different paths to map to three environments in the service. This API is used to query the path mapping list of custom domain names of bound services.

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
SubDomain Yes String Custom domain name bound to the service

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.
IsDefaultMapping String Whether to use default path mapping, which means default path mapping is used for TRUE. If FALSE, custom path mapping is used, and pathMappingSet is not empty.
PathMappingSet List of Array Custom path mapping list

Where pathMappingSet is a custom path mapping list, which is composed as follows:

Parameter name Type Description
Path String Custom path mapping path
Environment String Environment name of the custom path map

Example

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

The returned results are as below:

{
    "code": "0",
    "message": "",
    "codeDesc": "Success",
    "totalCount": 2,
    "isDefaultMapping": "FALSE",
    "pathMapping": [{
            "path": "/path1",
            "environment": "release"
        },
        {
            "path": "/path2",
            "environment": "test"
        }
    ]
}