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.
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 |
| 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. |
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": [
"*****"
]
}
{
"Response": {
"RequestId": "f0f789da-fa63-4fe0-b86a-317ae835ed8c"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
文档反馈