ListExportZookeeperData - List Zookeeper export tasks - Microservices Engine

Lists historical data export tasks for an MSE Zookeeper instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mse:ListExportZookeeperData

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The ID of the instance.	mse-cn-7pp2d1****
PageNumber	integer	No	The number of the page to return.	0
PageSize	integer	No	The number of entries to return on each page.	10
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response elements

Element	Type	Description	Example
	object	BaseResult<List>
Success	boolean	Whether the request succeeded. Valid values: `true`: The request was successful. `false`: The request failed.	true
Message	string	The returned message.	The request was successfully processed.
DynamicMessage	string	The dynamic part in the error message, used to replace %s in ErrMessage. Note For example, if ErrMessage is The Value of Input Parameter %s is not valid and DynamicMessage is DtsJobId, the DtsJobId parameter is invalid.	The specified parameter is invalid.
RequestId	string	The ID of the request.	8BD1E58D-0755-42AC-A599-E6B55112****
ErrorCode	string	The error code returned on failure.	mse-100-000
HttpStatusCode	string	The HTTP status code returned.	200
Data	array<object>	The response data.
	object	The data structure.
InstanceId	string	The instance ID.	mse-cn-st21ri2****
ExportType	string	The type of the object that is exported. Valid values: transactionLog: transaction logs snapshot: snapshots	snapshot
ContentMap	string	The details of the task.	{}
Extend	string	Extension information in JSON format for adding custom parameters.	{}
Status	string	The status of the task. Valid values: CREATE: The task is being created. RUNNING: The task is being executed. FINISH: The task is completed. FAILED: The task failed. EXPIRE: The task has expired.	FINISH
KubeoneTaskIds	string	The underlying task ID, used only for troubleshooting.	10
Id	integer	The ID of the task.	1
CreateTime	integer	The task creation time.	1631001140913
UpdateTime	integer	The last update time.	1632979237663

Examples

Success response

JSON format

{
  "Success": true,
  "Message": "The request was successfully processed.\n",
  "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
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.