Database account information
Used by actions: DescribeAccounts.
Name | Type | Description |
---|---|---|
AccountName | String | Database account name |
Description | String | Database account description |
CreateTime | Timestamp | Creation time |
UpdateTime | Timestamp | Update time |
Host | String | Host |
Database address
Used by actions: DescribeClusterDetail.
Name | Type | Description |
---|---|---|
IP | String | IP |
Port | Integer | Port |
Backup file information
Used by actions: DescribeBackupList.
Name | Type | Description |
---|---|---|
SnapshotId | Integer | Snapshot file ID used for rollback |
FileName | String | Snapshot file name |
FileSize | Integer | Snapshot file size |
StartTime | String | Snapshot backup start time |
FinishTime | String | Snapshot backup end time |
BackupType | String | Backup type. snapshot: snapshot backup; timepoint: time point backup |
BackupMethod | String | Back mode. auto: auto backup; manual: manual backup |
BackupStatus | String | Backup file status. success: backup succeeded; fail: backup failed; creating: creating backup file; deleting: deleting backup file |
SnapshotTime | String | Backup file time |
Billable resource information
Used by actions: DescribeResourcesByDealName.
Name | Type | Description |
---|---|---|
ClusterId | String | Cluster ID |
InstanceIds | Array of String | Instance ID list |
Cluster instance information
Used by actions: DescribeClusterDetail.
Name | Type | Description |
---|---|---|
InstanceId | String | Instance ID |
InstanceName | String | Instance name |
InstanceType | String | Engine type |
InstanceStatus | String | Instance status |
InstanceStatusDesc | String | Instance status description |
InstanceCpu | Integer | Number of CPU cores |
InstanceMemory | Integer | Memory |
InstanceStorage | Integer | Disk |
Cluster information
Used by actions: DescribeClusters.
Name | Type | Required | Description |
---|---|---|---|
Status | String | Yes | Cluster status. Valid values are as follows: creating running isolating isolated activating (removing isolation) offlining (deactivating) offlined (deactivated) deleting deleted |
UpdateTime | String | Yes | Update time |
Zone | String | Yes | AZ |
ClusterName | String | Yes | Cluster name |
Region | String | Yes | Region |
DbVersion | String | Yes | Database version |
ClusterId | String | Yes | Cluster ID |
InstanceNum | Integer | Yes | Number of instances |
Uin | String | Yes | User uin |
DbType | String | Yes | Engine type |
AppId | Integer | Yes | User appid |
StatusDesc | String | Yes | Cluster status description |
CreateTime | String | Yes | Cluster creation time |
PayMode | Integer | Yes | Billing mode. 0: pay-as-you-go; 1: monthly subscription |
PeriodEndTime | String | Yes | End time |
Vip | String | Yes | Cluster read-write VIP |
Vport | Integer | Yes | Cluster read-write vport |
ProjectID | Integer | Yes | Project ID |
VpcId | String | No | VPC ID |
SubnetId | String | No | Subnet ID |
CynosVersion | String | No | TDSQL-C kernel version |
StorageLimit | Integer | No | Storage capacity |
RenewFlag | Integer | No | Renewal flag |
ProcessingTask | String | No | Task in progress |
Tasks | Array of ObjectTask | No | Array of tasks in cluster |
ResourceTags | Array of Tag | No | Array of tags bound to cluster |
DbMode | String | No | Database type (NORMAL or SERVERLESS ) |
ServerlessStatus | String | No | Serverless cluster status when the database type is SERVERLESS . Valid values:resume pause |
Storage | Integer | No | Prepaid cluster storage |
StorageId | String | No | Cluster storage ID used in prepaid storage modification |
StoragePayMode | Integer | No | Billing mode of cluster storage. Valid values: 0 (postpaid), 1 (prepaid) |
MinStorageSize | Integer | No | The minimum storage corresponding to the compute specifications of the cluster |
MaxStorageSize | Integer | No | The maximum storage corresponding to the compute specifications of the cluster |
NetAddrs | Array of NetAddr | No | Network information of the cluster |
Cluster details
Used by actions: DescribeClusterDetail.
Name | Type | Description |
---|---|---|
ClusterId | String | Cluster ID |
ClusterName | String | Cluster name |
Region | String | Region |
Status | String | Status |
StatusDesc | String | Status description |
VpcName | String | VPC name |
VpcId | String | Unique VPC ID |
SubnetName | String | Subnet name |
SubnetId | String | Subnet ID |
Charset | String | Character set |
CreateTime | String | Creation time |
DbType | String | Database type |
DbVersion | String | Database version |
UsedStorage | Integer | Used capacity |
RoAddr | Array of Addr | vport for read/write separation |
InstanceSet | Array of ClusterInstanceDetail | Instance information |
PayMode | Integer | Billing mode |
PeriodEndTime | String | Expiration time |
Vip | String | VIP |
Vport | Integer | vport |
ProjectID | Integer | Project ID |
Zone | String | AZ |
ResourceTags | Array of Tag | Array of tags bound to instance |
ServerlessStatus | String | Serverless cluster status when the database type is SERVERLESS . Valid values:resume resuming pause pausing |
Instance information
Used by actions: DescribeClusterInstanceGrps, DescribeInstances.
Name | Type | Description |
---|---|---|
Uin | String | User Uin |
AppId | Integer | User AppId |
ClusterId | String | Cluster ID |
ClusterName | String | Cluster name |
InstanceId | String | Instance ID |
InstanceName | String | Instance name |
ProjectId | Integer | Project ID |
Region | String | Region |
Zone | String | AZ |
Status | String | Instance status |
StatusDesc | String | Instance status description |
DbType | String | Database type |
DbVersion | String | Database version |
Cpu | Integer | Number of CPU cores |
Memory | Integer | Memory in GB |
Storage | Integer | Storage capacity in GB |
InstanceType | String | Instance type |
InstanceRole | String | Current instance role |
UpdateTime | Timestamp | Update time |
CreateTime | Timestamp | Creation time |
VpcId | String | VPC ID |
SubnetId | String | Subnet ID |
Vip | String | Private IP of instance |
Vport | Integer | Private port of instance |
PayMode | Integer | Billing mode |
PeriodEndTime | Timestamp | Instance expiration time |
DestroyDeadlineText | String | Termination deadline |
IsolateTime | Timestamp | Isolation time |
NetType | Integer | Network type |
WanDomain | String | Public domain name |
WanIP | String | Public IP |
WanPort | Integer | Public port |
WanStatus | String | Public network status |
DestroyTime | String | Instance termination time |
CynosVersion | String | TDSQL-C kernel version |
ProcessingTask | String | Task in progress |
RenewFlag | Integer | Renewal flag |
MinCpu | Float | Minimum number of CPU cores for serverless instance |
MaxCpu | Float | Maximum number of CPU cores for serverless instance |
ServerlessStatus | String | Serverless instance status. Valid values: resume pause |
StorageId | String | Prepaid storage ID Note: this field may return null , indicating that no valid value can be obtained. |
StoragePayMode | Integer | Storage billing mode |
Instance details
Used by actions: DescribeInstanceDetail.
Name | Type | Description |
---|---|---|
Uin | String | User Uin |
AppId | Integer | User AppId |
ClusterId | String | Cluster ID |
ClusterName | String | Cluster name |
InstanceId | String | Instance ID |
InstanceName | String | Instance name |
ProjectId | Integer | Project ID |
Region | String | Region |
Zone | String | AZ |
Status | String | Instance status |
StatusDesc | String | Instance status description |
DbType | String | Database type |
DbVersion | String | Database version |
Cpu | Integer | Number of CPU cores |
Memory | Integer | Memory in GB |
Storage | Integer | Storage capacity in GB |
InstanceType | String | Instance type |
InstanceRole | String | Current instance role |
UpdateTime | Timestamp | Update time |
CreateTime | Timestamp | Creation time |
PayMode | Integer | Billing mode |
PeriodEndTime | Timestamp | Instance expiration time |
NetType | Integer | Network type |
VpcId | String | VPC ID |
SubnetId | String | Subnet ID |
Vip | String | Private IP of instance |
Vport | Integer | Private port of instance |
WanDomain | String | Public domain name of instance |
Charset | String | Character set |
CynosVersion | String | TDSQL-C kernel version |
RenewFlag | Integer | Renewal flag |
MinCpu | Float | The minimum number of CPU cores for a serverless instance |
MaxCpu | Float | The maximum number of CPU cores for a serverless instance |
ServerlessStatus | String | Serverless instance status. Valid values: resume pause |
Instance group information
Used by actions: DescribeClusterInstanceGrps.
Name | Type | Description |
---|---|---|
AppId | Integer | appId |
ClusterId | String | Cluster ID |
CreatedTime | Timestamp | Creation time |
DeletedTime | Timestamp | Deletion time |
InstanceGrpId | String | Instance group ID |
Status | String | Status |
Type | String | Instance group type. ha: HA group; ro: RO group |
UpdatedTime | Timestamp | Update time |
Vip | String | Private IP |
Vport | Integer | Private port |
WanDomain | String | Public domain name |
WanIP | String | Public IP |
WanPort | Integer | Public port |
WanStatus | String | Public network status |
InstanceSet | Array of CynosdbInstance | Information of instances contained in instance group |
Details of purchasable instance specifications. Cpu
and Memory
determine the instance specification during instance creation. The value range of the storage capacity is [MinStorageSize,MaxStorageSize]
Used by actions: DescribeInstanceSpecs.
Name | Type | Description |
---|---|---|
Cpu | Integer | Number of instance CPU cores |
Memory | Integer | Instance memory in GB |
MaxStorageSize | Integer | Maximum instance storage capacity GB |
MinStorageSize | Integer | Minimum instance storage capacity GB |
Network information
Used by actions: DescribeClusters.
Name | Type | Description |
---|---|---|
Vip | String | Private network IP Note: this field may return null , indicating that no valid values can be obtained. |
Vport | Integer | Private network port number Note: this field may return null , indicating that no valid values can be obtained. |
WanDomain | String | Public network domain name Note: this field may return null , indicating that no valid values can be obtained. |
WanPort | Integer | Public network port number Note: this field may return null , indicating that no valid values can be obtained. |
NetType | String | Network type. Valid values: ro (read-only), rw or ha (read-write)Note: this field may return null , indicating that no valid values can be obtained. |
Newly created account
Used by actions: CreateAccounts.
Name | Type | Required | Description |
---|---|---|---|
AccountName | String | Yes | Account name |
AccountPassword | String | Yes | Password |
Host | String | Yes | Host |
Description | String | No | Description |
Task information
Used by actions: DescribeClusters.
Name | Type | Required | Description |
---|---|---|---|
TaskId | Integer | No | Auto-Incrementing task ID Note: this field may return null, indicating that no valid values can be obtained. |
TaskType | String | No | Task type Note: this field may return null, indicating that no valid values can be obtained. |
TaskStatus | String | No | Task status Note: this field may return null, indicating that no valid values can be obtained. |
ObjectId | String | No | Task ID (cluster ID | instance group ID | instance ID) Note: this field may return null, indicating that no valid values can be obtained. |
ObjectType | String | No | Task type Note: this field may return null, indicating that no valid values can be obtained. |
Parameter to be modified
Used by actions: ModifyClusterParam.
Name | Type | Required | Description |
---|---|---|---|
ParamName | String | Yes | Parameter name |
CurrentValue | String | Yes | New value |
OldValue | String | Yes | Original value |
Security group rule
Used by actions: DescribeDBSecurityGroups, DescribeProjectSecurityGroups.
Name | Type | Description |
---|---|---|
Action | String | Policy, which can be ACCEPT or DROP |
CidrIp | String | Source IP or IP range, such as 192.168.0.0/16 |
PortRange | String | Port |
IpProtocol | String | Network protocol, such as UDP and TCP |
ServiceModule | String | Protocol port ID or protocol port group ID. |
AddressModule | String | IP address ID or IP address group ID. |
Id | String | id |
Desc | String | Description |
Query filter
Used by actions: DescribeClusters, DescribeInstances.
Name | Type | Required | Description |
---|---|---|---|
Names | Array of String | Yes | Search field. Valid values: "InstanceId", "ProjectId", "InstanceName", "Vip" |
Values | Array of String | Yes | Search string |
ExactMatch | Boolean | No | Whether to use exact match |
Name | String | No | Search field |
Security group details
Used by actions: DescribeDBSecurityGroups, DescribeProjectSecurityGroups.
Name | Type | Description |
---|---|---|
ProjectId | Integer | Project ID |
CreateTime | String | Creation time in the format of yyyy-mm-dd hh:mm:ss |
Inbound | Array of PolicyRule | Inbound rule |
Outbound | Array of PolicyRule | Outbound rule |
SecurityGroupId | String | Security group ID |
SecurityGroupName | String | Security group name |
SecurityGroupRemark | String | Security group remarks |
Information of tags associated with cluster, including TagKey
and TagValue
Used by actions: DescribeClusterDetail, DescribeClusters.
Name | Type | Required | Description |
---|---|---|---|
TagKey | String | Yes | Tag key |
TagValue | String | Yes | Tag value |
Was this page helpful?