Skip to main content
API Explorer|API Explorer
Platform O&M/Tag Operations
POSTTag OperationsSince 0.6SynchronousAuth Required

CreateSystemTag

CreateSystemTag

Execution Availability

Try It Out

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

Request Inputs

Body Fields

  • paramsObjectRequired

    Request body parameter object.

    • resourceTypeStringRequired

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

    • resourceUuidStringRequired

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

    • tagStringRequired

      The tag string.

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

  • errorErrorCodeRequired

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

    • codeStringRequired

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

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

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

  • inventorySystemTagInventoryRequired

    See inventory.

    • inherentBooleanRequired

      The inherent system tag.

    • uuidStringRequired

      The resource UUID.

    • resourceUuidStringRequired

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

    • resourceTypeStringRequired

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

    • tagStringRequired

      The tag string.

    • typeStringRequired

      The reserved field for internal use.

    • createDateTimestampRequired

      The creation date.

    • lastOpDateTimestampRequired

      The last operation date.

Endpoint

POST/zstack/v1/system-tags

/zstack/v1/system-tags

Operation ID

CreateSystemTag

Permalink

Request Example

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

Response Example

200
{ "inventory": { "inherent": false, "uuid": "55d86810cb564ecc934fa79d498b9dc3", "resourceType": "HostVO", "tag": "reservedMemory::1G", "type": "System", "createDate": "Apr 24, 2017 7:10:55 PM", "lastOpDate": "Apr 24, 2017 7:10:55 PM" } }

Change History

This API has no change history records yet.

View all change history