Last updated: 2020-03-02 19:48:40

    1. API Description

    Domain name for API request:

    This API is used to query the list of placement groups of a user. You can specify the placement group ID or name.

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

    Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example:

    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: DescribeDeployGroupList.
    Version Yes String Common parameter. The value used for this API: 2017-03-20.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    DeployGroupId No String ID of a placement group.
    DeployGroupName No String Name of a placement group.
    Limit No Integer Number of returned results. Default value: 20. Maximum value: 100.
    Offset No Integer Offset. Default value: 0.

    3. Output Parameters

    Parameter Name Type Description
    Total Integer Number of eligible entries.
    Items Array of DeployGroupInfo List of returned results.
    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 Query the list of deploy groups

    Input Example
    &<common request parameters>

    Output Example

      "Response": {
        "Total": 100,
        "Items": [
            "DeployGroupId": "test",
            "DeployGroupName": "test",
            "Description": "test",
            "Quota": 50,
            "CreateTime": "2019-09-10 13:14:15"
        "RequestId": "b4a719b5-ffb34ab6-816c43c1-8c6a23eb"

    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.


    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
    9003 Incorrect parameter.
    InternalError.CdbError System error.
    InvalidParameter Parameter error.
    InvalidParameter.DeployGroupNotEmpty There are resources in the placement group.
    InvalidParameter.OverDeployGroupQuota The quota of placement group resources has been exceeded.
    InvalidParameter.ResourceExists The resource already exists.
    InvalidParameter.ResourceNotFound The resource is not found.
    OperationDenied.ActionNotSupport Unsupported operation.

    Was this page helpful?

    Was this page helpful?

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