Querying All Tags of Resource Pools

Function

This API is used to query all tags of a resource pool in the current project. By default, all workspaces are queried. Tag data is not returned for workspaces on which the user does not have permission.

URI

GET /v1/{project_id}/pools/tags

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID and Name.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Maximum number of records returned on each page. The default value is 200.

Minimum: 1

Default: 200

offset

No

Integer

Start page for pagination display. The default value is 0.

Minimum: 0

Default: 0

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

tags

Tag object

Resource tag list

Table 4 Tag

Parameter

Type

Description

key

String

Tag key

Minimum: 1

Maximum: 128

value

String

Tag value

Minimum: 0

Maximum: 255

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error codes of ModelArts

error_msg

String

Error message

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error codes of ModelArts

error_msg

String

Error message

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error codes of ModelArts

error_msg

String

Error message

Example Requests

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

Example Responses

Status code: 200

Querying all tags of a specified resource type in a project

{
  "tags" : [ {
    "key" : "model_version",
    "values" : [ "0.1", "0.2" ]
  }, {
    "key" : "conda_version",
    "values" : [ "10.2", "11.0" ]
  } ]
}

Status Codes

Status Code

Description

200

Querying all tags of a specified resource type in a project

400

Invalid parameter.

401

Authentication failed.

403

Insufficient permission.

Error Codes

See Error Codes.