Data Types

Last updated: 2021-03-19 16:50:40

Account

Sub-account information

Used by actions: DescribeInstanceAccount.

Name Type Description
InstanceId String Instance ID
Note: This field may return null, indicating that no valid values can be obtained.
AccountName String Account name (root for a root account)
Note: This field may return null, indicating that no valid values can be obtained.
Remark String Account description information
Note: This field may return null, indicating that no valid values can be obtained.
Privilege String Read/write policy. r: read-only; w: write-only; rw: read/write
Note: This field may return null, indicating that no valid values can be obtained.
ReadonlyPolicy Array of String Routing policy. master: master node; replication: secondary node
Note: This field may return null, indicating that no valid values can be obtained.
Status Integer Sub-account status. 1: account is being changed; 2: account is valid; -4: account has been deleted
Note: This field may return null, indicating that no valid values can be obtained.

BigKeyInfo

Big key details

Used by actions: DescribeInstanceMonitorBigKey.

Name Type Description
DB Integer Database
Key String Big key
Type String Type
Size Integer Size
Updatetime Integer Data timestamp

BigKeyTypeInfo

Big key type distribution details

Used by actions: DescribeInstanceMonitorBigKeyTypeDist.

Name Type Description
Type String Type
Count Integer Count
Size Integer Size
Updatetime Integer Timestamp

CommandTake

Command duration

Used by actions: DescribeInstanceMonitorTopNCmdTook.

Name Type Description
Cmd String Command
Took Integer Duration

DelayDistribution

Delay distribution details

Used by actions: DescribeInstanceMonitorBigKeySizeDist, DescribeInstanceMonitorTookDist.

Name Type Description
Ladder Integer Delay distribution. The mapping between delay range and Ladder value is as follows:
[0ms,1ms]: 1;
[1ms,5ms]: 5;
[5ms,10ms]: 10;
[10ms,50ms]: 50;
[50ms,200ms]: 200;
[200ms,∞]: -1.
Size Integer The number of commands whose delay falls within the current delay range
Updatetime Integer Modification time

DescribeInstanceDTSInstanceInfo

Details of instances in a DTS task

Used by actions: DescribeInstanceDTSInfo.

Name Type Description
RegionId Integer Region ID
Note: this field may return null, indicating that no valid values can be obtained.
InstanceId String Instance ID
Note: this field may return null, indicating that no valid values can be obtained.
SetId Integer Repository ID
Note: this field may return null, indicating that no valid values can be obtained.
ZoneId Integer Availability zone ID
Note: this field may return null, indicating that no valid values can be obtained.
Type Integer Instance type
Note: this field may return null, indicating that no valid values can be obtained.
InstanceName String Instance name
Note: this field may return null, indicating that no valid values can be obtained.
Vip String Instance access address
Note: this field may return null, indicating that no valid values can be obtained.
Status Integer Status
Note: this field may return null, indicating that no valid values can be obtained.

HotKeyInfo

Hot key details

Used by actions: DescribeInstanceMonitorHotKey.

Name Type Description
Key String Hot key
Type String Type
Count Integer Count

Inbound

Security group inbound rule

Used by actions: DescribeDBSecurityGroups, DescribeProjectSecurityGroups.

Name Type Description
Action String Policy. Valid values: ACCEPT, DROP.
AddressModule String All the addresses that the address group ID represents.
CidrIp String Source IP or IP address range, such as 192.168.0.0/16.
Desc String Description.
IpProtocol String Network protocol, such as UDP and TCP, etc.
PortRange String Port.
ServiceModule String All the protocols and ports that the service group ID represents.
Id String All the addresses that the security group ID represents.

InstanceClusterNode

Instance node type

Used by actions: DescribeInstances.

Name Type Description
Name String Node name
RunId String ID of the runtime node of an instance
Role Integer Cluster role. 0: primary; 1: secondary
Status Integer Node status. 0: readwrite; 1: read; 2: backup
Connected Integer Service status. 0: down; 1: on
CreateTime String Node creation time
DownTime String Node deactivation time
Slots String Distribution of node slots
Keys Integer Distribution of node keys
Qps Integer Node QPS
QpsSlope Float QPS slope of a node
Storage Integer Node storage
StorageSlope Float Storage slope of a node

InstanceClusterShard

Information list of instance shards

Used by actions: DescribeInstanceShards.

Name Type Description
ShardName String Shard node name
ShardId String Shard node ID
Role Integer Role
Keys Integer Number of keys
Slots String Slot information
Storage Integer Storage capacity
StorageSlope Float Capacity slope
Runid String ID of the runtime node of an instance
Connected Integer Service status. 0: down; 1: on

InstanceEnumParam

Descriptions of enumeration parameters of the instance

Used by actions: DescribeInstanceParams.

Name Type</