接口功能介绍
查询指定物理机的本地盘raid信息
接口约束
无
URI
GET /v4/ebm/instance_raid_list
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 区域ID | 81f7728662dd11ec810800155d307d5b | |
azName | 是 | String | 可用区名称或者 default。您可以调用 https://www.ctyun.cn/document/10026730/10040590 获取资源池信息,查询结果中zoneList内返回可用区名称,若查询结果中zoneList为空,即为单可用区,本字段填写default | az1 | |
instanceUUID | 是 | String | 实例uuid | ss-vukvrtktafkyovqojz811e3izvhc |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败),默认值:800 | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码,详见错误码说明 | Ebm.InstanceRaidList.NotValid | |
message | String | 响应结果的描述,一般为英文描述 | error request | |
description | String | 响应结果的描述,一般为中文描述 | 错误请求 | |
returnObj | Object | 返回参数,参考表returnObj | {} | returnObj |
表returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
raidDetail | Array of Objects | 磁盘阵列信息 | raidDetail |
表raidDetail
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
systemVolume | Object | 系统盘 | systemVolume | |
dataVolume | Object | 数据盘 | dataVolume |
表systemVolume
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
uuid | String | UUID | r-wtzluqacgzzxgunnabdkpnpjew3d | |
volumeType | String | 卷类型 | SYSTEM | |
name | String | raid名称 | RAID1 | |
volumeDetail | String | 卷详情 | 2*480GB(SSD) |
表dataVolume
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
uuid | String | UUID | r-qytwf9r5h0yn9x4evjkyr0n1cwyb | |
volumeType | String | 卷类型 | DATA | |
name | String | raid名称 | NORAID | |
volumeDetail | String | 卷详情 | 2*3200GB(NVMeSSD) |
请求示例
Query
/openapi/v4/ebm/instance_raid_list?regionID=bb9fdb42056f11eda1610242ac110002&azName=az2&instanceUUID=ss-wcwkjt374iq5ce8orekenziqdfs5
响应示例
{
"returnObj": {
"raidDetail": {
"dataVolume": {
"volumeDetail": "2*3200GB(NVMeSSD)",
"volumeType": "DATA",
"uuid": "r-qytwf9r5h0yn9x4evjkyr0n1cwyb",
"name": "NORAID"
},
"systemVolume": {
"volumeDetail": "2*480GB(SSD)",
"volumeType": "SYSTEM",
"uuid": "r-wtzluqacgzzxgunnabdkpnpjew3d",
"name": "RAID1"
}
}
},
"statusCode": 800,
"errorCode": "",
"message": "SUCCESS",
"description": "成功"
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功 |
错误码
错误码 | 描述 |
---|---|
Ebm.InstanceRaidList.NotValid | 请求参数非法 |
Ebm.Instance.NotFound | 物理机不存在 |
Ebm.Common.CheckError | 内部错误,请重试 |
其他 | 参见公共错误码说明 |