Attach & Authorize SDG to AIC Instances - ENS

Attach an SDG to the corresponding AIC.

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

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceIds	array	Yes	The IDs of the instances.
	string	No	The ID of the instance.	["aic-1", "aic-2", "aic-3"]
SDGId	string	Yes	The ID of the SDG.	sdg-xxxx
DiskType	string	No	The disk type of the generated shared disk: standard (standard disk). rbd (RBD disk). Note If the shared disk type is not specified, a standard disk is generated by default. RBD shared disks can be generated only when the parent disk type is RBD.	standard
DiskAccessProtocol	string	No	The access protocol type for the disk: iscsi: The default protocol for standard disks. Both RBD disks and standard disks support this protocol. rbd: The default protocol for RBD disks. Only RBD disks support this mount protocol.	iscsi
LoadOpt	object	No	File loading rate optimization parameters.
BlockRwSplit	boolean	No	Specifies whether to enable block device read/write splitting. The default value is false.	true
BlockRwSplitSize	integer	No	Block device read/write splitting size in GiB. If the value is 0, the default size is used.	20
Cache	boolean	No	Specifies whether to enable cache (requires block device read/write splitting to be enabled). The default value is false.	true
CacheSize	integer	No	Cache size in GiB. If the value is 0, the default size is used.	20

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	C0003E8B-B930-4F59-ADC0-0E209A9012A8
Data	object	The returned data object.
Message	string	The response message. Success is returned for a successful request.	success
Result	object	The execution result of the synchronization request.
FailedCount	integer	The number of failed tasks.	0
FailedItems	array<object>	Details about failed tasks.
	object	Details about the failed task.
ErrMessage	string	The error message.	sdg not found
InstanceId	string	The ID of the instance.	aic-xxxxx-0
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": [
        {
          "ErrMessage": "sdg not found",
          "InstanceId": "aic-xxxxx-0"
        }
      ],
      "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.