describeRdsInstances

描述

批量查询云数据库实例列表信息
此接口支持分页查询,默认每页20条。

请求方式

GET

请求地址

https://yunding.jdcloud-api.com/v2/regions/{regionId}/ydRdsInstances

名称 类型 是否必需 默认值 描述
regionId String True 地域代码,取值范围参见《各地域及可用区对照表》

请求参数

名称 类型 是否必需 默认值 描述
pageNumber Integer False 显示数据的页码,默认为1,取值范围:[-1,∞)。pageNumber为-1时,返回所有数据页码;超过总页数时,显示最后一页;
pageSize Integer False 每页显示的数据条数,默认为100,取值范围:[10,100],用于查询列表的接口
filters Filter[] False 过滤参数,多个过滤参数之间的关系为“与”(and)
支持以下属性的过滤:
instanceId, 支持operator选项:eq
instanceName, 支持operator选项:eq
engine, 支持operator选项:eq
engineVersion, 支持operator选项:eq
instanceStatus, 支持operator选项:eq
chargeMode, 支持operator选项:eq
vpcId, 支持operator选项:eq
type Integer False 资源类型,MySQL:1,SqlServer:2

Filter

名称 类型 是否必需 默认值 描述
name String True 过滤条件的名称
operator String False 过滤条件的操作符,默认eq
values String[] True 过滤条件的值

返回参数

名称 类型 描述
result Result
requestId String 请求id

Result

名称 类型 描述
dbInstances DBInstance[]
totalCount Integer

DBInstance

名称 类型 描述
instanceId String 实例ID
instanceName String 实例名称,具体规则可参见帮助中心文档:名称及密码限制
instanceType String 实例类别,例如主实例,只读实例等,参见枚举参数定义
engine String 实例引擎类型,如MySQL或SQL Server等,参见枚举参数定义
engineVersion String 实例引擎版本,参见枚举参数定义
instanceClass String 实例规格代码
instanceStorageGB Integer 磁盘,单位GB
instanceCPU Integer CPU核数
instanceMemoryMB Integer 内存,单位MB
regionId String 地域ID,参见地域及可用区对照表
azId String[] 可用区ID,第一个为主实例在的可用区,参见地域及可用区对照表
vpcId String VPC的ID
subnetId String 子网的ID
instanceStatus String 实例状态,参见枚举参数定义
createTime String 实例创建时间
backupSynchronicity BackupSynchronicityAbstract[] 实例跨地域备份服务开启相关信息
charge Charge 计费配置
tags Tag[] 标签信息
sourceInstanceId String MySQL只读实例对应的主实例ID
vpcName String vpc名称
dbUrl String DMS登陆数据库链接

Tag

名称 类型 描述
key String 标签键
value String 标签值

Charge

名称 类型 描述
chargeMode String 支付模式,取值为:prepaid_by_duration,postpaid_by_usage或postpaid_by_duration,prepaid_by_duration表示预付费,postpaid_by_usage表示按用量后付费,postpaid_by_duration表示按配置后付费,默认为postpaid_by_duration
chargeStatus String 费用支付状态,取值为:normal、overdue、arrear,normal表示正常,overdue表示已到期,arrear表示欠费
chargeStartTime String 计费开始时间,遵循ISO8601标准,使用UTC时间,格式为:YYYY-MM-DDTHH:mm:ssZ
chargeExpiredTime String 过期时间,预付费资源的到期时间,遵循ISO8601标准,使用UTC时间,格式为:YYYY-MM-DDTHH:mm:ssZ,后付费资源此字段内容为空
chargeRetireTime String 预期释放时间,资源的预期释放时间,预付费/后付费资源均有此值,遵循ISO8601标准,使用UTC时间,格式为:YYYY-MM-DDTHH:mm:ssZ

BackupSynchronicityAbstract

名称 类型 描述
serviceId String 跨地域备份同步服务ID
destRegion String 备份同步的目标地域

返回码

HTTP状态码 错误码 描述
200 OK

results matching ""

    No results matching ""

    results matching ""

      No results matching ""