Help Center/ IAM Identity Center/ API Reference/ API/ Tag Management/ Listing Tags for the Specified Resource
Updated on 2024-04-10 GMT+08:00

Listing Tags for the Specified Resource

Function

This API is used to list the tags that are attached to the specified resource. Currently, tags can only be attached to permission sets.

URI

GET /v1/instances/{resource_type}/{resource_id}/tags

Table 1 Path parameters

Parameter

Mandatory

Type

Description

resource_type

Yes

String

Resource type

Enumerated value:

  • identitycenter:permissionset (permission set)

resource_id

Yes

String

Unique ID of a permission set

Maximum length: 130

Table 2 Query parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Maximum number of results returned for each request

Minimum value: 1

Maximum value: 100

Default value: 100

marker

No

String

Pagination marker

Minimum length: 24

Maximum length: 24

Request Parameters

Table 3 Parameters in the request header

Parameter

Mandatory

Type

Description

X-Security-Token

No

String

Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.

Maximum length: 2048

Response Parameters

Status code: 200

Table 4 Parameters in the response body

Parameter

Type

Description

tags

Array of objects

List of tags

page_info

Object

Pagination information

Table 5 tags

Parameter

Type

Description

key

String

Tag key

Minimum length: 1

Maximum length: 128

value

String

Tag value, which can be empty but cannot be null

Minimum length: 0

Maximum length: 255

Table 6 page_info

Parameter

Type

Description

next_marker

String

If present, it indicates that the available output is more than the output contained in the current response. Use this value in the marker request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the next_marker response element comes back as null.

current_count

Integer

Number of records returned on the current page.

Status code: 400

Table 7 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

request_id

String

Unique ID of a request

Status code: 403

Table 8 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

request_id

String

Unique ID of a request

Example Request

Listing the tags that are attached to the specified resource

GET https://{hostname}/v1/instances/{resource_type}/{resource_id}/tags

Example Response

Status code: 200

Successful.

{
  "tags" : [ {
    "key" : "auto09230Uv5key",
    "value" : "auto0923XXFmvalue"
  } ],
  "page_info" : {
    "next_marker" : "5f13d2346712e4890abc5678",
    "current_count" : 10
  }
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.