接口功能介绍
查询实例资源信息
接口约束
存在用户实例并拿到实例ID
URI
GET /v1/open-api/instance/resource
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
outerProdInstId | 是 | String | 实例ID | 562b89493b1a40e1b97ea05e50dd8170 | |
accessKey | 是 | String | 用户天翼云安全公钥 | ||
securityKey | 是 | String | 用户天翼云安全私钥 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回码 | 0 | |
message | 是 | String | 返回消息 | ||
returnObj | 是 | Object | 返回对象 | returnObj |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
diskSize | 是 | Integer | 磁盘大小 单位 G | 100 | |
volumeType | 是 | String | 磁盘类型,取值范围:SATA、SAS、SSD | ||
cpuNum | 是 | Integer | cpu大小 | 2 | |
memSize | 是 | Integer | 内存大小 | 4 | |
edition | 是 | String | 版本类型 (可选值: basic 单机版, advanced 一主两备版 ,highAvailability 主备版) | ||
engineVersion | 是 | String | 引擎版本,5.7版本、8.0版本 | ||
engineType | 是 | String | 引擎类型 MySQL | MySQL | |
subnetId | 是 | String | 子网Id | ||
vpcId | 是 | String | VPCId | ||
secgroups | 是 | String | 安全组Id | ||
storageResourceId | 是 | String | 磁盘资源ID | ||
bakResourceId | 是 | String | 备份磁盘资源ID | ||
dbName | 是 | String | 实例名称 | ||
bakVolumeType | 是 | String | 备份磁盘类型,取值范围:SATA、SAS、SSD | ||
bakDiskSize | 是 | Integer | 备份磁盘大小 单位 G |
请求示例
请求头header
无
请求体body
无
响应示例
{
"statusCode": 0,
"message": "success",
"returnObj": {
"engineVersion": "8.0",
"storageResourceId": "fa0ce564255841b693823a64ac6eb537",
"subnetId": "9258fc75-37e1-45e9-8eb6-5b77f3ee98a4",
"volumeType": "SATA",
"secGroups": "de418653-e4b0-4fde-a897-0a0e014bcc57",
"dbName": "Rds-64f9",
"edition": "highAvailability",
"engineType": "MySQL",
"bakDiskSize": 100,
"cpuNum": 1,
"diskSize": 100,
"bakVolumeType": "SATA",
"vpcId": "55b98533-fd84-4e2f-847d-711cea305a4d",
"bakResourceId": "20267778a1df484da35fe7ee0982937a",
"memSize": 4
}
}
状态码
状态码 | 描述 |
---|---|
0 | 请求响应成功 |
错误码
错误码 | 描述 |
---|---|
2001 | 参数异常,失败原因见message |
3001 | 业务异常,失败原因见message |
5001 | 请求响应失败,失败原因见message |