帮你快速理解、总结文档立即下载

批量关联视觉理解计划通道

最近更新时间:2026-10-13 02:47:37
我的收藏

1. 接口描述

接口请求域名: iss.tencentcloudapi.com 。

批量关联视觉理解计划通道

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:BatchAssignVLPlanChannels。
Version 是 String 公共参数,本接口取值:2023-05-17。
Region 否 String 公共参数,此参数为可选参数。
VLPlanId 是 String

计划 ID


示例值:VP7219*6f1
Cmd 是 Integer

操作命令:1=关联,2=解绑


示例值:2
ChannelIds.N 否 Array of String

通道 ID 列表,最多 500 个;与 OrganizationIds 至少传一个(Cmd=1 时)


示例值:["**"]
OrganizationIds.N 否 Array of String

组织 ID 列表(仅 Cmd=1 时有效,Cmd=2 时不允许传入);展开该组织下所有通道参与关联,与 ChannelIds 取并集去重


示例值:["*"]

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 成功示例

输入示例

POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: BatchAssignVLPlanChannels
<公共请求参数>

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

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。

错误码 描述
AuthFailure.ContainUnauthorizedChannelId 包含没有权限操作的通道ID
AuthFailure.OrganizationUnauthorized 组织无权访问
FailedOperation.ChannelAlreadyAssigned 包含已关联的通道ID,请勿重复关联
FailedOperation.ChannelNotAssigned 包含未关联的通道ID,无法取消关联
InvalidParameterValue.ContainInvalidChannelId 包含无效的ChannelId
InvalidParameterValue.ContainNonexistentChannelId 包含不存在的通道ID
InvalidParameterValue.EmptyChannelIds ChannelIds不能为空,至少需要传入1个通道ID
InvalidParameterValue.ImageVLPlanIDNotExisted InvalidParameterValue.ImageVLPlanIDNotExisted
InvalidParameterValue.InvalidCmd 无效的命令
InvalidParameterValue.InvalidImageVLPlanID InvalidParameterValue.InvalidImageVLPlanID
InvalidParameterValue.InvalidOrganizationID InvalidParameterValue.InvalidOrganizationID
InvalidParameterValue.OrganizationIDNotExisted 组织ID不存在
InvalidParameterValue.OrganizationIdsNotAllowedForUnAssign Cmd=2(解绑)时不允许传入 OrganizationIds
InvalidParameterValue.TooManyChannelIds ChannelId数量超过上限