Querying the Image Repository List (V3)

Description

This API is used to list the image repositories.

This API is only available in the following regions:

CN North-Ulanqab1, CN South-Guangzhou-InvitationOnly, CN South-Shenzhen, CN East-Qingdao, AP-Manila, TR-Istanbul, CN-Hong Kong, AP-Singapore, AP-Jakarta, CN North-Beijing1, CN North-Beijing2, CN North-Beijing4, CN East-Shanghai1, CN East-Shanghai2, CN East2, CN North-Ulanqab1, CN Southwest-Guiyang1, ME-Riyadh, CN South-Guangzhou, LA-Santiago, AP-Bangkok, LA-Sao Paulo1, LA-Mexico City1, and LA-Mexico City2

API Calling

For details, see Calling APIs.

URI

GET /v3/manage/repos

**Table 1** Query parameters
Parameter	Mandatory	Type	Description
namespace	No	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.
name	No	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.
category	No	String	Repository type. The value can be app_server, linux, framework_app, database, lang, windows, arm, or other.
limit	No	Integer	The maximum number of image repositories on each page. The default value is 100. A maximum of 1,000 image repositories can be returned.
marker	No	Integer	Start marker of the pagination query. The value of nextMarker returned by the API is the start marker of the next query.
is_public	No	Boolean	Whether a repository is public or private. The value true indicates public, and false indicates private.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Message body type (format). Possible values: application/json;charset=utf-8 application/json
X-Auth-Token	Yes	String	User token. It 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 a token.

Response Parameters

Status code: 200

**Table 3** Response body parameter
Parameter	Type	Description
nextMarker	Integer	Start ID for the next pagination query. If this parameter is not returned, the data has been queried.
repos	Array of ShowRepoRespV3 objects	-

**Table 4** ShowRepoRespV3
Parameter	Type	Description
id	Long	Repository ID.
name	String	Repository name.
category	String	Repository type.
description	String	Repository description.
size	Long	Repository size.
is_public	Boolean	Whether a repository is a public repository.
num_images	Long	Number of images in a repository, ranging from 0 to 9,223,372,036,854,775,807.
num_download	Long	Repository downloads.
created_at	String	Time when a repository was created. It is the UTC standard time. Users need to calculate the offset based on the local time, for example, UTC+8:00 for the East 8th Time Zone.
updated_at	String	Time when a repository was updated. It is the UTC standard time. Users need to calculate the offset based on the local time, for example, UTC+8:00 for the East 8th Time Zone.
domain_name	String	Tenant name of a repository.
namespace_name	String	Name of the organization that a repository belongs to.
status	Boolean	Whether the image shared by others has expired. This field is not returned when the repository information of the current user is obtained.

Example Request

None

Example Response

Status code: 200

The repository list has been queried.

{
  "repos" : [ {
    "id" : 1,
    "name" : "nginx",
    "category" : "linux",
    "size" : 200977474,
    "is_public" : false,
    "num_images" : 2,
    "num_download" : 0,
    "created_at" : "2017-01-01T00:00:00Z",
    "updated_at" : "2017-09-11T03:00:02.542841141Z",
    "domain_name" : "root",
    "namespace_name" : "root"
  } ],
  "nextMarker" : 1
}