Request Structure

Last updated: 2019-11-29 18:02:21

PDF

1. Service Address

The API supports access from either a nearby region (at kms.tencentcloudapi.com) or a specified region (at kms.ap-guangzhou.tencentcloudapi.com for Guangzhou, for example).

It is recommended to use the domain name for accessing the nearest server. When you call an API, this domain name is automatically resolved to a server in the region nearest to the client where the API is initiated. For example, when you initiate an API request in Guangzhou, this domain name is automatically resolved to a Guangzhou server, with the result same as that of using "kms.ap-guangzhou.tencentcloudapi.com".

Note: For latency-sensitive businesses, it is recommended to specify a domain name with region.

Below lists the currently supported regions:

Access region Domain name
Local access region (recommended, only for non-financial availability zones) kms.tencentcloudapi.com
South China (Guangzhou) kms.ap-guangzhou.tencentcloudapi.com
East China (Shanghai) kms.ap-shanghai.tencentcloudapi.com
North China (Beijing) kms.ap-beijing.tencentcloudapi.com
Southwest China (Chengdu) kms.ap-chengdu.tencentcloudapi.com
Southwest China (Chongqing) kms.ap-chongqing.tencentcloudapi.com
Southeast Asia (Hong Kong, China) kms.ap-hongkong.tencentcloudapi.com
Southeast Asia (Singapore) kms.ap-singapore.tencentcloudapi.com
Asia Pacific (Bangkok) kms.ap-bangkok.tencentcloudapi.com
Asia Pacific (Mumbai) kms.ap-mumbai.tencentcloudapi.com
Asia Pacific (Seoul) kms.ap-seoul.tencentcloudapi.com
Asia Pacific (Tokyo) kms.ap-tokyo.tencentcloudapi.com
Eastern America (Virginia) kms.na-ashburn.tencentcloudapi.com
Western America (Silicon Valley) kms.na-siliconvalley.tencentcloudapi.com
North America (Toronto) kms.na-toronto.tencentcloudapi.com
Europe (Frankfurt) kms.eu-frankfurt.tencentcloudapi.com
Europe (Moscow) kms.eu-moscow.tencentcloudapi.com

Note: As financial availability zones and non-financial availability zones are isolated, when accessing the services in a financial availability zone (with the common parameter Region specifying a financial availability zone), it is necessary to specify a domain name with the financial availability zone, preferably in the same region as specified in Region.

Access region for financial availability zone Domain name for financial availability zone
East China (Shanghai Financial) kms.ap-shanghai-fsi.tencentcloudapi.com
South China (Shenzhen Financial) kms.ap-shenzhen-fsi.tencentcloudapi.com

2. Communications Protocol

All the TencentCloud APIs communicate via HTTPS, providing highly secure communications tunnels.

3. Request Method

Supported HTTP request methods:

  • POST (recommended)
  • GET

The Content-Type types supported by POST request:

  • application/json (recommended). The TC3-HMAC-SHA256 signature method must be used.
  • application/x-www-form-urlencoded. The HmacSHA1 or HmacSHA256 signature method must be used.
  • multipart/form-data (only supported by certain APIs). The TC3-HMAC-SHA256 signature method must be used.

The size of a GET request packet is up to 32 KB. The size of a POST request is up to 1 MB when the HmacSHA1 or HmacSHA256 signature method is used, and up to 10 MB when TC3-HMAC-SHA256 is used.

4. Character Encoding

Only UTF-8 encoding is used.