Deploy Shared Data Groups to ENS Nodes via PreloadRegionSDG API - ENS

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

ens:PreloadRegionSDG

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SDGId	string	Yes	The ID of the SDG for which data is preloaded.	sdg-xxxx
DestinationRegionIds	array	Yes	The IDs of the destination nodes.
	string	No	The ID of the destination node.	cn-foshan-4
Namespaces	array	No	An array that consists of queried namespaces.
	string	No	The namespace.	'default'
RedundantNum	integer	Yes	The number of redundant replicas to support rapid deployment.	2
DiskType	string	No	The disk type of the shared disk to be created: standard (standard disk). rbd (rbd disk). Note If no shared disk type is specified, a standard disk is created by default.	rbd

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	C0003E8B-B930-4F59-ADC0-0E209A9012A8
Data	object	The returned data object.
Message	string	The message returned.	success
Result	object	The execution result of the synchronization request.
FailedCount	integer	The number of failed tasks.	0
FailedItems	array<object>	Details about the failed tasks.
	object	Details about the failed task.
ErrorMessage	string	The error message that is returned.	region not found
DestinationRegionId	string	The ID of the destination node.	cn-hangzhou-xxx
SuccessCount	integer	The number of successful tasks.	1
Success	boolean	Indicates whether all tasks are successful. Valid values: true: All tasks are successful. false: Failed tasks exist.	true

Examples

Success response

JSON format

{
  "RequestId": "C0003E8B-B930-4F59-ADC0-0E209A9012A8",
  "Data": {
    "Message": "success",
    "Result": {
      "FailedCount": 0,
      "FailedItems": [
        {
          "ErrorMessage": "region not found",
          "DestinationRegionId": "cn-hangzhou-xxx"
        }
      ],
      "SuccessCount": 1
    },
    "Success": true
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Interface.Call.Error	The interface call error
400	Interface.Call.Failed	%s.	Request failed
400	Parameter.Invalid	The parameter is invalid. Please check your parameters and try it again.	The parameter is invalid.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.