Querying the Brief Information on an Image Repository
Function
This API is used to query the brief information required for an image repository.
Constraints
None
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
swr:repo:getRepo
Read
repo *
-
-
-
URI
GET /v2/manage/namespaces/{namespace}/repos/{repository}
| 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. The name contains 1 to 128 characters, starting and ending 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. If the parameter value contains a slash (/), replace it with a dollar sign ($) before sending the request. |
Request 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 the user token. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| id | Long | Repository ID |
| ns_id | Long | Organization ID |
| name | String | Repository name |
| category | String | Repository category. (This parameter is to be replaced with labels. One image can have multiple labels.) |
| description | String | Repository description |
| creator_id | String | Repository creator ID |
| creator_name | String | Repository creator |
| size | Long | Repository size |
| is_public | Boolean | Whether the repository is public. When the value is true, it indicates the repository is public. When the value is false, it indicates the repository is private. |
| num_images | Long | Number of images in the repository, ranging from 0 to 9,223,372,036,854,775,807. |
| num_download | Long | Download times |
| url | String | URL of the repository logo (not in use) |
| path | String | Image pull path. The format is swr.example.com/namespace/repository. |
| internal_path | String | Internal image pull address, for example, 10.125.0.198:20202/namespace/repository. |
| created | String | Time when a repository 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 a repository 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. |
| domain_id | String | Account ID. |
| priority | Integer | Image sorting priority |
Example Requests
GET https://{endpoint}/v2/manage/namespaces/{namespace}/repos/{repository} Example Responses
Status code: 200
{
"id" : 0,
"ns_id" : 0,
"name" : "busybox",
"category" : "other",
"description" : "containerops",
"creator_id" : "1",
"creator_name" : "admin",
"size" : 2099575,
"is_public" : false,
"num_images" : 0,
"num_download" : 0,
"url" : "",
"path" : "swr.example.com/namespace/repository",
"internal_path" : "10.125.0.198:20202/namespace/repository",
"created" : "2017-08-17T12:00:03.915153267Z",
"updated" : "2017-08-17T12:00:03.915153267Z",
"domain_id" : "da44776c316c4a99b3683bb174f8821b",
"priority" : 0
} Status Codes
| Status Code | Description |
|---|---|
| 200 | The request is successfully sent. |
| 400 | An request error occurred. |
| 401 | The authentication failed. |
| 404 | The image repository does not exist. |
| 500 | An internal error occurred. |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot