文档

ListExportZookeeperData - Zookeeper导出任务列表

更新时间:

列出Zookeeper的历史数据导出任务列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mse:ListExportZookeeperData
  • 全部资源
    *

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

mse-cn-7pp2d1****
PageNumberinteger

页码。

0
PageSizeinteger

分页大小。

10
AcceptLanguagestring

返回信息的语言类型:

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object

BaseResult<List>

Successboolean

请求结果,取值如下:

  • true:请求成功。
  • false:请求失败。
true
Messagestring

返回信息。

请求处理成功
DynamicMessagestring

动态错误信息,用于替换返回参数 ErrMessage 错误信息中的**%s**。

说明 如果 ErrMessage 返回The Value of Input Parameter %s is not valid,且 DynamicMessage 返回 DtsJobId,则代表所传入的请求参数 DtsJobId 不合法。
The specified parameter is invalid.
RequestIdstring

请求 ID。

8BD1E58D-0755-42AC-A599-E6B55112****
ErrorCodestring

错误码。

mse-100-000
HttpStatusCodestring

HTTP 状态码。

200
Dataarray<object>

数据概览。

object

数据结构。

InstanceIdstring

实例 ID。

mse-cn-st21ri2****
ExportTypestring

导出类型,取值:

  • transactionLog 事务日志
  • snapshot 快照文件
snapshot
ContentMapstring

任务详情。

{}
Extendstring

其他扩展信息,JSON 结构,方便后续扩展参数。

{}
Statusstring

任务状态,取值:

  • CREATE 创建中
  • RUNNING 执行中
  • FINISH 已完成
  • FAILED 失败
  • EXPIRE 已过期
FINISH
KubeoneTaskIdsstring

关联的底层 taskId,仅作为失败时的排查使用。

10
Idinteger

任务 ID。

1
CreateTimelong

任务创建时间。

1631001140913
UpdateTimelong

更新时间。

1632979237663

示例

正常返回示例

JSON格式

{
  "Success": true,
  "Message": "请求处理成功",
  "DynamicMessage": "The specified parameter is invalid.",
  "RequestId": "8BD1E58D-0755-42AC-A599-E6B55112****",
  "ErrorCode": "mse-100-000",
  "HttpStatusCode": "200",
  "Data": [
    {
      "InstanceId": "mse-cn-st21ri2****",
      "ExportType": "snapshot",
      "ContentMap": "{}",
      "Extend": "{}",
      "Status": "FINISH",
      "KubeoneTaskIds": "10",
      "Id": 1,
      "CreateTime": 1631001140913,
      "UpdateTime": 1632979237663
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400IllegalRequestInvalid request:%s非法请求: %s
400InvalidParameterParameter error:%s请求参数错误:%s
403NoPermissionYou are not authorized to perform this operation:%s没有权限使用此接口:%s
404NotFoundNot found:%s资源不存在:%s
500InternalErrorConsole error. Try again later:%s控制台错误.稍后重试:%s

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-12-25API 内部配置变更,不影响调用查看变更详情
2023-08-24API 内部配置变更,不影响调用查看变更详情