• Elastic Volume Service

evs
  1. Help Center
  2. Elastic Volume Service
  3. API Reference
  4. API v2
  5. EVS Tag
  6. Adding or Updating Tags for an EVS Resource (Deprecated)

Adding or Updating Tags for an EVS Resource (Deprecated)

Function

This API is used to add or update tags for an EVS resource.

This API has been deprecated. Use another API. For details, see Batch Adding Tags for the Specified EVS Disk.

Constraints

  • A tag is composed of a key-value pair.
    • Key:
      • Must be unique for each resource.
      • Can contain a maximum of 36 characters.
      • Can contain only digits, letters, hyphens (-), and underscores (_).
    • Value:
      • Can contain a maximum of 43 characters.
      • Can contain only digits, letters, hyphens (-), and underscores (_).
  • A maximum of 10 tags can be created for an EVS resource.

URI

  • URI format

    POST /v2/{project_id}/os-vendor-tags/{resource_type}/{resource_id}

  • Parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID.

    resource_type

    Yes

    Specifies the resource type. The value can be volumes, snapshots, or backups.

    resource_id

    Yes

    Specifies the resource ID.

Request

  • Parameter description

    Parameter

    Type

    Mandatory

    Description

    tags

    map

    Yes

    Specifies the key-value pair of the tag.

  • Description of the request header parameter

    Parameter

    Type

    Mandatory

    Description

    Content-Type

    map

    Yes

    Specifies the type. The value can be application/json.

  • Example request
    {  
         "tags" : { 
            "key_0" : "value_0", 
            "key_1" : "value_1"  
         } 
    }
NOTE:

If the request body contains an existing key of the EVS resource, the original tag containing this key will be overwritten. For example, "key_1":"val_1" is an existing tag of the EVS resource. If the request body contains "key_1":"val_11", the tag of key_1 for this EVS resource is "key_1":"val_11".

Response

  • Parameter description

    Parameter

    Type

    Description

    tags

    map

    Specifies the key-value pair of the tag.

  • Example response
    {  
         "tags" : { 
            "key_0" : "value_0", 
            "key_1" : "value_1"  
         } 
    }

    or

    {
        "error": {
            "message": "XXXX", 
            "code": "XXX"
        }
    }

    In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:

    {
        "badRequest": {
            "message": "Invalid tags: Tags property value contains invalid characters.", 
            "code": 400
        }
    }

Returned Values

  • Normal

    200

Error Codes

For details, see Error Codes.