Export ZooKeeper Data Programmatically with ExportZookeeperData - Microservices Engine - Alibaba Cloud - Microservices Engine

Initiates a ZooKeeper data export task.

Operation description

Only one task can run at a time.

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:ExportZookeeperData

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The instance ID.	mse-cn-78v1l83****
ExportType	string	No	The export type. Valid values: transactionLog: transaction log snapshot: snapshot file	snapshot
RegionId	string	No	The region where the cluster is deployed. Specify a region supported by Microservices Engine (MSE).	cn-hangzhou
RequestPars	string	No	The extended request parameters in JSON format.	{}
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response elements

Element	Type	Description	Example
	object	BaseResult
Success	boolean	The request result. Valid values: `true`: The request succeeded. `false`: The request failed.	true
Message	string	The returned message. If the request succeeds, a success message is returned. If the request fails, the cause of the failure is returned.	Request processed successfully
DynamicMessage	string	The dynamic error message, which is used to replace the %s placeholder in the ErrMessage response parameter. Note If ErrMessage returns The Value of Input Parameter %s is not valid and DynamicMessage returns DtsJobId, the specified DtsJobId request parameter is invalid.	The specified parameter is invalid.
RequestId	string	The request ID.	25EA0A83-9007-4E87-808C-637BE1A****
ErrorCode	string	The error code.	mse-100-000
HttpStatusCode	string	The HTTP status code.	200
Data	object	The data overview.
InstanceId	string	The instance ID.	mse-cn-st21ri2****
ExportType	string	The export type. Valid values: transactionLog: transaction log snapshot: snapshot file	snapshot
ContentMap	object	The task content.
Extend	string	The extended information.	{}
Status	string	The task status. Valid values: CREATE: creating RUNNING: running FINISH: completed FAILED: failed EXPIRE: expired	FINISH
KubeoneTaskIds	string	The associated underlying task ID. This parameter is used only for troubleshooting when a task fails.	10
Id	integer	The task ID.	1
CreateTime	integer	The time when the task was created. The value is a UNIX timestamp in milliseconds.	1631001140913
UpdateTime	integer	The time when the task was updated. The value is a UNIX timestamp in milliseconds.	1632979237663

Examples

Success response

JSON format

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

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.