Help Center/ VPC Endpoint/ API Reference (Paris Region)/ APIs/ Tag Function/ Querying Tags of a Tenant's Resource
Updated on 2024-03-14 GMT+08:00

Querying Tags of a Tenant's Resource

Function

This API is used to obtain tags of resources of a tenant based on the tenant ID and resource type.

URI

GET /v1/{project_id}/{resource_type}/tags

Table 1 describes parameters in this URI.

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

resource_type

Yes

String

Specifies the resource type, which can be endpoint_service or endpoint.

Request

  • Parameter description

    None

  • Example request
    GET https://{endpoint}/v1/{project_id}/endpoint_service/tags

    or

    GET https://{endpoint}/v1/{project_id}/endpoint/tags

Response

  • Parameter description
    Table 2 Response parameter

    Parameter

    Mandatory

    Type

    Description

    tags

    Yes

    List<resource_tag>

    Lists the tags.

    Table 3 Data structure of field resource_tag

    Parameter

    Mandatory

    Type

    Description

    key

    Yes

    String

    Specifies the tag key.

    values

    Yes

    List<String>

    Specifies the tag value list.

  • Example response
    {
        "tags": [
            {
                "key": "key1",
                "values": [
                    "*value1",
                    "value2"
                ]
            }
        ]
    }

Status Codes

See Status Codes.