tencent cloud

Feedback

DescribeLicenseBindList

Last updated: 2024-08-27 11:38:28

1. API Description

Domain name for API request: cwp.tencentcloudapi.com.

This API is used to obtain the list of authorized machines bound to an authorization under the Settings Center-Authorization Management.

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

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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 Params. The value used for this API: DescribeLicenseBindList.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
LicenseId Yes Integer Authorization ID
LicenseType Yes Integer Authorization type
ResourceId Yes String Resource ID
Filters.N No Array of Filters
  • InstanceID, IP,

    and MachineName for fuzzy search
  • Limit No Integer Limit number, 10 by default.
    Offset No Integer Offset. Default value: 0.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of entries
    List Array of LicenseBindDetail List of bound machines
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Example

    Input Example

    POST / HTTP/1.1
    Host: cwp.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeLicenseBindList
    <Common request parameters>
    
    {
        "LicenseId": 1,
        "LicenseType": 0,
        "ResourceId": "xxx"
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "de41ce31-f2c0-49a9-a476-57051a5c7c6c",
            "TotalCount": 1,
            "List": [
                {
                    "MachineName": "CVM",
                    "MachineWanIp": "1.1.1.1",
                    "MachineIp": "1.1.1.1",
                    "Quuid": "xxxx-xxxx-xxx-xxxx",
                    "Uuid": "xxxx-xxxx-xxx-xxxx",
                    "Tags": [
                        "Tag"
                    ],
                    "AgentStatus": "OFFLINE",
                    "IsUnBind": true,
                    "IsSwitchBind": true
                }
            ]
        }
    }
    

    5. Developer Resources

    SDK

    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
    InternalError Internal error
    InvalidParameterValue Invalid parameter value.
    MissingParameter Missing parameter error.
    ResourceNotFound The resource does not exist.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support