Get tag

Prev Next

Available in Classic and VPC

Get a tag added to a User Created policy.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET /api/v1/policies/{policyId}/tags

Request headers

For information about the headers common to all Sub Account APIs, see Sub Account request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
policyId String Required Policy ID

Request example

The request example is as follows:

curl --location --request GET 'https://subaccount.apigw.ntruss.com/api/v1/policies/3fe20b30-****-****-****-246e96591594/tags' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
tagKey String - Tag key
tagValue String - Tag value
tagDisplay String - Display tag
  • Display in the {tagKey}:{tagValue} form

Response status codes

For information about the HTTP status codes common to all Sub Account APIs, see Sub Account status codes.

Response example

The response example is as follows:

[
    {
        "tagKey": "1",
        "tagValue": "TAG",
        "tagDisplay": "1:TAG"
    }
]