Updated on 2024-12-05 GMT+08:00

Querying Image Tags

Description

Query image tags.

Constraints

None

API Calling

For details, see Calling APIs.

URI

GET /v2/manage/namespaces/{namespace}/repos/{repository}/tags

Table 1 Path parameters

Parameter

Mandatory

Type

Description

namespace

Yes

String

Organization name. Enter 1 to 64 characters, starting with a lowercase letter and ending with a lowercase letter or digit. Only lowercase letters, digits, periods (.), underscores (_), and hyphens (-) are allowed. Periods, underscores, and hyphens cannot be placed next to each other. A maximum of two consecutive underscores are allowed.

repository

Yes

String

Image repository name. Enter 1 to 128 characters. It must start and end with a lowercase letter or digit. Only lowercase letters, digits, periods (.), slashes (/), underscores (_), and hyphens (-) are allowed. Periods, slashes, underscores, and hyphens cannot be placed next to each other. A maximum of two consecutive underscores are allowed. Replace a slash (/) with a dollar sign ($) before you send the request.

Table 2 Query parameters

Parameter

Mandatory

Type

Description

limit

No

String

Number of returned records. Parameters offset and limit should always be used together. If this parameter is not specified, all records will be returned by default.

offset

No

String

Start index. The value must be 0 or a positive number. If this parameter is not specified, all records will be returned by default.

Parameters offset and limit should always be used together.

order_column

No

String

Sorting by column. You can set this parameter to updated_at (sorting by update time) or tag (sorting by tag). Parameters order_column and order_type should always be used together.

order_type

No

String

Sorting order. You can set this parameter to desc (descending order) and asc (ascending order). Parameters order_column and order_type should always be used together.

tag

No

String

Image tag name.

filter

No

String

Set this parameter to offset::{offset}|limit::{limit}|order_column::{order_column}|order_type::{order_type}|tag::{tag}. limit indicates the number of returned records. offset indicates the start index. Parameters offset and limit should always be used together. order_column indicates sorting by column. The value can be updated_at (sorting by update time) or tag (sorting by tag). order_type indicates the sorting order. The value can be desc (descending order) or asc (ascending order). tag indicates the image tag name.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type (format). The value can be application/json;charset=utf-8 application/json

The default value is application/json.

X-Auth-Token

Yes

String

User token.

The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 4 Response header parameter

Parameter

Type

Description

Content-Range

String

Offset (Start index) – Count (Number of records on the current page)/Total (Total number of records)

Table 5 Response body parameter

Parameter

Type

Description

[Array]

Array of ShowReposTagResp objects

Image tag list.

Table 6 ShowReposTagResp

Parameter

Type

Description

id

Long

Tag ID.

repo_id

Long

Repository ID.

Tag

String

Image tag name.

image_id

String

Image ID.

manifest

String

Image manifest.

digest

String

Hash value of an image.

schema

Long

Docker protocol version. The version can be 1 or 2.

path

String

External image pull address, for example, swr.cn-north-1.myhuaweicloud.com/namespace/repository:tag.

internal_path

String

Internal image pull path. For example, 10.125.0.198:20202/namespace/repository:tag.

size

Long

Image size, ranging from 0 to 9,223,372,036,854,775,807.

is_trusted

Boolean

By default, the value is false.

Default value: false

created

String

Time when the image is created. It is the UTC standard time. Users need to calculate the offset based on the local time. For example, GMT+8 is 8 hours ahead the GMT time.

updated

String

Time when an image is updated. It is the UTC standard time. Users need to calculate the offset based on the local time. For example, GMT+8 is 8 hours ahead the GMT time.

deleted

String

Time when an image is deleted. It is the UTC standard time. Users need to calculate the offset based on the local time. For example, GMT+8 is 8 hours ahead the GMT time.

domain_id

String

Account ID.

scanned

Boolean

Whether the image has been scanned.

tag_type

Long

0: manifest; 1: manifest list.

Example Request

GET https://{endpoint}/v2/manage/namespaces/{namespace}/repos/{repository}/tags

Example Response

Status code: 200

The list of image tags is queried successfully.

[ {
  "id" : 0,
  "repo_id" : 0,
  "Tag" : "latest",
  "image_id" : "741f24a795d6d93d7c6edd11780d63c13e16c39615dd9d223378a57a836f2ee6",
  "manifest" : "{\"schemaVersion\":2,\"mediaType\":\"application/vnd.docker.distribution.manifest.v2+json\",\"config\":{\"mediaType\":\"application/vnd.docker.container.image.v1+json\",\"size\":1862,\"digest\":\"sha256:741f24a795d6d93d7c6edd11780d63c13e16c39615dd9d223378a57a836f2ee6\"},\"layers\":[{\"mediaType\":\"application/vnd.docker.image.rootfs.diff.tar.gzip\",\"size\":1292800,\"digest\":\"sha256:8ac8bfaff55af948c796026ee867448c5b5b5d9dd3549f4006d9759b25d4a893\"},{\"mediaType\":\"application/vnd.docker.image.rootfs.diff.tar.gzip\",\"size\":10240,\"digest\":\"sha256:77ddbf3a9fe11e81761a0f9df43a28e3e6f29bbb53c0c8cf71cd7efa69729aed\"}]}",
  "digest" : "sha256:57b605845a6367c34bfb6ea6477f16852f59aa1861a2b51d10ab77ae0a1dc9c3",
  "schema" : 2,
  "path" : "swr.cn-north-1.myhuaweicloud.com/namespace/busybox:latest",
  "internal_path" : "10.125.0.198:20202/namespace/busybox:latest",
  "size" : 1304902,
  "is_trusted" : false,
  "created" : "2018-07-06T06:18:55Z",
  "updated" : "2018-07-06T06:18:55Z",
  "deleted" : null,
  "domain_id" : "050*****************6d70a960",
  "scanned" : false,
  "tag_type" : 0
} ]

Status Codes

Status Code

Description

200

The list of image tags is queried successfully.

400

Request error.

401

Authentication failed.

404

The image repository does not exist.

500

Internal error.

Error Codes

For details, see Error Codes.