ListExportZookeeperData - Microservices Engine - Alibaba Cloud Documentation Center

Lists historical data export tasks of a Microservices Engine (MSE) Zookeeper instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
mse:ListExportZookeeperData	list	All Resources *	none	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 parameters

Parameter	Type	Description	Example
	object	BaseResult<List>
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Message	string	The message returned.	The request was successfully processed.
DynamicMessage	string	The dynamic part in the error message. This parameter is used to replace the %s variable in the ErrMessage parameter. Note If the return value of the ErrMessage parameter is The Value of Input Parameter %s is not valid and the return value of the DynamicMessage parameter is DtsJobId, the specified 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 if the request failed.	mse-100-000
HttpStatusCode	string	The HTTP status code returned.	200
Data	array<object>	The details of the data.
Data	object	The data structure.
InstanceId	string	The ID of the instance	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	The extension information that is in the JSON format. The extension information facilitates addition of 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 ID of the associated task at the underlying layer. This parameter is used only to troubleshoot failures.	10
Id	integer	The ID of the task.	1
CreateTime	long	The time when the task was created.	1631001140913
UpdateTime	long	The time when the task was updated.	1632979237663

Examples

Sample success responses

JSONformat

{
  "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	duplicatedClusterAliasName	duplicated cluster alias name	The instance name is duplicate. User another name.
400	illegalRequest	illegal request:%s	Invalid request: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	clusterNotFound	cluster not found	The cluster is not found.
500	systemError	system error	An error occurred on the system. Try again later.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-12-25	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-08-24	The internal configuration of the API is changed, but the call is not affected	View Change Details