修改存储实例描述

修改指定 NAS 存储实例的描述信息，仅更新备注用途的 description 字段，不影响存储容量、挂载路径等配置。实例 ID 可从存储实例列表获取，修改后可通过实例详情查看新描述。

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

鉴权（Authorizations）

bearerAuth

AuthorizationString必填

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

Path Parameters

idString必填

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

Request body

application/json

descriptionString

存储实例的新描述，长度 0~100 个字符。传空字符串可清空原有描述。例如：这是一个测试描述。

Response

application/json · 200

statusInteger

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

messageString

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

dataObject

修改操作无业务返回数据，固定为空对象 {}。

curl -X 'PUT' \
  'https://api.alayanew.com/v1/nasStorage/instance/00964ce3-b99c-43da-8826-ab9c5574eef2/description' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer [YOUR_API_KEY]' \
  -d '{
  "description": "这是一个测试描述"
}'

import requests

instance_id = "00964ce3-b99c-43da-8826-ab9c5574eef2"
url = f"https://api.alayanew.com/v1/nasStorage/instance/{instance_id}/description"
headers = {
    "accept": "application/json",
    "Content-Type": "application/json",
    "Authorization": "Bearer [YOUR_API_KEY]"
}
payload = {"description": "这是一个测试描述"}

response = requests.put(url, headers=headers, json=payload)
print(response.json())

const instanceId = '00964ce3-b99c-43da-8826-ab9c5574eef2';
const payload = { description: '这是一个测试描述' };

fetch(`https://api.alayanew.com/v1/nasStorage/instance/${instanceId}/description`, {
  method: 'PUT',
  headers: {
    'accept': 'application/json',
    'Content-Type': 'application/json',
    'Authorization': 'Bearer [YOUR_API_KEY]'
  },
  body: JSON.stringify(payload)
})
  .then(res => res.json())
  .then(console.log)
  .catch(console.error);

{
  "status": 200,
  "message": "OK",
  "data": {}
}

{
  "status": 403,
  "message": "Forbidden",
  "data": {}
}

{
  "status": 500,
  "message": "Internal Server Error",
  "data": {}
}