CreateStorageBundle - Cloud Storage Gateway - Alibaba Cloud Documentation Center

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 support 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

hcs-sgw:CreateStorageBundle

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The name of the gateway cluster. The name must be 1 to 60 characters in length and can contain uppercase letters, lowercase letters, Chinese characters, digits, periods (.), underscores (_), or hyphens (-). The name must start with an uppercase letter, a lowercase letter, or a Chinese character.	alex-123***
Description	string	No	The description of the gateway cluster. The description can be 0 to 128 characters in length.
BackendBucketRegionId	string	Yes	The region where the gateway cluster is located. You can call the DescribeRegions operation to obtain a valid region ID.	cn-shanghai

Response parameters

Parameter	Type	Description	Example
	object
Message	string	The description of the request result.	successful
RequestId	string	The request ID.	2AD80BDC-E05C-4A77-BBAD-5EDAEDE6D333
StorageBundleId	string	The ID of the gateway cluster.	sb-000ibk4xrlr03qrjr***
Code	string	The status code. A status code of 200 indicates that the request was successful.	200
Success	boolean	Indicates whether the request was successful.	true

Examples

Success response

JSON format

{
  "Message": "successful",
  "RequestId": "2AD80BDC-E05C-4A77-BBAD-5EDAEDE6D333",
  "StorageBundleId": "sb-000ibk4xrlr03qrjr***",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	EmptyStorageBundleName	You must enter a valid name for the gateway cluster.	You must enter a valid name for the gateway cluster.
400	InvalidRegionId	The specified RegionId does not exist. You must specify a valid RegionId.	The specified RegionId does not exist. You must specify a valid RegionId.
400	StorageBundleDescriptionOverLimit	The length of the specified description of the gateway cluster exceeds the maximum limit. The description cannot exceed 128 characters in length.	The length of the specified description of the gateway cluster exceeds the maximum limit. The description cannot exceed 128 characters in length.
400	BadRequest	Invalid request. You must specify valid parameters in the request.	Invalid request. You must specify valid parameters in the request.
400	DuplicateStorageBundleName	The name you specified for the gateway cluster already exists. You must specify a valid name.	The name you specified for the gateway cluster already exists. You must specify a valid name.
400	InvalidStorageBundleName	The specified name for the gateway cluster is invalid. The name must be 1 to 60 characters in length and can contain letters, Chinese, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter or Chinese.	The specified name for the gateway cluster is invalid. The name must be 1 to 60 characters in length and can contain letters, Chinese, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter or Chinese.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.