# 获取云数据库价格 - DescribeUDBInstancePrice

## 简介

获取UDB实例价格信息





## 定义

### 公共参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Action**     | string  | 对应的 API 指令名称，当前 API 为 `DescribeUDBInstancePrice`                        | **Yes** |
| **PublicKey**  | string  | 用户公钥，可从 [控制台](https://console.genesissai.com/uaccount/api_manage) 获取                                             | **Yes** |
| **Signature**  | string  | 根据公钥及 API 指令生成的用户签名，参见 [签名算法](/docs/api/summary/signature.md)  | **Yes** |

### 请求参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Region** | string | 地域。 参见 [地域和可用区列表](/docs/api/summary/regionlist) |**Yes**|
| **Zone** | string | 可用区。参见 [可用区列表](/docs/api/summary/regionlist) |**Yes**|
| **MemoryLimit** | int | 内存限制(MB)，单位为MB.目前支持：2000-96000 |**Yes**|
| **DiskSpace** | int | 磁盘空间(GB),暂时支持20(GB) - 3000(GB), 输入不带单位 |**Yes**|
| **DBTypeId** | string | UDB实例的DB版本字符串 |**Yes**|
| **Count** | int | 购买DB实例数量,最大数量为10台, 默认为1台 |No|
| **ChargeType** | string | Year，按年付费； <br />Month，按月付费 <br />Dynamic，按需付费（需开启权限) <br />Trial，试用（需开启权限）<br />默认为月付 |No|
| **Quantity** | int | DB购买多少个"计费时间单位"，默认值为1。比如：买2个月，Quantity就是2。如果计费单位是“按月”，并且Quantity为0，表示“购买到月底” |No|
| **SSDType** | string | 该字段已废弃。 |No|
| **InstanceMode** | string | 实例的部署类型。可选值为：Normal: 普通单点实例，Slave: 从库实例，HA: 高可用部署实例，默认是Normal |No|
| **CPU** | int | CPU个数，如果db类型为sqlserver，则为必填参数 |No|
| **InstanceType** | string | 对于快杰机型，请使用最新的 SpecificationClass 和 StorageClass 字段进行创建。<br />目前仅有少量地域支持 SATA_SSD 存储类型；若创建的是 SATA_SSD 机型，可通过该字段指定。<br /><br />字段说明：<br /><br />SATA_SSD：SATA SSD 机型（仅部分地域支持）<br />NVMe_SSD：快杰机型 |No|
| **SpecificationType** | int | 	<br />实例计算规格类型，0或不传代表使用内存方式购买，1代表使用内存-cpu可选配比方式购买，需要填写MachineType |No|
| **MachineType** | string | 规格类型ID,当SpecificationType为1时有效 |No|
| **StorageClass** | string | 存储类型 CLOUD_SSD: SSD云盘, CLOUD_RSSD: RSSD 云盘， CLOUD_SSD_ESSENTIAL: SSD Essential云盘 ，该字段和SpecificationClass组合优先级比InstanceType字段高 |No|
| **SpecificationClass** | string | 规格类型 O: NVME, OM: 共享型，N: 通用型 |No|

### 响应字段

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **RetCode** | int | 返回状态码，为 0 则为成功返回，非 0 为失败 |**Yes**|
| **Action** | string | 操作指令名称 |**Yes**|
| **Message** | string | 返回错误消息，当 `RetCode` 非 0 时提供详细的描述信息 |No|
| **DataSet** | array[[*UDBInstancePriceSet*](#UDBInstancePriceSet)] | 价格 参照UDBInstancePriceSet |No|

#### 数据模型


#### UDBInstancePriceSet

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **ChargeType** | string | Year， Month， Dynamic，Trial |No|
| **Price** | int | 价格，单位为分 |No|

## 示例

### 请求示例
    
```
https://api.genesissai.com/?Action=DescribeUDBInstancePrice
&Region=cn-bj2
&Zone=cn-bj2-04
&Count=1   
&ChargeType=Month   
&Quantity=12
&MemoryLimit=600
&DiskSpace=20
&DBTypeId=mysql-5.5
&InstanceType=dsztMviC
&CPU=3
&InstanceType=QOajbSxZ
&SpecificationType=uaqGNDue
&MachineType=ENbIvUer
&StorageClass=cinLFUIr
&SpecificationClass=XyDTTLNH
```

### 响应示例
    
```json
{
  "Action": "DescribeUDBInstancePriceResponse",
  "DataSet": [
    {
      "ChargeType": "Month",
      "Price": 1360
    }
  ],
  "RetCode": 0
}
```