Skip to main content
API Explorer|API Explorer
O&M Management/Tag Management APIs
POSTTag Management APIsSince 3.2.0SynchronousAuth Required

Attach Tag to Resources

Attach Tag to Resources

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • tagUuidStringRequired

    Tag UUID

Body Fields

  • paramsObjectRequired

    Request body parameter object.

    • resourceUuidsListRequired

      Resource UUID

    • tokensMap

      Keys and values stored through the tag

  • systemTagsList

    系统标签。

  • userTagsList

    用户标签。

Responses

200 OK

On success, this API returns the following response structure.

  • successbooleanRequired

    操作是否成功。

  • errorErrorCodeRequired

    Error code. If not null, the operation failed. This field is null when the operation succeeds. For details, see error

    • codeStringRequired

      The error code number, a globally unique identifier for the error, e.g., SYS.1000, HOST.1001

    • descriptionStringRequired

      A brief description of the error

    • detailsStringRequired

      The detailed error information

    • elaborationStringRequired

      Reserved field. Defaults to null

    • opaqueLinkedHashMapRequired

      Reserved field. Defaults to null

    • causeErrorCodeRequired

      The root error, the cause of the current error. This field is null if there is no root error

  • resultsListRequired

    For details, see results

    • successbooleanRequired

      操作是否成功。

    • errorErrorCodeRequired

      For details, see error

      • codeStringRequired

        The error code number, a globally unique identifier for the error, e.g., SYS.1000, HOST.1001

      • descriptionStringRequired

        A brief description of the error

      • detailsStringRequired

        The detailed error information

      • elaborationStringRequired

        Reserved field. Defaults to null

      • opaqueLinkedHashMapRequired

        Reserved field. Defaults to null

      • causeErrorCodeRequired

        The root error, the cause of the current error. This field is null if there is no root error

    • inventoryUserTagInventoryRequired

      For details, see inventory

      • tagPatternUuidStringRequired

        标签模式UUID。

      • uuidStringRequired

        The resource UUID, uniquely identifying this resource

      • resourceUuidStringRequired

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

      • resourceTypeStringRequired

        资源类型。

      • tagStringRequired

        标签。

      • typeStringRequired

        类型。

        • nameStringRequired

          Resource name

        • ordinalintRequired

          No description provided.

      • createDateTimestampRequired

        Creation time

      • lastOpDateTimestampRequired

        Last modification time

      • tagPatternTagPatternInventoryRequired

        For details, see tagPattern

        • uuidStringRequired

          The resource UUID, uniquely identifying this resource

        • nameStringRequired

          Resource name

        • valueStringRequired

          字段值。

        • descriptionStringRequired

          Detailed description of the resource

        • colorStringRequired

          No description provided.

        • createDateTimestampRequired

          Creation time

        • lastOpDateTimestampRequired

          Last modification time

        • typeTagPatternTypeRequired

          For details, see type

          • nameStringRequired

            Resource name

          • ordinalintRequired

            No description provided.

Endpoint

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

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

Operation ID

AttachTagToResources

Permalink

Request Example

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>"]}'

Response Example

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 } ] }

Change History

This API has no change history records yet.

View all change history