Help & DocumentationContent Delivery NetworkAPI Documentation Service Query APIsDescribeMapInfo

DescribeMapInfo

Last updated: 2020-01-13 16:24:44

PDF

Contents：

1. API Description

Domain name for API request: cdn.tencentcloudapi.com.

This API (DescribeMapInfo) is used to query the IDs of districts or ISPs.

A maximum of 20 requests can be initiated per second for this API.

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.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeMapInfo
Version Yes String Common parameter. The value used for this API: 2018-06-06
Region No String Common parameter. This parameter is not required for this API.
Name Yes String Query type:
isp: queries ISP codes
district: queries codes of provinces (Mainland China) or countries/regions (outside Mainland China)

3. Output Parameters

Parameter Name Type Description
MapInfoList Array of MapInfo Array of mappings.
ServerRegionRelation Array of RegionMapRelation The relationship between server region ID and sub-region ID
Note: This field may return null, indicating that no valid values can be obtained.
ClientRegionRelation Array of RegionMapRelation The relationship between client region ID and sub-region ID
Note: This field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the ID of a district or an ISP

Input Example

https://cdn.tencentcloudapi.com/?Action=DescribeMapInfo
&Name=isp
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "fcd7aded-1866-467e-a9f6-d8d00b09557e",
    "MapInfoList": [
      {
        "Id": 3947,
        "Name": "China Mobile Tietong"
      }
    ],
    "ServerRegionRelation": null,
    "ClientRegionRelation": null
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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
InternalError.CdnDbError Internal data error. Please submit a ticket for troubleshooting.
InternalError.CdnSystemError System error. Please submit a ticket for troubleshooting.
InvalidParameter.CdnHostInvalidParam Invalid domain name format. Please check and try again.
InvalidParameter.CdnInterfaceError Internal API error. Please submit a ticket for troubleshooting.
InvalidParameter.CdnParamError Parameter error. Please see the sample parameters in the documentation.
InvalidParameter.CdnStatInvalidDate Invalid date. Please see the sample date in the documentation.
InvalidParameter.CdnStatInvalidMetric Invalid statistical type. Please see the sample statistical analysis in the documentation.
InvalidParameter.CdnStatInvalidProjectId Incorrect project ID. Please check and try again.
ResourceNotFound.CdnHostNotExists This domain name does not exist under the account. Please check and try again.
ResourceNotFound.CdnUserNotExists The CDN service has not been activated. Please activate it first before using this API.
UnauthorizedOperation.CdnUserIsSuspended The CDN service has been suspended. Please restart it and try again.
UnauthorizedOperation.CdnUserNoWhitelist You are not in the beta whitelist and thus have no permission to use this function.