接口参考资源标签与备注
读取资源标签和备注
GET /api/v1/resources/{kind}/{id}/metadata,getResourceMetadata 的请求参数和响应结构。
GET /api/v1/resources/{kind}/{id}/metadata
| 项目 | 内容 |
|---|---|
| 操作标识 | getResourceMetadata |
| 认证 | 登录会话 Cookie |
请求参数
| 名称 | 位置 | 必填 | 类型 | 说明与约束 |
|---|---|---|---|---|
| kind | path | 是 | string | 可选值:"instances"、"volumes"、"images"、"storages"、"compute-hosts"、"clusters"、"vpcs"、"subnets"、"security-groups"、"public-ips"、"checkpoints"、"flavors"、"ip-pools"、"backup-policies" |
| id | path | 是 | string | 格式:uuid |
响应
| HTTP 状态 | 含义 |
|---|---|
| 200 | 操作已记录;data.id 为任务 UUID,data.resource_id 为资源 UUID。执行是否完成以任务状态和真实观测为准。 |
| 400 | 请求无法完成 |
| 401 | 请求无法完成 |
| 403 | 请求无法完成 |
| 404 | 请求无法完成 |
| 409 | 请求无法完成 |
| 503 | 请求无法完成 |
200 · application/json 响应结构
| 字段 | 类型 | 必填 | 说明与约束 |
|---|---|---|---|
| data | ResourceMetadata | 是 | — |
| request_id | string | 是 | — |
{
"$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 契约生成。通用资源响应允许的任意字段以运行服务为准,不据此推断尚未定义的字段。
