跳转到正文
皓量云擎文档
接口参考资源标签与备注

修改资源标签和备注

PUT /api/v1/resources/{kind}/{id}/metadata,updateResourceMetadata 的请求参数和响应结构。

PUT /api/v1/resources/{kind}/{id}/metadata

项目内容
操作标识updateResourceMetadata
认证登录会话 Cookie

会话写请求需要合法的 Origin 和与当前 Cookie 绑定的 X-CSRF-Token。登录成功后应重新获取 CSRF 令牌。具体权限由目标资源归属和当前授权决定,见认证约定。

请求参数

名称位置必填类型说明与约束
kindpath是string可选值:"instances"、"volumes"、"images"、"storages"、"compute-hosts"、"clusters"、"vpcs"、"subnets"、"security-groups"、"public-ips"、"checkpoints"、"flavors"、"ip-pools"、"backup-policies"
idpath是string格式:uuid

请求体

请求体必填。

内容类型:application/json。

字段类型必填说明与约束
namestring否仅实例可修改显示名称,不联动客户机主机名;最短 1;最长 64
tagsstring[]是资源标签,去除首尾空格并去重;最多 20 项
descriptionstring是最长 1024
完整请求结构(含引用定义)
{
  "$ref": "#/$defs/ResourceMetadataInput",
  "$defs": {
    "ResourceMetadataInput": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "tags",
        "description"
      ],
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 64,
          "description": "仅实例可修改显示名称,不联动客户机主机名"
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 32
          },
          "maxItems": 20,
          "description": "资源标签,去除首尾空格并去重"
        },
        "description": {
          "type": "string",
          "maxLength": 1024
        }
      }
    }
  }
}

响应

HTTP 状态含义
200操作已记录;data.id 为任务 UUID,data.resource_id 为资源 UUID。执行是否完成以任务状态和真实观测为准。
400请求无法完成
401请求无法完成
403请求无法完成
404请求无法完成
409请求无法完成
503请求无法完成
200 · application/json 响应结构
字段类型必填说明与约束
dataResourceMetadata是—
request_idstring是—
{
  "$ref": "#/$defs/ResourceMetadataResponse",
  "$defs": {
    "ResourceMetadataResponse": {
      "type": "object",
      "required": [
        "data",
        "request_id"
      ],
      "properties": {
        "data": {
          "$ref": "#/$defs/ResourceMetadata"
        },
        "request_id": {
          "type": "string"
        }
      }
    },
    "ResourceMetadata": {
      "type": "object",
      "required": [
        "id",
        "name",
        "tags",
        "description"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "name": {
          "type": "string"
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 32
          },
          "maxItems": 20,
          "description": "资源标签,去除首尾空格并去重"
        },
        "description": {
          "type": "string"
        }
      }
    }
  }
}
400 / 401 / 403 / 404 / 409 / 503 · application/json 响应结构
{
  "$ref": "#/$defs/ErrorResponse",
  "$defs": {
    "ErrorResponse": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "error": {
          "$ref": "#/$defs/ErrorDetail"
        },
        "request_id": {
          "type": "string"
        }
      },
      "required": [
        "error",
        "request_id"
      ]
    },
    "ErrorDetail": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "code": {
          "type": "string",
          "enum": [
            "NOT_IMPLEMENTED",
            "NOT_FOUND",
            "AUTH_REQUIRED",
            "FORBIDDEN",
            "VALIDATION_FAILED",
            "CONFLICT",
            "SERVICE_UNAVAILABLE",
            "INTERNAL_ERROR",
            "RATE_LIMITED"
          ]
        },
        "message": {
          "type": "string"
        },
        "retryable": {
          "type": "boolean"
        },
        "fields": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "required": [
        "code",
        "message",
        "retryable"
      ]
    }
  }
}

响应中的 request_id 用于排查请求;异步操作以任务最终状态为准。参阅调用约定、异步任务和错误处理。

本页由版本化 OpenAPI 契约生成。通用资源响应允许的任意字段以运行服务为准,不据此推断尚未定义的字段。

本页目录