Request Body

Last updated: 2020-06-07 19:06:31

    Note:

    This is a legacy API which has been hidden and will no longer be updated. We recommend using the new LVB API 3.0 which is standardized and faster.

    1. Service Address

    The domain name for the Tencent Cloud LVB service is live.api.qcloud.com.

    2. Communication Protocol

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

    3. Request Methods

    POST and GET requests are both supported, but cannot be used at the same time. 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. For more information, please see the relevant API description.

    4 Character Encoding

    UTF-8 encoding is always used.

    5. API Request Structure

    Name Description Notes
    API entry The WebService entry for calling API https://live.api.qcloud.com/v2/index.php
    Common parameters The parameters common to all the APIs For more information, please see "6. Common Parameters" section in this document.
    Instruction name Name of the instruction to be executed by API, specified with Action.

    For example, Action=CreateLVBChannel

    For more information on complete instructions, please see API Overview
    Instruction parameters Parameters required for each specific instruction For more information, please see the API document of each instruction.

    6. Common Parameters

    Common parameters are used for user identification and API authentication. Unless necessary, these parameters will not be discussed in each API document. A request that comes with these parameters can be initiated successfully.

    Name Type Description Required
    Action String Name of API instruction, for example: DescribeDomains Yes
    Region String Region parameter, which is used to identify the region to which the instance you want to work with belongs. Available values:
    bj: Beijing
    gz: Guangzhou
    sh: Shanghai
    hk: Hong Kong
    ca: North America
    Yes
    Timestamp UInt Current Unix timestamp Yes
    Nonce UInt A random positive integer, which is used in conjunction with Timestamp to prevent replay attacks. Yes
    SecretId String SecretId and SecretKey used for identification and applied for through the Tencent Cloud platform. SecretKey is used to generate a Signature.
    For more information, please see API Authentication page.
    Yes
    Signature String Request signature, which is used to verify the validity of the request.
    For more information, please see API Authentication page.
    Yes

    The following shows a typical API request. "Action=DescribeInstance" indicates a query for the details of the CVM instance.

    https://domain/v2/index.php?Action=DescribeInstances
    &SecretId=xxxxxxx
    &Region=gz
    &Timestamp=1402992826
    &Nonce=345122
    &Signature=mysignature
    &instanceId=101

    instanceId is an instruction parameter, and others are common parameters.

    Was this page helpful?

    Was this page helpful?

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