中国站

产品

硅云帮助文档中心

搜索文档

热门搜索词:

搜索实例

更新时间:2020-07-14 15:03  版本:v1.2
分享到:
我要反馈 
收藏 我的收藏

简要描述:


    搜索实例


请求url:


/ncs-server/api/v1/disk/search


请求方式:


GET


请求参数:


字段
类型最大长度参数位置默认选填
描述
page int10RequestBody
页,默认1 第一页
rowint10RequestBody
默认10  一页10行,最大100
statusstring16RequestBody
实例状态
areaMarkstring32RequestBody
地区标识
attacheHostId
string32RequestBody
挂载的服务器实例Id
bindHostIdstring32
RequestBody
绑定续费的服务器Id
nullOfBindHostIdboolean1RequestBody
为true时只返回bindHostId为Null的磁盘,即没有绑定续费的磁盘,为false时和不填时不区分
autoRenewboolean1RequestBody
是否开启了自动续费,true为已开启
idstring32RequestBody
实例Id,模糊查询,精确查询请通过根据实例id获取实例接口
fromCreateTimelong64RequestBody
创建时间时间戳左区间,精确到毫秒
toCreateTimelong64RequestBody
创建时间时间戳右区间,精确到毫秒
fromEndTimelong64RequestBody
过期时间时间戳左区间,精确到毫秒
toEndTimelong64RequestBody
过期时间时间戳右区间,精确到毫秒



请求示例:


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"
            }
        ]
    }
}


实例数据结构:


字段类型
描述
idstring实例id
userAccount
string用户名
diskSize
int磁盘大小
status
string实例状态
remoteDiskStatusstring实例运行状态
attacheHostIdstring挂载的服务器Id,可能为空
bindHostIdstring绑定续费的服务器Id,可能为空
attacheAsstringdata挂载为数据盘,boot挂载为系统盘,可能为空
isBootablebooleantrue为启动盘
endTimelong到期时间时间戳,精确到毫秒
createTimelong创建时间时间戳,精确到毫秒











您对该文档有什么建议?

您对该文档的评分:

本文导航

简要描述:

请求url:

请求方式:

请求参数:

请求示例:

返回示例:

搜索文档