Get the supported types of UDB - DescribeUDBType

Overview

Get the type information supported by UDB

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeUDBType`.	Yes
PublicKey	string	The user's public key can be obtained from Console (opens in a new tab)	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	Yes

Request Parameters

Parameter Name	Type	Description Information	Required
Region	string	Region. See List of Regions and Availability Zones	Yes
Zone	string	Availability Zone. See Availability Zone List	Yes
BackupZone	string	The region where the standby database of the cross-availability zone high-availability DB is located, only filled in when this availability zone supports cross-availability zone high-availability. See Availability Zone List	No
DBClusterType	string	DB instance types, such as mysql, sqlserver, mongo, postgresql	No
InstanceMode	string	Return the DB types that support a certain instance type. If not passed, it means any instance type is acceptable. normal: single point, ha: high availability, sharded_cluster: sharded cluster.	No
DiskType	string	Returns the DB type that supports a certain disk type, such as Normal, SSD, NVMe_SSD. If not passed, it means any disk type is acceptable.	No
CompatibleWithDBType	string	Returns the backup creation version supported by the version number when creating an instance from a backup. If not passed, it means it is not created from a backup.	No
DBSubVersion	string	Returns the minor version supported for backup creation when creating an instance from a backup. If not passed, it means it is not created from a backup.	No

Response Field

Field Name	Type	Description Information	Required
RetCode	int	Return status code. If it is 0, it means successful return. If it is not 0, it means failure.	Yes
Action	string	Operation command name.	Yes
Message	string	Returns an error message, providing detailed description when `RetCode` is non-zero.	No
DataSet	array[UDBTypeSet]	List of DB Types, see parameters in UDBTypeSet	No

Data Model

UDBTypeSet

Field Name	Type	Description Information	Required
DBTypeId	string	DB type id, mysql/mongodb each have an id subdivided by version, the current range of id values is [1,7], the versions corresponding to the values are as follows: 1: mysql-5.5, 2: mysql-5.1, 3: percona-5.5 4: mongodb-2.4, 5: mongodb-2.6, 6: mysql-5.6, 7: percona-5.6	No
DBSubVersion	string	MySQL sub-versions, such as MySQL-8.0.25, MySQL-8.0.16	No

Example

Request Example

https://api.surfercloud.com/?Action=DescribeUDBType
&Region=cn-bj2
&Zone=cn-bj2-04
&InstanceMode=Normal
&DiskType=hdd
&DBClusterType=mysql
&BackupZone=cn-bj2-03
&CompatibleWithDBTyp=tFbuDJNk
&DiskType=YQQrlDqy
&DBSubVersion=vRIiSgia

Response Example

{
  "Action": "DescribeUDBTypeResponse",
  "DataSet": [
    {
      "DBTypeId": "mysql-5.1"
    },
    {
      "DBTypeId": "mysql-5.5"
    },
    {
      "DBTypeId": "percona-5.5"
    },
    {
      "DBTypeId": "mongodb-2.4"
    }
  ],
  "RetCode": 0
}

ExtractUDBParamGroup StopUDBInstance