Object Instructions
Last Updated:2021-03-09
Instance object details
Parameter Name | Type | Description |
---|---|---|
instanceId | String | Instance ID |
instanceName | String | Instance Name of database |
engine | String | Database engine, see Engine Type |
engineVersion | String | Database engine version, see Database Version for value. |
Category | String | Series Basic: Standalone Basic, Standard: Dual-computer High-availability Version |
instanceStatus | String | Instance status, see Instance Status List. |
cpuCount | Int | CPU cores |
memoryCapacity | Int | Instance memory (Unit: GB) |
volumeCapacity | Int | Storage space, Unit: GB |
nodeAmount | Int | Number of nodes (proxy instance) |
usedStorage | Int | Used storage space, Unit: GB |
publicAccessStatus | String | Extranet access feature status, see Public Network Status List. |
instanceCreateTime | Datetime | Instance creation time, see Time and Date for regulations |
instanceExpireTime | Datetime | Instance expiration time, see Time and Date for regulations |
instanceType | String | Instance type, see Instance Type. |
sourceInstanceId | String | Master instance id is null if it is the master instance |
zoneNames | List String | AZ of the instance |
paymentTiming | String | Payment mode, see Payment Mode. |
InstanceDescribe Object details
Parameter Name | Type | Description |
---|---|---|
instanceId | String | Instance ID |
instanceName | String | Instance Name of database |
engine | String | Database engine, see Engine Type. |
engineVersion | String | Database engine version, see Database Version for value. |
Category | String | Current series Basic: Standalone Basic, Standard: Dual-computer High-availability Version |
instanceStatus | String | Instance status, see Instance Status List. |
cpuCount | Int | CPU cores |
memoryCapacity | Int | Instance memory (Unit: GB) |
volumeCapacity | Int | Storage space, Unit: GB |
nodeAmount | Int | Number of nodes (proxy instance) |
usedStorage | Int | Used storage space, Unit: GB |
instanceCreateTime | Datetime | Instance creation time, see Time and Date for regulations |
instanceExpireTime | Datetime | Instance expiration time, see Time and Date for regulations |
endpoint | Endpoint | Database connection information, Endpoint Object |
publicAccessStatus | String | Extranet access feature status, see Public Network Status List. |
syncMode | String | Data synchronization mode status, see Synchronization Mode. |
backupPolicy | BackupPolicy | BackupPolicy BackupPolicy Object |
region | String | Zone of current instance |
instanceType | String | Instance type, see Instance Type. |
sourceInstanceId | String | Master instance id is null if it is the master instance |
zoneName | String | Logic AZ of the instance |
vpcId | String | ID for VPC of instances |
subnets | List Subnet | Subnet of the Instance Subnet Object |
topology | Topology | The Topology information of the database cluster to which the instance belongs Topology Object |
paymentTiming | String | Payment mode, see Payment Mode. |
Subnet Object details
Parameter Name | Parameter types | Parameter Description |
---|---|---|
name | String | Subnet Name |
subnetId | String | Subnet ID |
zoneName | String | Availability zone of subnet |
cidr | String | Subnet cidr |
vpcId | String | ID of current vpc |
Endpoint Object details
Parameter Name | Parameter types | Parameter Description |
---|---|---|
address | String | Address for database connections |
port | Int | The port of database |
vnetIp | String | The IP of the database connection (It can change due to master-slave switching) |
inetIp | String | IP for connecting database from public network (It cannot change due to the master-slave switching) |
BackupPolicy Object details
Parameter Name | Parameter types | Parameter description |
---|---|---|
backupDays | String | Backup time separated by English comma, Sunday is defined as the first day, value 0 for example: "0,1,2,3,5,6” |
backupTime | String | The start time of backup adopts UTC time example: "17:00:00Z” |
persistent | Boolean | Whether or not the backup data persistence is enabled |
expireInDays | Int | Persistence days, if not enabled, the data shows 0. |
freeSpaceInGB | Int | The unit of free space storage capacity is GB. |
Topology Object details
Parameter Name | Parameter Types | Parameter Description |
---|---|---|
rdsproxy | List String | List of proxy instance IDs in cluster |
master | List String | List of proxy instance IDs in cluster |
readReplica | List String | List of read-only replica instance IDs in cluster |
Database Object Details
Parameter Name | Parameter Types | Parameter Description |
---|---|---|
dbName | String | Database name |
characterSetName | String | Character set See [MySQL Character Set](RDS/API Reference/Appendix.md#MySQL Character Set), [SQL Server Character Set](RDS/API Reference/Appendix.md#SQLServer Character Set) |
dbStatus | String | Database status, refer to [Database Status List.](RDS/API Reference/Appendix.md#Database Status) |
remark | String | Database remarks information |
accountPrivileges | List AccountPrivilege | Related account list and privilege |
AccountPrivilege Object Details
Parameter Name | Parameter Types | Parameter Description |
---|---|---|
accountName | String | Database name |
authType | String | Type of Authorization ReadOnly: ReadWrite: Detail reference |
Account Object Details
Parameter Name | Parameter Types | Parameter Description |
---|---|---|
accountName | String | Account name |
remark | String | Account remarks information |
status | String | Account status information. See Account Status. |
type | String | Type of Account Belonging OnlyMaster: account used in master instance, RdsProxy: account used in middleware See Account Belonging Type Sheet |
accountType | String | Type of Account Privilege Super: high-privilege account, Common: common account. See Account Privilege Type Sheet. |
databasePrivileges | List DatabasePrivilege | The array composed of DatabasePrivilege |
desc | string | Account description |
DatabasePrivilege Object details
Parameter Name | Parameter types | Parameter Description |
---|---|---|
dbName | String | Database name |
authType | String | Type of Authorization ReadOnly: ReadWrite: Detail reference |
Backup Object
Parameter Name | Parameter Types | Parameter Description |
---|---|---|
backupId | String | Backup ID |
backupSize | int | Total backups size, unit: MB |
backupType | String | Manual/automated, see Backup Type |
backupStatus | String | Backup status, see Backup Status |
backupStartTime | String | Backups start time |
backupEndTime | String | Backups end time |
Backup Object details
Parameter Name | Parameter Types | Parameter Description |
---|---|---|
backupId | String | Backup ID |
backupSize | int | Total backups size, unit: MB |
backupType | String | Manual/Automatic, see Backup Type. |
backupStatus | String | Backup status, see Backup Status |
backupStartTime | String | Backups start time |
backupEndTime | String | Backups end time |
downloadExpires | String | Effective time for downloading link. |
Log Object Details
Parameter Name | Parameter Types | Parameter Description |
---|---|---|
LogType | String | Log Type,see Log Type |
logid | String | Log ID |
LogSizeBytes | int | Log file size |
LogStatus | String | Log Type,see Log Status |
LogStartTime | String | Log start time |
logEndTime | String | Log End time |
downloadExpires | String | Effective time for downloading link. |
Parameter Object details
Parameter Name | Parameter Types | Parameter Description |
---|---|---|
name | String | Parameter Name |
defaultValue | String | Parameter default value |
Value | String | Current parameter value |
pendingValue | String | Effective value after restarting |
type | String | Type of parameter data. |
dynamic | bool | Effective immediately after modification? |
Modifiable | bool | Modification allowed? |
allowedValues | String | Allowed value, the default is a string segmented by comma, indicating all allowed values Integer range is represented with “from-to”. |
desc | String | Parameter description |
Modify Parameter Object details
Parameter Name | Parameter Types | Parameter Description |
---|---|---|
name | String | Parameter Name |
Value | String | Value to be modified |