跳转到主要内容
API Explorer|API Explorer
运维管理/标签相关接口
POSTTag Management APIs起始版本 3.2.0同步需要认证

加载资源标签

加载资源标签

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

路径参数

请求参数

路径参数

  • tagUuidString必填

    标签UUID

请求体字段

  • paramsObject必填

    请求体参数结构

    • resourceUuidsList必填

      资源UUID

    • tokensMap

      通过标签存放的键和值

  • systemTagsList

    系统标签。

  • userTagsList

    用户标签。

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • resultsList必填

    详情参考results

    • successboolean必填

      操作是否成功。

    • errorErrorCode必填

      详情参考error

      • codeString必填

        错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

      • descriptionString必填

        错误的概要描述

      • detailsString必填

        错误的详细信息

      • elaborationString必填

        保留字段，默认为null

      • opaqueLinkedHashMap必填

        保留字段，默认为null

      • causeErrorCode必填

        根错误，引发当前错误的源错误，若无原错误，该字段为null

    • inventoryUserTagInventory必填

      详情参考inventory

      • tagPatternUuidString必填

        标签模式UUID。

      • uuidString必填

        资源的UUID，唯一标示该资源

      • resourceUuidString必填

        资源UUID。若指定，资源会使用该字段值作为UUID。

      • resourceTypeString必填

        资源类型。

      • tagString必填

        标签。

      • typeString必填

        类型。

        • nameString必填

          资源名称

        • ordinalint必填

          暂无描述。

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

      • tagPatternTagPatternInventory必填

        详情参考tagPattern

        • uuidString必填

          资源的UUID，唯一标示该资源

        • nameString必填

          资源名称

        • valueString必填

          字段值。

        • descriptionString必填

          资源的详细描述

        • colorString必填

          暂无描述。

        • createDateTimestamp必填

          创建时间

        • lastOpDateTimestamp必填

          最后一次修改时间

        • typeTagPatternType必填

          详情参考type

          • nameString必填

            资源名称

          • ordinalint必填

            暂无描述。

请求地址

POST/zstack/v1/tags/{tagUuid}/resources

/zstack/v1/tags/{tagUuid}/resources

操作 ID

AttachTagToResources

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/tags/{tagUuid}/resources' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"resourceUuids":["<resourceUuids>"],"tokens":{}},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "results": [ { "inventory": { "tagPatternUuid": "f9060711c8453a2580f840d7aa1c5485", "uuid": "b2f817b3400232018956a4d2d198edc4", "resourceType": "DiskOfferingVO", "tag": "for-large-DB", "type": "User", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM" }, "success": true } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史