硅云幫助文檔中心
搜索文檔
熱門搜索詞:
產品簡介
產品定價
入門指南
經典案例
快照
常見問題
知識拓展
名詞解釋
API參考
產品規(guī)格相關接口
服務器實例相關接口
安全組相關接口
磁盤相關接口
搜索實例
/ncs-server/api/v1/disk/search
GET
字段 | 類型 | 最大長度 | 參數(shù)位置 | 默認選填 | 描述 |
page | int | 10 | RequestBody | 頁,默認1 第一頁 | |
row | int | 10 | RequestBody | 默認10 一頁10行,最大100 | |
status | string | 16 | RequestBody | 實例狀態(tài) | |
areaMark | string | 32 | RequestBody | 地區(qū)標識 | |
attacheHostId | string | 32 | RequestBody | 掛載的服務器實例Id | |
bindHostId | string | 32 | RequestBody | 綁定續(xù)費的服務器Id | |
nullOfBindHostId | boolean | 1 | RequestBody | 為true時只返回bindHostId為Null的磁盤,即沒有綁定續(xù)費的磁盤,為false時和不填時不區(qū)分 | |
autoRenew | boolean | 1 | RequestBody | 是否開啟了自動續(xù)費,true為已開啟 | |
id | string | 32 | RequestBody | 實例Id,模糊查詢,精確查詢請通過根據(jù)實例id獲取實例接口 | |
fromCreateTime | long | 64 | RequestBody | 創(chuàng)建時間時間戳左區(qū)間,精確到毫秒 | |
toCreateTime | long | 64 | RequestBody | 創(chuàng)建時間時間戳右區(qū)間,精確到毫秒 | |
fromEndTime | long | 64 | RequestBody | 過期時間時間戳左區(qū)間,精確到毫秒 | |
toEndTime | long | 64 | RequestBody | 過期時間時間戳右區(qū)間,精確到毫秒 |
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": "測試環(huán)境", "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" } ] } }
實例數(shù)據(jù)結構:
字段 | 類型 | 描述 |
id | string | 實例id |
userAccount | string | 用戶名 |
diskSize | int | 磁盤大小 |
status | string | 實例狀態(tài) |
remoteDiskStatus | string | 實例運行狀態(tài) |
attacheHostId | string | 掛載的服務器Id,可能為空 |
bindHostId | string | 綁定續(xù)費的服務器Id,可能為空 |
attacheAs | string | data掛載為數(shù)據(jù)盤,boot掛載為系統(tǒng)盤,可能為空 |
isBootable | boolean | true為啟動盤 |
endTime | long | 到期時間時間戳,精確到毫秒 |
createTime | long | 創(chuàng)建時間時間戳,精確到毫秒 |
您對該文檔有什么建議?
本文導航