Skip to main content
ZStack
Platform O&M/Tag Operations

CreateSystemTag

CreateSystemTag

POST/zstack/v1/system-tags

Operation ID

CreateSystemTag

Since

0.6

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • params
    ObjectRequired

    Request body parameter object.

    • resourceType
      StringRequired

      The resource type, which must be specified when you create a tag.

    • resourceUuid
      StringRequired

      The resource UUID. If specified, the system will not allocate randomly a UUID to the resource.

    • tag
      StringRequired

      The tag string.

  • systemTags
    List

    Optional. The system tags.

  • userTags
    List

    Optional. The user tags.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • error
    ErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see Error.

    • code
      StringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • description
      StringRequired

      The brief description of the error.

    • details
      StringRequired

      The details about the error.

    • elaboration
      StringRequired

      The reserved field. Default value: null.

    • opaque
      LinkedHashMapRequired

      The reserved field. Default value: null.

    • cause
      ErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventory
    SystemTagInventoryRequired

    See inventory.

    • inherent
      BooleanRequired

      The inherent system tag.

    • uuid
      StringRequired

      The resource UUID.

    • resourceUuid
      StringRequired

      The resource UUID. If specified, the system will not allocate randomly a UUID to the resource.

    • resourceType
      StringRequired

      The resource type, which must be specified when you create a tag.

    • tag
      StringRequired

      The tag string.

    • type
      StringRequired

      The reserved field for internal use.

    • createDate
      TimestampRequired

      The creation date.

    • lastOpDate
      TimestampRequired

      The last operation date.