Request Structure

Last updated: 2019-09-09 20:17:28

1. Service Address

The API supports access from either a nearby region (at cbs.tencentcloudapi.com) or a specified region (at cbs.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, the result is the same as that of specifying the region in the domain like "cbs.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
Nearest region (recommended, and is only for non-Finance regions) cbs.tencentcloudapi.com
South China (Guangzhou) cbs.ap-guangzhou.tencentcloudapi.com
East China (Shanghai) cbs.ap-shanghai.tencentcloudapi.com
North China (Beijing) cbs.ap-beijing.tencentcloudapi.com
Southwest China (Chengdu) cbs.ap-chengdu.tencentcloudapi.com
Southwest China (Chongqing) cbs.ap-chongqing.tencentcloudapi.com
Southeast Asia (Hong Kong) cbs.ap-hongkong.tencentcloudapi.com
Southeast Asia (Singapore) cbs.ap-singapore.tencentcloudapi.com
Asia Pacific (Bangkok) cbs.ap-bangkok.tencentcloudapi.com
Asia Pacific (Mumbai) cbs.ap-mumbai.tencentcloudapi.com
Asia Pacific (Seoul) cbs.ap-seoul.tencentcloudapi.com
Asia Pacific (Tokyo) cbs.ap-tokyo.tencentcloudapi.com
Eastern U.S. (Virginia) cbs.na-ashburn.tencentcloudapi.com
Western U.S. (Silicon Valley) cbs.na-siliconvalley.tencentcloudapi.com
North America (Toronto) cbs.na-toronto.tencentcloudapi.com
Europe (Frankfurt) cbs.eu-frankfurt.tencentcloudapi.com
Europe (Moscow) cbs.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.

Finance Region Domain Name
East China (Shanghai Finance) cbs.ap-shanghai-fsi.tencentcloudapi.com
South China (Shenzhen Finance) cbs.ap-shenzhen-fsi.tencentcloudapi.com

2. Communication 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 is required.
  • 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.