Request Structure Overview

Last updated: 2020-06-05 20:16:48

    The process of calling a Tencent Cloud API is achieved by sending a request to the server IP address of the API and adding relevant request parameters in the request as described in the API description. A request for calling a Tencent Cloud API is made up of the following elements:

    Service Address

    The service access address of a Tencent Cloud API depends on the module. For more information, please see the description of each API.

    Communication Protocol

    All Tencent Cloud APIs communicate over HTTPS to provide high-security channels.

    Request Method

    Tencent Cloud APIs support both POST and GET requests.
    1. POST and GET requests cannot be used together. If the GET method is used, the parameters are obtained from Querystring. If the POST method is used, the parameters are obtained from Request Body, and the parameters in the Querystring are ignored. The request parameters are organized in the same way in both types of requests. Generally, GET method is used. If the parameter strings are too long, POST method is used.
    2. If GET method is used, all request parameters need to be URL encoded. This is not required if POST method is used.

    Request Parameters

    Two types of parameters are required for each Tencent Cloud API request: common request parameters and API request parameters. Common request parameters are required for every API, while API request parameters are specific to each API.

    Character Encoding

    All requests for Tencent Cloud APIs and their returned results are encoded using UTF-8 character set.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback