tencent cloud

APIs

BatchAssignVLPlanChannels

下载
聚焦模式
字号
最后更新时间: 2026-10-26 11:47:54

1. API Description

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

Batch associate visual understanding plan channels

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: BatchAssignVLPlanChannels.
Version Yes String Common Params. The value used for this API: 2023-05-17.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
VLPlanId Yes String

Plan ID

Cmd Yes Integer

Operation command: 1=associate, 2=unbind

ChannelIds.N No Array of String

Channel ID list, up to 500; pass at least one of this parameter and OrganizationIds (when Cmd=1)

OrganizationIds.N No Array of String

List of organization IDs (valid only when Cmd=1; does not allow input when Cmd=2); unfold all channels under the organization to participate in association, and take the union with ChannelIds and remove duplicates

3. Output Parameters

Parameter Name Type Description
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 Successful Example

Input Example

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

{
    "VLPlanId": "VP7219*************************6f1",
    "Cmd": 2,
    "ChannelIds": [
        "**********"
    ],
    "OrganizationIds": [
        "*****"
    ]
}

Output Example

{
    "Response": {
        "RequestId": "f0f789da-fa63-4fe0-b86a-317ae835ed8c"
    }
}

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
AuthFailure.ContainUnauthorizedChannelId Contains a channel ID that you do not have permission to operate.
AuthFailure.OrganizationUnauthorized No access permission for the organization
FailedOperation.ChannelAlreadyAssigned Contains an associated channel ID. Do not associate it again.
FailedOperation.ChannelNotAssigned Contains unassociated channel IDs. Unable to disassociate.
InvalidParameterValue.ContainInvalidChannelId Contains an invalid ChannelId.
InvalidParameterValue.ContainNonexistentChannelId Contains a non-existing channel ID
InvalidParameterValue.EmptyChannelIds ChannelIds cannot be empty. At least 1 channel ID is required.
InvalidParameterValue.ImageVLPlanIDNotExisted InvalidParameterValue.ImageVLPlanIDNotExisted
InvalidParameterValue.InvalidCmd Invalid command
InvalidParameterValue.InvalidImageVLPlanID InvalidParameterValue.InvalidImageVLPlanID
InvalidParameterValue.OrganizationIDNotExisted Organization ID does not exist.
InvalidParameterValue.OrganizationIdsNotAllowedForUnAssign OrganizationIds does not allow input when Cmd=2 (unbind).
InvalidParameterValue.TooManyChannelIds Number of ChannelIds exceeds the limit.

帮助和支持

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

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

文档反馈