硅云帮助文档中心
搜索文档
热门搜索词:
产品简介
产品定价
入门指南
经典案例
快照
常见问题
知识拓展
名词解释
API参考
搜索实例
/ncs-server/api/v1/disk/search
GET
| 字段 | 类型 | 最大长度 | 参数位置 | 默认选填 | 描述 |
| page | int | 10 | RequestBody | 页,默认1 第一页 | |
| row | int | 10 | RequestBody | 默认10 一页10行,最大100 | |
| status | string | 16 | RequestBody | 实例状态 | |
| areaMark | string | 32 | RequestBody | 地区标识 | |
| attacheHostId | string | 32 | RequestBody | 挂载的服务器实例Id | |
| bindHostId | string | 32 | RequestBody | 绑定续费的服务器Id | |
| nullOfBindHostId | boolean | 1 | RequestBody | 为true时只返回bindHostId为Null的磁盘,即没有绑定续费的磁盘,为false时和不填时不区分 | |
| autoRenew | boolean | 1 | RequestBody | 是否开启了自动续费,true为已开启 | |
| id | string | 32 | RequestBody | 实例Id,模糊查询,精确查询请通过根据实例id获取实例接口 | |
| fromCreateTime | long | 64 | RequestBody | 创建时间时间戳左区间,精确到毫秒 | |
| toCreateTime | long | 64 | RequestBody | 创建时间时间戳右区间,精确到毫秒 | |
| fromEndTime | long | 64 | RequestBody | 过期时间时间戳左区间,精确到毫秒 | |
| toEndTime | long | 64 | RequestBody | 过期时间时间戳右区间,精确到毫秒 |
GET /ncs-server/api/v1/disk/search HTTP/1.1
Content-Type: application/json
request_id: 2942183558593ffc9d75fb8e16793ff
api_key: 1706006863049654272
signature: 9949eb95d9d62fec4a19bbbfdbad52f22745d2a8aea2618eee41d2dd8ace22d6
Content-Type: application/json
{
"page": 1,
"row": 1
}count表示符合该条件的实例总共有多少条。
{
"status": 2000,
"message": "success",
"data": {
"count": 5,
"data": [
{
"userAccount": "z8z87878",
"remoteId": "1fd3397f-038f-4b63-ae93-dfb66e093b82",
"productId": "standard_cloud_disk",
"productName": "高效云盘",
"latestOrderId": "1706473829073420289",
"areaMark": "test",
"areaName": "测试环境",
"diskSize": 16,
"beginTime": 1589277056852,
"endTime": 1594547456852,
"status": "OK",
"remoteDiskStatus": "extending",
"remoteHostName": "computer2",
"attacheHostId": "cvm-3hdk8be2b2225",
"autoRenew": false,
"supportNoReasonRefund": false,
"refundStatus": "NONE",
"configuration": "",
"createTime": 1589277056853,
"updateTime": 1589277602518,
"id": "disk-3hdnwe228s223"
}
]
}
}实例数据结构:
| 字段 | 类型 | 描述 |
| id | string | 实例id |
| userAccount | string | 用户名 |
| diskSize | int | 磁盘大小 |
| status | string | 实例状态 |
| remoteDiskStatus | string | 实例运行状态 |
| attacheHostId | string | 挂载的服务器Id,可能为空 |
| bindHostId | string | 绑定续费的服务器Id,可能为空 |
| attacheAs | string | data挂载为数据盘,boot挂载为系统盘,可能为空 |
| isBootable | boolean | true为启动盘 |
| endTime | long | 到期时间时间戳,精确到毫秒 |
| createTime | long | 创建时间时间戳,精确到毫秒 |
您对该文档有什么建议?
本文导航