有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

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

单条和批量复制作业

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CopyJobs。
Version String 公共参数,本接口取值:2019-04-22。
Region String 公共参数,详见产品支持的 地域列表
JobItems.N Array of CopyJobItem 复制明细列表
WorkSpaceId String 工作空间 SerialId
TargetWorkspaceId String 目标工作空间 SerialId

3. 输出参数

参数名称 类型 描述
SuccessCount Integer 成功条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
FailCount Integer 失败条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
CopyJobsResults Array of CopyJobResult 结果列表
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 复制作业

输入示例

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

{
    "WorkSpaceId": "sapce-xxx",
    "JobItems": [
        {
            "SourceId": "cql-pqx9zh30",
            "SourceName": "datagen_datagen_datagen_datagen_datagen_datagen_50",
            "JobType": 1,
            "TargetClusterId": "cluster-4y035tb0",
            "TargetName": "datagen_datagen_datagen_datagen_datagen_datagen_50_2022-01-12_10_14_52",
            "TargetFolderId": "root"
        }
    ]
}

输出示例

{
    "Response": {
        "SuccessCount": 0,
        "FailCount": 0,
        "CopyJobsResults": [
            {
                "JobId": "abc",
                "JobName": "abc",
                "TargetJobName": "abc",
                "TargetJobId": "abc",
                "Message": "abc",
                "Result": 0,
                "ClusterName": "abc",
                "ClusterId": "abc",
                "JobType": 0
            }
        ],
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.UnauthorizedOperation 未授权操作。
InternalError 内部错误。
InternalError.CLS CLS接口错误。
InternalError.DB 数据库异常。
InternalError.StsNewClient 内部错误。
InternalError.SystemError 系统错误。
InvalidParameterValue 参数取值错误。
ResourceNotFound.Job 作业不存在。
UnsupportedOperation 操作不支持。
UnsupportedOperation.NoPermissionAccess 权限拦截,没有进入权限。