ExportZookeeperData - zookeeper发起导出数据任务 - 微服务引擎MSE

发起导出zookeeper数据任务。

接口说明

同时只有一个任务在运行中。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
mse:ExportZookeeperData	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	mse-cn-78v1l83****
ExportType	string	是	导出类型，取值： transactionLog 事务日志 snapshot 快照文件	snapshot
RegionId	string	否	集群所在地域，MSE 支持的地域。	cn-hangzhou
RequestPars	string	否	扩展请求参数，JSON 格式。	{}
AcceptLanguage	string	否	返回信息的语言类型： zh：中文 en：英文	zh

返回参数

名称	类型	描述	示例值
	object	BaseResult
Success	boolean	请求结果，取值如下： `true`：请求成功。 `false`：请求失败。	true
Message	string	返回信息。当请求成功时，返回成功信息。当请求失败时，返回失败原因。	请求处理成功
DynamicMessage	string	动态错误信息，用于替换返回参数 ErrMessage 错误信息中的%s。说明如果 ErrMessage 返回The Value of Input Parameter %s is not valid，且 DynamicMessage 返回 DtsJobId，则代表所传入的请求参数 DtsJobId 不合法。	The specified parameter is invalid.
RequestId	string	请求 ID。	25EA0A83-9007-4E87-808C-637BE1A****
ErrorCode	string	错误码。	mse-100-000
HttpStatusCode	string	HTTP 状态码。	200
Data	object	数据概览。
InstanceId	string	实例 ID。	mse-cn-st21ri2****
ExportType	string	导出类型，取值： transactionLog 事务日志 snapshot 快照文件	snapshot
ContentMap	object	任务内容。
Extend	string	扩展信息。	{}
Status	string	任务状态，取值： CREATE 创建中 RUNNING 执行中 FINISH 已完成 FAILED 失败 EXPIRE 已过期	FINISH
KubeoneTaskIds	string	关联的底层 taskId，仅作为失败时的排查使用。	10
Id	integer	任务 ID。	1
CreateTime	long	创建时间。	1631001140913
UpdateTime	long	最后更新时间。	1632979237663

示例

正常返回示例

JSON格式

{
  "Success": true,
  "Message": "请求处理成功",
  "DynamicMessage": "The specified parameter is invalid.",
  "RequestId": "25EA0A83-9007-4E87-808C-637BE1A****",
  "ErrorCode": "mse-100-000",
  "HttpStatusCode": "200",
  "Data": {
    "InstanceId": "mse-cn-st21ri2****",
    "ExportType": "snapshot",
    "ContentMap": {
      "test": "test",
      "test2": 1
    },
    "Extend": "{}",
    "Status": "FINISH",
    "KubeoneTaskIds": "10",
    "Id": 1,
    "CreateTime": 1631001140913,
    "UpdateTime": 1632979237663
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	IllegalRequest	Invalid request:%s	非法请求： %s
400	InvalidParameter	Parameter error:%s	请求参数错误：%s
403	NoPermission	You are not authorized to perform this operation:%s	没有权限使用此接口：%s
404	NotFound	Not found:%s	资源不存在：%s
500	InternalError	Console error. Try again later:%s	控制台错误.稍后重试：%s

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

变更历史

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