CreateRCImage - ApsaraDB RDS - Alibaba Cloud Documentation Center

Operation description

Supported database engines

RDS MySQL
RDS SQL Server

References

Usage

Method 1: Create a custom image from a system disk snapshot. To use this method, specify both the SnapshotId and ImageName parameters.
Method 2: Create a custom image from an RDS Custom instance. To use this method, specify both the InstanceId and ImageName parameters.

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

rds:CreateRCImage

none

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID. Call the DescribeRegions operation to query the most recent region list.	cn-beijing
SnapshotId	string	No	The snapshot ID. The custom image is created from this snapshot. Call the DescribeRCSnapshots operation to query available snapshot IDs.	rcds-c9bjdl79vz5dx********
ImageName	string	No	The name of the custom image.	Created_from_rc-vma9w5z699x9********
InstanceId	string	No	The ID of the RDS Custom instance.	rc-vma9w5z699x93204****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	F8D78AED-5050-113C-A46E-7B346*******

Examples

Success response

JSON format

{
  "RequestId": "F8D78AED-5050-113C-A46E-7B346*******"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidInstanceId.NotFound	InstanceId is invalid, not found.	The specified instance ID is invalid. No matching instance was found.
400	InvalidParameter.ImageName	The image name is null.	The image name is not specified.
400	InvalidParameter.DuplicateImageName	The image name is duplicated.	The specified image name already exists.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.	The request failed to be processed due to an RDS API failure.
404	InvalidDBInstanceName.NotFound	The database instance does not exist.	The specified RDS instance does not exist. Verify the instance name.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.