企业端分页查询存储实例
企业端按条件分页查询本企业下的 NAS 存储实例列表,支持按存储目录名、状态、存储类型、实例 ID 等过滤。返回每个实例的容量配额、使用量、挂载路径、计费信息与共享策略等。可由本接口拿到实例 id,再调用存储实例详情、扩容或释放等接口。
https://api.alayanew.com/v1/nasStorage/instance/tenant/page鉴权(Authorizations)
bearerAuthAuthorizationString必填用户可通过已获取的 Open API Key 做验证。例如:Bearer [YOUR_API_KEY]。
Query Parameters
pageNoInteger页码,从 1 开始。例如:1。
pageSizeInteger每页行数。例如:20。
nameString按存储目录名模糊查询。例如:mynas001。
tenantIdString按租户 ID 过滤。例如:ca78d6b9-e196-5a0f-b1be-ab036b3cb91a。
statusString按实例状态过滤。例如:Creating(创建中)。常见取值还包括 Running(运行中)、Releasing(释放中)、Released(已释放)等,以实际返回为准。
storageTypeString按存储类型过滤。例如:nas-capacity(大容量型)、nas-performance(性能型)。
idString按存储实例 ID 精确查询。例如:ca78d6b9-e196-5a0f-b1be-ab036b3cb91a。
orderInstanceIdString按订阅实例 ID 过滤。例如:ca78d6b9-e196-5a0f-b1be-ab036b3cb91a。
aidcIdInteger按智算中心(AIDC)ID 过滤。例如:1。
Response
application/json · 200statusInteger业务状态码,200 表示成功。
messageString接口响应信息。例如:"OK"。
dataObject分页数据对象,包含存储实例列表与分页信息。
显示 properties
recordsArray存储实例列表。
显示 properties
idString存储实例 ID。例如:"00964ce3-b99c-43da-8826-ab9c5574eef2"。
nameString存储目录名。例如:"nas0001"。
descriptionString实例描述。例如:"我的实例"。
orderInstanceIdString订阅实例 ID(对应底层订单实例)。例如:"00964ce3-b99c-43da-8826-ab9c5574eef2"。
statusString实例状态。例如:"Creating"(创建中)。常见取值还包括 Running、Releasing、Released 等。
storageTypeString存储类型。例如:"capacity"(大容量型)、"performance"(性能型)。
quotaString容量配额(GB)。例如:"100"。
usedString已使用量(GB)。例如:"10"。
mountPathString默认挂载路径。例如:"/mnt/nas/new_path"。
resourceObject存储资源规格。
显示 properties
quotaString资源容量(GB)。例如:"50"。
productNameString产品名(资源类型)。例如:"NA型实-大容量存储"。
productCodeString产品编码。例如:"PRD-NAS-CAPACITY-1"。
createdTimeString创建时间。例如:"2023-12-10 00:00:00"。
lastUpdateTimeString最近修改时间。例如:"2023-12-10 23:59:59"。
releaseTimeString释放时间(未释放时为空)。例如:"2023-12-10 23:59:59"。
tenantIdString租户 ID。例如:"4d7119bd-8e71-49a9-a319-f84d165f79d9"。
priceString价格。例如:"0.01"。
priceUnitString价格单位。例如:"元/GB/月"。
currencyUnitOfMeasureInteger现金计量单位。例如:9。
currencyUnitPriceFormulaString现金价格公式。例如:"元/GB/月"。
sharePolicyObjectNAS 存储共享策略。
显示 properties
policyString共享策略:R 只读、RW 读写。例如:"R"。
createdByString创建者 ID。例如:"4d7119bd-8e71-49a9-a319-f84d165f79d9"。
createdByNameString创建者名称。例如:"张三"。
lastUpdateByString上次更新者 ID。
lastUpdateByNameString上次更新者名称。
createSceneString创建来源场景:如 ALab、CCI,为空表示手动创建。例如:"ALab"。
createSceneInstanceIdString创建来源实例 ID。例如:"00964ce3-b99c-43da-8826-ab9c5574eef2"。
isDefaultStorageBoolean是否为来源实例创建时绑定的默认存储。例如:true。
aidcIdInteger智算中心(AIDC)ID。例如:1。
pageNoInteger当前页码。例如:1。
pageSizeInteger每页行数。例如:20。
totalRowsInteger总行数。例如:120。
curl -X 'GET' \
'https://api.alayanew.com/v1/nasStorage/instance/tenant/page?pageNo=1&pageSize=20&name=mynas001&status=Running&storageType=nas-capacity' \
-H 'accept: application/json' \
-H 'Authorization: Bearer [YOUR_API_KEY]'import requests
url = "https://api.alayanew.com/v1/nasStorage/instance/tenant/page"
params = {
"pageNo": 1,
"pageSize": 20,
"name": "mynas001",
"status": "Running",
"storageType": "nas-capacity"
}
headers = {
"accept": "application/json",
"Authorization": "Bearer [YOUR_API_KEY]"
}
response = requests.get(url, params=params, headers=headers)
print(response.json())const params = new URLSearchParams({
pageNo: '1',
pageSize: '20',
name: 'mynas001',
status: 'Running',
storageType: 'nas-capacity'
});
fetch(`https://api.alayanew.com/v1/nasStorage/instance/tenant/page?${params}`, {
method: 'GET',
headers: {
'accept': 'application/json',
'Authorization': 'Bearer [YOUR_API_KEY]'
}
})
.then(res => res.json())
.then(console.log)
.catch(console.error);{
"status": 200,
"message": "OK",
"data": {
"records": [
{
"id": "00964ce3-b99c-43da-8826-ab9c5574eef2",
"name": "nas0001",
"description": "我的实例",
"orderInstanceId": "00964ce3-b99c-43da-8826-ab9c5574eef2",
"status": "Creating",
"storageType": "capacity",
"quota": "100",
"used": "10",
"mountPath": "/mnt/nas/new_path",
"resource": {
"quota": "50",
"productName": "NA型实-大容量存储",
"productCode": "PRD-NAS-CAPACITY-1"
},
"createdTime": "2023-12-10 00:00:00",
"lastUpdateTime": "2023-12-10 23:59:59",
"releaseTime": "2023-12-10 23:59:59",
"tenantId": "4d7119bd-8e71-49a9-a319-f84d165f79d9",
"price": "0.01B",
"priceUnit": "8",
"currencyUnitOfMeasure": 9,
"currencyUnitPriceFormula": "0.01B",
"sharePolicy": {
"policy": "R"
},
"createdBy": "4d7119bd-8e71-49a9-a319-f84d165f79d9",
"createdByName": "string",
"lastUpdateBy": "string",
"lastUpdateByName": "string",
"createScene": "ALab",
"createSceneInstanceId": "00964ce3-b99c-43da-8826-ab9c5574eef2",
"isDefaultStorage": true,
"aidcId": 9007199254740991
}
],
"pageNo": 1,
"pageSize": 20,
"totalRows": 120
}
}{
"status": 403,
"message": "Forbidden",
"data": {}
}{
"status": 500,
"message": "Internal Server Error",
"data": {}
}最后更新于
