检查快照是否可用

最近更新时间:2024-04-03 11:24:23

我的收藏

1. 接口描述

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

检查快照是否可用

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CheckSavepoint。
Version String 公共参数,本接口取值:2019-04-22。
Region String 公共参数,详见产品支持的 地域列表
JobId String 作业 id
示例值:cql-52xkpymp
SerialId String 快照资源 id
示例值:svp-52xkpymp
RecordType Integer 快照类型 1: savepoint;2: checkpoint;3: cancelWithSavepoint
示例值:1
SavepointPath String 快照路径,目前只支持 cos 路径
示例值:cosn://xxx/xxx
WorkSpaceId String 工作空间 id
示例值:space-1327

3. 输出参数

参数名称 类型 描述
SerialId String 资源 id
示例值:svp-6w8eab6f
SavepointStatus Integer 1=可用,2=不可用
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 成功

输入示例

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

{
    "SerialId": "cql-52xkpymp",
    "WorkSpaceId": "default-12345ap-beijing",
    "SavepointPath": "cosn://52xkpymp-12345/12345/10000/cql-12345/2/flink-savepoints/savepoint-000000-12334",
    "RecordType": "1",
    "JobId": "cql-52xkpymp"
}

输出示例

{
    "Response": {
        "RequestId": "8e9e8172-17e2-4fc5-b363-1d480a4795ae",
        "SavepointStatus": 2,
        "SerialId": "cql-52xkpymp"
    }
}

示例2 检查快照可用性

输入示例

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

{
    "JobId": "cql-52xkpymp",
    "SerialId": "svp-52xkpymp",
    "RecordType": 1,
    "SavepointPath": "cosn://xxxx/xxxx/xxxx/chk-1",
    "WorkSpaceId": "space-12345"
}

输出示例

{
    "Response": {
        "RequestId": "d7b76d5e-ad7d-4abd-b3b2-43b96dd08d16",
        "SerialId": "svp-52xkpymp",
        "SavepointStatus": 1
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
ResourceNotFound.Job 作业不存在。
UnsupportedOperation.NoPermissionAccess 权限拦截,没有进入权限。