All Products
Search
Document Center

CloudOps Orchestration Service:ApsaraDB RDS

Last Updated:Oct 24, 2023

This topic describes the ApsaraDB RDS actions specific to various scenarios.

ACS::RDS::CreateDbInstance

Description

Creates an ApsaraDB RDS instance.

Syntax

Action: ACS::RDS::CreateDbInstance
Properties:
 regionId: String
 dBInstanceClass: String
 dBInstanceNetType: String
 dBInstanceStorage: Number
 engine: String
 engineVersion: String
 payType: String
 securityIPList: String
 instanceNetworkType: String

Properties

Property

Description

Type

Required

Default value

Limit

regionId

The region ID.

String

No

{{ ACS::RegionId }}

dBInstanceClass

The type of the ApsaraDB RDS instance.

String

Yes

dBInstanceNetType

The network type of the ApsaraDB RDS instance.

String

Yes

dBInstanceStorage

The storage capacity of the ApsaraDB RDS instance.

Number

Yes

engine

The type of the database.

String

Yes

engineVersion

The version of the database.

String

Yes

payType

The billing method of the ApsaraDB RDS instance.

String

Yes

securityIPList

The IP address whitelist of the ApsaraDB RDS instance.

String

Yes

instanceNetworkType

The network connection type of the ApsaraDB RDS instance.

String

No

VPC

Return value

Return value

Description

Type

dBInstanceId

String

Details

For more information, see the sample code in ACS::RDS::CreateDbInstance.yml.

ACS::RDS::DeleteDbInstance

Description

Deletes an ApsaraDB RDS instance.

Syntax

Action: ACS::RDS::DeleteDbInstance
Properties:
 regionId: String
 dBInstanceId: String

Properties

Property

Description

Type

Required

Default value

Limit

regionId

The region ID.

String

No

{{ ACS::RegionId }}

dBInstanceId

The ID of the ApsaraDB RDS instance.

String

Yes

Return value

None

Details

For more information, see the sample code in ACS::RDS::DeleteDbInstance.yml.

ACS::RDS::GrantAccountPrivilege

Description

Grants permissions to an account of a specific database or all databases in an ApsaraDB RDS instance.

Syntax

Action: ACS::RDS::GrantAccountPrivilege
Properties:
 regionId: String
 dbInstanceId: String
 accountName: String
 dbNames: List
 accountPrivilege: String

Properties

Property

Description

Type

Required

Default value

Limit

regionId

The region ID.

String

No

{{ ACS::RegionId }}

dbInstanceId

The ID of the ApsaraDB RDS instance.

String

Yes

accountName

The account to be authorized.

String

Yes

dbNames

The list of database names.

List

Yes

accountPrivilege

The permissions to be granted to the account.

String

No

ReadOnly

Return value

None

Details

For more information, see the sample code in ACS::RDS::GrantAccountPrivilege.yml.

ACS::RDS::RestartDbInstance

Description

Restarts an ApsaraDB RDS instance.

Syntax

Action: ACS::RDS::RestartDbInstance
Properties:
 regionId: String
 dBInstanceId: String

Properties

Property

Description

Type

Required

Default value

Limit

regionId

The region ID.

String

No

{{ ACS::RegionId }}

dBInstanceId

The ID of the ApsaraDB RDS instance.

String

Yes

Return value

None

Details

For more information, see the sample code in ACS::RDS::RestartDbInstance.yml.