tencent cloud

APIs

DescribeCSIPLicenseBindSchedule

Download
聚焦模式
字号
最后更新时间: 2026-09-01 10:35:21

1. API Description

Domain name for API request: csip.intl.tencentcloudapi.com.

Query the progress of the async binding task returned by ModifyCSIPLicenseBinds.

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: DescribeCSIPLicenseBindSchedule.
Version Yes String Common Params. The value used for this API: 2022-11-21.
Region No String Common Params. This parameter is not required.
TaskId Yes Integer

Returned task ID of ModifyCSIPLicenseBinds

Limit No Integer

Pagination size. Default value: 10.

Offset No Integer

Pagination offset

Filters.N No Array of LicenseBindFilter

Filter criteria, support filtering by Status (0-Initialization 1-Successful 2-Failed 3-Skipped)

3. Output Parameters

Parameter Name Type Description
TaskId Integer

Task ID.

Status String

Task status: INIT-initialization / RUNNING-in-progress / DONE-completed / FAILED-failed

Schedule Integer

Progress percentage 0-100

Total Integer

Number of all machines (unaffected by filtering)

SuccessNum Integer

Number of successes

FailedNum Integer

failure count

FailedList Array of LicenseBindFailedItem

Failure detail (full, including additional machine information)

List Array of LicenseBindScheduleItem

Detail by machine (affected by Filters and pagination)

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 Query the progress of a binding task

Input Example

POST / HTTP/1.1
Host: csip.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCSIPLicenseBindSchedule
<Common request parameters>

{
    "TaskId": 7505
}

Output Example

{
    "Response": {
        "FailedList": [],
        "FailedNum": 0,
        "List": [
            {
                "ErrMsg": "",
                "FixMessage": "",
                "Quuid": "ins-****5j4c",
                "Status": 1
            }
        ],
        "Schedule": 100,
        "Status": "DONE",
        "SuccessNum": 1,
        "TaskId": 7505,
        "Total": 1,
        "RequestId": "7ffffd25-06bb-42f9-98df-5edfddbd5e7b"
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈