Alaya NeW Cloud
Console ↗中

查询实例详情

根据实例 ID 查询单个 NAS 存储实例的完整信息，包含容量与用量、挂载路径、资源规格、计费、共享策略及创建来源等。实例 ID 可从存储实例列表获取。

GEThttps://api.alayanew.com/v1/nasStorage/instance/{id}

鉴权（Authorizations）

bearerAuth
AuthorizationString必填

用户可通过已获取的 Open API Key 做验证。例如：Bearer [YOUR_API_KEY]。

Path Parameters

idString必填

存储实例 ID（来自存储实例列表的 id）。例如：00964ce3-b99c-43da-8826-ab9c5574eef2。

Response

application/json · 200
statusInteger

业务状态码，200 表示成功。

messageString

接口响应信息。例如："OK"。

dataObject

NAS 存储实例详情。

显示 properties
idString

存储实例 ID。例如："00964ce3-b99c-43da-8826-ab9c5574eef2"。

nameString

存储目录名。例如："nas0001"。

descriptionString

实例描述，可通过修改描述接口更新。例如："我的实例"。

orderInstanceIdString

订阅实例 ID，对应该存储所属的订单订阅记录。例如："00964ce3-b99c-43da-8826-ab9c5574eef2"。

statusString

实例状态。常见取值：Creating 创建中、Running 运行中、Released 已释放（以实际返回为准）。例如："Creating"。

storageTypeString

存储类型。例如："capacity" 大容量存储。

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.01B"。

priceUnitString

价格单位，例如：元/GB/月。例如："8"。

sharePolicyObject

NAS 存储共享策略。

显示 properties
policyString

共享策略标识。例如："R" 只读、"RW" 读写（以实际返回为准）。

createdByString

创建者 ID。例如："4d7119bd-8e71-49a9-a319-f84d165f79d9"。

createdByNameString

创建者名称。例如："张三"。

lastUpdateByString

上次更新者 ID。

lastUpdateByNameString

上次更新者名称。

createSceneString

创建来源实例类型。例如："ALab"、"CCI"；为空表示手动创建。

createSceneInstanceIdString

创建来源实例 ID。例如："00964ce3-b99c-43da-8826-ab9c5574eef2"。

curl -X 'GET' \
  'https://api.alayanew.com/v1/nasStorage/instance/00964ce3-b99c-43da-8826-ab9c5574eef2' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer [YOUR_API_KEY]'
import requests

instance_id = "00964ce3-b99c-43da-8826-ab9c5574eef2"
url = f"https://api.alayanew.com/v1/nasStorage/instance/{instance_id}"
headers = {
    "accept": "application/json",
    "Authorization": "Bearer [YOUR_API_KEY]"
}

response = requests.get(url, headers=headers)
print(response.json())
const instanceId = '00964ce3-b99c-43da-8826-ab9c5574eef2';

fetch(`https://api.alayanew.com/v1/nasStorage/instance/${instanceId}`, {
  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": {
    "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": "string",
    "price": "0.01B",
    "priceUnit": "8",
    "sharePolicy": {
      "policy": "R"
    },
    "createdBy": "string",
    "createdByName": "string",
    "lastUpdateBy": "string",
    "lastUpdateByName": "string",
    "createScene": "ALab",
    "createSceneInstanceId": "00964ce3-b99c-43da-8826-ab9c5574eef2"
  }
}
{
  "status": 403,
  "message": "Forbidden",
  "data": {}
}
{
  "status": 500,
  "message": "Internal Server Error",
  "data": {}
}

Last updated on