Help Center/ Resource Access Manager/ API Reference/ APIs/ Tag Management/ Deleting Tags from Resource Shares
Updated on 2024-03-15 GMT+08:00

Deleting Tags from Resource Shares

Function

This API is used to delete the specified tags from resource shares.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

POST /v1/resource-shares/{resource_share_id}/tags/delete

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

resource_share_id

Yes

String

ID of the resource share.

Minimum: 0

Maximum: 36

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Security-Token

No

String

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

tags

Yes

Array of Untag objects

List of one or more key-value pairs. The tag key must be specified and cannot be an empty string. The tag value must be specified and can be an empty string.

Array Length: 1 - 20

Table 4 Untag

Parameter

Mandatory

Type

Description

key

Yes

String

Identifier or name of the tag key.

Minimum: 1

Maximum: 128

value

No

String

Tag value. You can set the tag value to an empty string but not null.

Minimum: 0

Maximum: 255

Response Parameters

None

Example Requests

Deleting tags from a resource share

POST https://{hostname}/v1/resource-shares/{resource_share_id}/tags/delete

{
  "tags" : [ {
    "key" : "string",
    "value" : "string"
  } ]
}

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.