If an error occurs in API calling, no result is returned. Identify the causes of errors based on the error codes of each API. If an error occurs in API calling, HTTP status code 4xx or 5xx is returned. The response body contains the specific error code and information.
Format of an Error Response Body
If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.
[ @@ -25,7 +25,7 @@- SVCSTG.SWR.4010000
Authentication failed.
+Authentication failed. Obtain a new token and try again.
500
@@ -123,7 +123,7 @@- SVCSTG.SWR.4000014
Invalid parameter.
+Invalid API parameter. Modify the request body based on the returned message and the SWR API documentation, or contact technical support.
400
@@ -1131,7 +1131,7 @@- SVCSTG.SWR.4011064
Cross-account error. Insufficient permissions.
+Insufficient permissions.
400
diff --git a/docs/swr/api-ref/swr_02_0026.html b/docs/swr/api-ref/swr_02_0026.html index 81a822a7..c68847a5 100644 --- a/docs/swr/api-ref/swr_02_0026.html +++ b/docs/swr/api-ref/swr_02_0026.html @@ -5,72 +5,104 @@-URI
POST /v2/manage/namespaces
Request
- Request parameters -
Table 1 Request body parameter description Parameter
+- -Request Parameters
+-
Table 1 Request header parameters - - Parameter
Mandatory
+- Mandatory
Type
+- Type
Description
+Description
namespace
++ - Content-Type
Yes
+- Yes
String
+- 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.
++ 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.
- Example request
-Create an organization named group:
-POST https://{Endpoint}/v2/manage/namespaces-Body:
-{ - "namespace": "group" -}-Status Code
-
Status Code
+ ++ ++
Table 2 Request body parameter - - Parameter
Description
++ Mandatory
++ Type
+Description
201
+- - namespace
Creation successful.
++ 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.
+ 400
++Response Parameters
N/A
++Example Request
POST https://{endpoint}/v2/manage/namespaces + +{ + "namespace" : "group" +}++Example Response
N/A
+-Status Code
+
+ + + Status Code
++ Description
+- - 201
The request is incorrect or the number of organizations exceeds the upper limit.
+Creation successful.
401
+- - 400
Authentication failed.
+The request is incorrect or the number of organizations exceeds the upper limit.
409
+- - 401
The resource already exists.
+Authentication failed.
500
++ - 409
Internal error.
++ The resource already exists.
+@@ -80,7 +112,7 @@ + 500
+Internal error.
diff --git a/docs/swr/api-ref/swr_02_0027.html b/docs/swr/api-ref/swr_02_0027.html index a6291eec..e3604fa6 100644 --- a/docs/swr/api-ref/swr_02_0027.html +++ b/docs/swr/api-ref/swr_02_0027.html @@ -22,16 +22,47 @@-Parent topic: API+Parent topic: Organization Management- String
Organization name
+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.
Request
+Request Parameters
++
Table 2 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.
+@@ -74,7 +105,7 @@Response
N/A
diff --git a/docs/swr/api-ref/swr_02_0028.html b/docs/swr/api-ref/swr_02_0028.html index 7a9e3856..0e8aaa14 100644 --- a/docs/swr/api-ref/swr_02_0028.html +++ b/docs/swr/api-ref/swr_02_0028.html @@ -3,97 +3,143 @@-Parent topic: API+Parent topic: Organization ManagementQuerying the List of Organizations
-Function
Query the list of organizations.
URI
GET /v2/manage/namespaces?filter=namespace::{namespace}
-For details about parameters, see Table 1.
+URI
GET /v2/manage/namespaces
-
Table 1 Parameter description Parameter
+-
Table 1 Query parameters - - Parameter
Mandatory
+- Mandatory
Type
+- Type
Description
+Description
namespace
++ - namespace
No
+- No
String
+- String
Organization name
++ 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.
++ filter
++ No
++ String
+Enter namespace::{namespace}|mode::{mode}. {namespace} indicates the organization name. If {mode} is not set, the list of authorized organizations is displayed. If {mode} is set to visible, the list of visible organizations is displayed. (Some organizations can be viewed by the repository, but cannot by the organization.)
-Request
-Response
- Response parameters -
Table 2 Response body parameter description Parameter
++Request Parameters
+++
Table 2 Request header parameters - - Parameter
Type
+- Mandatory
Description
++ Type
+Description
namespaces
++ - Content-Type
Array of objects
+- Yes
Organization list
++ String
++ Message body type (format). The value can be application/json or 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 an IAM API. The value of X-Subject-Token in the response header is the user token.
++
By default, all organizations will be returned.
+Response Parameters
+-
Table 3 Response body parameter description + + + Parameter
++ Type
++ Description
++ namespaces
++ Array of objects
+Organization list
Table 3 namespaces parameter description Parameter
+-
Table 4 namespaces parameter description - - Parameter
Type
+- Type
Description
+Description
ID
+- - ID
Integer
+- Integer
Organization ID
+Organization ID
name
+- - name
String
+- String
Organization name
+Organization name
creator_name
+- - creator_name
String
+- String
IAM username
+IAM username
auth
+- auth
Integer
+- Integer
User permission
+User permission
- 7: Manage
- 3: Write
- 1: Read
- Example response
{ + ++Example Request
GET https://{Endpoint}/v2/manage/namespaces?namespace=group+Example Response
Status code: 200
+The list of organizations is returned successfully.
+{ "namespaces": [ { "id": 1343008, @@ -103,48 +149,49 @@ } ] }-- -Status Code
-
Status Code
++
- - Status Code
Description
+Description
200
+- - 200
Query succeeded.
+Query succeeded.
400
+- - 400
Request error.
+Request error.
401
+- - 401
Authentication failed.
+Authentication failed.
404
+- - 404
The organization does not exist.
+The organization does not exist.
500
+- 500
Internal error.
+Internal error.
Error Codes
For details, see Error Codes.
+diff --git a/docs/swr/api-ref/swr_02_0029.html b/docs/swr/api-ref/swr_02_0029.html index 0f3a6ca0..34430ca5 100644 --- a/docs/swr/api-ref/swr_02_0029.html +++ b/docs/swr/api-ref/swr_02_0029.html @@ -29,99 +29,135 @@-Parent topic: API+Parent topic: Organization ManagementResponse
- Response parameters -
Table 2 Response body parameter description Parameter
++Request Parameters
+++
Table 2 Request header parameters - - Parameter
Type
+- Mandatory
Description
++ Type
+Description
id
+- - Content-Type
Integer
+- Yes
Organization ID
++ String
+Message body type (format). The value can be application/json or charset=utf-8 application/json.
+The default value is application/json.
name
+- - X-Auth-Token
String
+- Yes
Organization name
++ String
+User token.
+The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
+ creator_name
++Response Parameters
Status code: 200 ++-
Table 3 Response body parameter description + + + Parameter
++ Type
++ Description
+- - id
String
+- Integer
IAM username
+Organization ID
auth
++ - name
Integer
+- String
User permission
++ Organization name
++ + creator_name
++ String
++ IAM username
++ auth
++ Integer
+User permission
- 7: Manage
- 3: Write
- 1: Read
- Example response
{ ++Example Request
GET https://{Endpoint}/v2/manage/namespaces/group+Example Response
{ "id": 1422, "name": "group", "creator_name": "username", "auth": 7 }--Status Code
-
Status Code
++
- - Status Code
Description
+Description
200
+- - 200
Query succeeded.
+Query succeeded.
400
+- - 400
Request error.
+Request error.
401
+- - 401
Authentication failed.
+Authentication failed.
404
+- - 404
The organization does not exist.
+The organization does not exist.
500
+- 500
Internal error.
+Internal error.
Error Codes
For details, see Error Codes.
+diff --git a/docs/swr/api-ref/swr_02_0030.html b/docs/swr/api-ref/swr_02_0030.html index 5ad86ca4..e9e73965 100644 --- a/docs/swr/api-ref/swr_02_0030.html +++ b/docs/swr/api-ref/swr_02_0030.html @@ -30,119 +30,146 @@-Parent topic: API+Parent topic: Organization ManagementRequest
- Request parameters -
Table 2 FormData parameter description Parameter
+Request Parameters
+-
Table 2 Request header parameters - - Parameter
Mandatory
+- Mandatory
Type
+- Type
Description
+Description
repository
+- - Content-Type
Yes
+- Yes
String
+- String
Image repository name.
-Enter 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.
+Message body type (format). The value can be application/json or charset=utf-8 application/json.
+The default value is application/json.
category
+- - X-Auth-Token
No
+- Yes
String
+- String
- Repository type.
-The value can be app_server, linux, framework_app, database, lang, other, windows or arm.
-- - description
-- No
-- String
-- Brief description of the image repository.
-- is_public
-- Yes
-- Boolean
-Whether the repository is a public repository. When the value is true, it indicates the repository is public. When the value is false, it indicates the repository is private.
+User token.
+The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
- Example request
+ +POST https://{Endpoint}/v2/manage/namespaces/group/repos-Body:
--F "repository=busybox" \ --F "category=linux" \ --F "description=this is a busybox repository" \ --F "is_public=true"-Or
-{ - "repository": "busybox", - "category": "linux", - "description": "this is a busybox repository", - "is_public": true -}--The form format will no longer be supported soon. You are advised to use the body in the JSON format to call the API.
-- +
Table 3 Request body parameters + + + Parameter
++ Mandatory
++ Type
++ Description
++ + repository
++ Yes
++ String
++ Image repository name. An image repository name contains 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.
++ + is_public
++ Yes
++ Boolean
++ Whether the repository is public. true indicates that the repository is public. false indicates that the repository is private.
++ + category
++ No
++ String
++ Repository type. The value can be app_server, linux, framework_app, database, lang, arm, or other.
++ + + description
++ No
++ String
++ Brief description of the image repository.
++Response Parameters
None
++Example Request
POST https://{endpoint}/v2/manage/namespaces/{namespace}/repos + +{ + "repository" : "busybox", + "category" : "linux", + "description" : "this is a busybox repository", + "is_public" : true +}+Example Response
None
-Status Code
-
Status Code
++
- - Status Code
Description
+Description
201
+- - 201
Creation successful.
+Creation successful.
400
+- - 400
Request error. Error information is returned.
+Request error. Error information is returned.
401
+- - 401
Authentication failed.
+Authentication failed.
409
+- - 409
The repository already exists.
+The repository already exists.
500
+- 500
Internal error. Error information is returned.
+Internal error. Error information is returned.
Error Codes
For details, see Error Codes.
+diff --git a/docs/swr/api-ref/swr_02_0031.html b/docs/swr/api-ref/swr_02_0031.html index 1c22ee34..a7214a17 100644 --- a/docs/swr/api-ref/swr_02_0031.html +++ b/docs/swr/api-ref/swr_02_0031.html @@ -38,57 +38,94 @@-Parent topic: API+Parent topic: Image Repository Management-Request
--Response
N/A
-Status Code
-
Status Code
++Request Parameters
+
Table 2 Request header parameters - - Parameter
Description
++ Mandatory
++ Type
+Description
204
+- - Content-Type
The brief information about the image repository is successfully deleted.
++ Yes
++ String
+Message body type (format). The value can be application/json or charset=utf-8 application/json.
+The default value is application/json.
400
+- - X-Auth-Token
Request error. Error information is returned.
+- Yes
- 401
+- String
- Authentication failed.
-- - 404
-- The repository does not exist.
-- - 406
-- The repository cannot be deleted because it contains images.
-- 500
-Internal error. Error information is returned.
+User token.
+The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
+Response Parameters
None
++Example Request
DELETE https://{endpoint}/v2/manage/namespaces/{namespace}}/repos/{repository}++Example Response
None
++Status Code
+++
+ + + Status Code
++ Description
++ + 204
++ The brief information about the image repository is successfully deleted.
++ + 400
++ Request error. Error information is returned.
++ + 401
++ Authentication failed.
++ + 404
++ The repository does not exist.
++ + 406
++ The repository cannot be deleted because it contains images.
++ + + 500
++ Internal error. Error information is returned.
+Error Codes
For details, see Error Codes.
+diff --git a/docs/swr/api-ref/swr_02_0032.html b/docs/swr/api-ref/swr_02_0032.html index 1788ad65..85d717bf 100644 --- a/docs/swr/api-ref/swr_02_0032.html +++ b/docs/swr/api-ref/swr_02_0032.html @@ -6,126 +6,168 @@-Parent topic: API+Parent topic: Image Repository ManagementURI
PATCH /v2/manage/namespaces/{namespace}/repos/{repository}
For details about parameters, see Table 1.
-
Table 1 Parameter description Parameter
+-
Table 1 Path parameters - - Parameter
Mandatory
+- Mandatory
Type
+- Type
Description
+Description
namespace
+- - namespace
Yes
+- Yes
String
+- String
Organization name.
+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
+- - repository
Yes
+- Yes
String
+- String
- Image repository name.
-- - category
-- No
-- String
-- Repository type.
-The value can be app_server, linux, framework_app, database, lang, other, windows or arm.
-- - description
-- No
-- String
-- Repository description.
-- is_public
-- No
-- Boolean
-Whether the repository is a public repository. The value can be either true or false.
+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.
Request
+
- Request parameters -
- Example request
PATCH https://{Endpoint}/v2/manage/namespaces/group/repos/busybox-Body:
--F "category=linux" \ --F "description=this is a busybox repository" \ --F "is_public=false"-Or
-{ - "category": "linux", - "description": "this is a busybox repository", - "is_public": false -}--The form format will no longer be supported soon. You are advised to use the body in the JSON format to call the API.
-Request Parameters
+-
Table 2 Request header parameters + + + Parameter
++ Mandatory
++ Type
++ Description
++ + Content-Type
++ Yes
++ String
++ Message body type (format). The value can be application/json or 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 an IAM API. The value of X-Subject-Token in the response header is the user token.
++Response
+ +++
Table 3 Request body parameters + + + Parameter
++ Mandatory
++ Type
++ Description
++ + is_public
++ Yes
++ Boolean
++ Whether the repository is public. true indicates that the repository is public. false indicates that the repository is private.
++ + category
++ No
++ String
++ Repository type. The value can be app_server, linux, framework_app, database, lang, arm, or other.
++ + + description
++ No
++ String
++ Brief description of the image repository.
++Response Parameters
None
++Example Request
PATCH https://{endpoint}/v2/manage/namespaces/{namespace}/repos/{repository} + +{ + "category" : "database", + "description" : "this is a busybox repository", + "is_public" : false +}+Example Response
None
+Status Code
-
Status Code
++
- - Status Code
Description
+Description
201
+- - 201
The brief information about the image repository is successfully updated.
+The brief information about the image repository is successfully updated.
400
+- - 400
Request error. Error information is returned.
+Request error. Error information is returned.
401
+- - 401
Authentication failed.
+Authentication failed.
404
+- - 404
The repository does not exist.
+The repository does not exist.
500
+- 500
Internal error. Error information is returned.
+Internal error. Error information is returned.
Error Codes
For details, see Error Codes.
+diff --git a/docs/swr/api-ref/swr_02_0033.html b/docs/swr/api-ref/swr_02_0033.html index deef8754..1aef3f6a 100644 --- a/docs/swr/api-ref/swr_02_0033.html +++ b/docs/swr/api-ref/swr_02_0033.html @@ -76,7 +76,7 @@-Parent topic: API+Parent topic: Image Repository Management- String
Image repository type. The value can be app_server, linux, framework_app, database, lang, other, windows, or arm.
+Image repository type. The value can be app_server, linux, framework_app, database, lang, arm, or other.
description
@@ -238,10 +238,12 @@Error Codes
For details, see Error Codes.
+diff --git a/docs/swr/api-ref/swr_02_0034.html b/docs/swr/api-ref/swr_02_0034.html index d0d7e498..68320beb 100644 --- a/docs/swr/api-ref/swr_02_0034.html +++ b/docs/swr/api-ref/swr_02_0034.html @@ -3,95 +3,98 @@-Parent topic: API+Parent topic: Image Repository ManagementQuerying the Image Repository List
-Function
Query the image repository list.
URI
GET /v2/manage/repos?filter=center::self|namespace::{namespace}|name::{name}|category::{category}|offset::{offset}|limit::{limit}|order_column::{order_column}|order_type::{order_type}
-For details about parameters, see Table 1.
-+
At least one filter parameter must be transferred.
-URI
GET /v2/manage/repos
-
Table 1 Parameter description Parameter
++
Table 1 Query parameters - - Parameter
Mandatory
+- Mandatory
Type
+- Type
Description
+Description
center
+- - namespace
No
+- No
String
+- String
The value can only be self, indicating that the image is a self-owned image.
+Organization name. An organization name contains 1 to 64 characters. It must start with a lowercase letter and end 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.
namespace
+- - name
No
+- No
String
+- String
Organization name.
+Image repository name.
name
+- - category
No
+- No
String
+- String
Image repository name.
+Repository type. The value can be app_server, linux, framework_app, database, lang, arm, or other.
category
+- - limit
No
+- No
String
+- String
Image repository type. The value can be app_server, linux, framework_app, database, lang, other, windows, or arm.
+Number of returned records. Parameters offset and limit should always be used together. If this parameter is not specified, 100 records will be returned by default.
offset
+- - offset
No
+- No
String
+- String
Start index.
-Ensure that the offset and limit parameters are used together.
+Start index. The value can be 0 or a positive integer multiple of the limit value. If this parameter is not specified, the start index is 0 by default.
+Parameters offset and limit should always be used together.
limit
+- - order_column
No
+- No
String
+- String
Number of returned records.
-Ensure that the offset and limit parameters are used together.
+Sorting by column. You can set this parameter to updated_at (sorting by update time). Parameters order_column and order_type should always be used together.
order_column
+- - order_type
No
+- No
String
+- String
Sorting criteria. The value can be name, updated_time, or tag_count.
-Ensure that the order_column and order_type parameters are used together.
+Sorting type. You can set this parameter to desc (descending sort) or asc (ascending sort). Parameters order_column and order_type should always be used together.
order_type
+@@ -99,7 +102,7 @@ - filter
No
+- No
String
+- String
Sorting type. You can set this parameter to desc (descending sort) and asc (ascending sort).
-Ensure that the order_column and order_type parameters are used together.
+Pass at least one of the following filter parameters:
+namespace: organization name. It supports fuzzy match.
+name: image repository name. It supports fuzzy match.
+category: image repository type. The value can be app_server, linux, framework_app, database, lang, arm, or other.
+limit: number of returned records.
+offset: the start index.
+Parameters offset and limit should always be used together.
+order_column: sorting by column. It can be set to name, updated_time, or tag_count.
+order_type: sorting type. It can be set to desc (descending order) or asc (ascending order).
+Parameters order_column and order_type should always be used together.
Request
Response
- Response parameters @@ -115,7 +118,7 @@
- String
Offset (Start index)–Count (Number of records on the current page)/Total (Total number of records)
+@@ -162,7 +165,7 @@ Offset (Start index) – Count (Number of records on the current page)/Total (Total number of records)
- String
Image repository type. The value can be app_server, linux, framework_app, database, lang, other, windows, or arm.
+Image repository type. The value can be app_server, linux, framework_app, database, lang, arm, or other.
description
@@ -246,7 +249,7 @@- String
Account name.
+Domain name.
namespace
@@ -338,10 +341,12 @@Error Codes
For details, see Error Codes.
+diff --git a/docs/swr/api-ref/swr_02_0035.html b/docs/swr/api-ref/swr_02_0035.html index cbd2ff1a..719d6b1c 100644 --- a/docs/swr/api-ref/swr_02_0035.html +++ b/docs/swr/api-ref/swr_02_0035.html @@ -3,7 +3,7 @@-Parent topic: API+Parent topic: Image Repository ManagementQuerying the List of Image Repository Tags
-Function
Query all image tags of an image repository.
URI
GET /v2/manage/namespaces/{namespace}/repos/{repository}/tags?filter=offset::{offset}|limit::{limit}|order_column::{order_column}|order_type::{order_type}|tag::{tag}
+-URI
GET /v2/manage/namespaces/{namespace}/repos/{repository}/tags?offset={offset}&limit={limit}&order_column={order_column}&order_type={order_type}&tag={tag}
For details about parameters, see Table 1.
+ +
Table 2 Query parameters + + + Parameter
++ Mandatory
++ Type
++ Description
+- - limit
No
+- No
Integer
+- String
Start index.
+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.
limit
+- - offset
No
+- No
Integer
+- String
Number of responses.
+Start index. The value can be 0 or a positive integer multiple of the limit value. If this parameter is not specified, all records will be returned by default.
+Parameters offset and limit should always be used together.
order_column
+- - order_column
No
+- No
String
+- String
Sorting by column. You can set this parameter to updated_at (sorting by update time).
+Sorting by column. You can set this parameter to updated_at (sorting by update time). Parameters order_column and order_type should always be used together.
order_type
+- - order_type
No
+- No
String
+- String
Sorting type. You can set this parameter to desc (descending sort) and asc (ascending sort).
+Sorting type. You can set this parameter to desc (descending sort) or asc (ascending sort). Parameters order_column and order_type should always be used together.
tag
++ - tag
No
+- No
String
+- String
Image tag name.
++ 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, which can be updated_at (sorting by update time). order_type indicates the sorting type, which can be desc (descending order) or asc (ascending order). tag indicates the image tag name.
-Request
-+Response
- Response parameters -
Table 2 Response body parameter description Parameter
++Request
+
- Request parameters +
++
Table 3 Request header parameters - - Parameter
Type
+- Mandatory
Description.
++ Type
+Description
[Array element]
++ - Content-Type
Array of objects
+- Yes
Image repository tag list.
++ String
++ Message body type (format). The value can be application/json or 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 an IAM API. The value of X-Subject-Token in the response header is the user token.
+- Example request
GET https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/tags+-Response
- Response parameters + +
-
Table 4 Response header parameters + + + Parameter
++ Type
++ Description
++ Content-Range
++ String
+Offset (Start index) – Count (Number of records on the current page)/Total (Total number of records)
Table 3 [Array element] parameters description Parameter
++ ++
Table 5 Response body parameters - - Parameter
Type
+- Type
Description
+Description
id
+- - [Array]
Integer
+- Array of ShowReposTagResp objects
ID
+Image tags.
+ repo_id
++
Table 6 [Array element] parameters description + + + Parameter
++ Type
++ Description
+- - id
Integer
+- Integer
Repository ID.
+ID
Tag
+- - repo_id
String
+- Integer
Image tag name.
+Repository ID.
image_id
+- - Tag
String
+- String
Image ID.
+Image tag name.
manifest
+- - image_id
String
+- String
Image manifest.
+Image ID.
digest
+- - manifest
String
+- String
SHA value of an image.
+Image manifest.
schema
+- - digest
Integer
+- String
Docker protocol version. The version can be 1 or 2.
+SHA value of an image.
path
+- - schema
String
+- Integer
External image pull address. The format is {Repository address}/{Namespace name}/{Repository name}:{Tag name}.
+Docker protocol version. The version can be 1 or 2.
internal_path
+- - path
String
+- String
Internal image pull address. The format is {Repository address}/{Namespace name}/{Repository name}:{Tag name}.
+External image pull address. The format is {Repository address}/{Namespace name}/{Repository name}:{Tag name}.
size
++ - internal_path
Integer
+- String
Image size.
++ Internal image pull address. The format is {Repository address}/{Namespace name}/{Repository name}:{Tag name}.
+- + size
++ Integer
+Image size.
Value range: 0 to 9223372036854775807
Unit: byte
is_trusted
+- - is_trusted
Boolean
+- Boolean
By default, the value is false.
+By default, the value is false.
created
+- - created
String
+- String
Time when an 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.
+Time when an image is created. It is the UTC standard time. You need to calculate the offset based on the local time. For example, GMT+8 is 8 hours ahead of GMT.
updated
+- - updated
String
+- 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.
+Time when an image is updated. It is the UTC standard time. You need to calculate the offset based on the local time. For example, GMT+8 is 8 hours ahead of GMT.
deleted
+- - deleted
String
+- String
Time when an image was deleted.
+Time when an image was deleted.
domain_id
+- - domain_id
String
+- String
Account ID.
+Account ID.
tag_type
+@@ -290,10 +367,12 @@ - tag_type
Integer
+- Integer
0: manifest. 1: manifest list.
+0: manifest. 1: manifest list.
Error Codes
For details, see Error Codes.
+diff --git a/docs/swr/api-ref/swr_02_0036.html b/docs/swr/api-ref/swr_02_0036.html index 334834c2..6b2f86fe 100644 --- a/docs/swr/api-ref/swr_02_0036.html +++ b/docs/swr/api-ref/swr_02_0036.html @@ -47,7 +47,40 @@-Parent topic: API+Parent topic: Image Tag ManagementRequest
- Request parameters +
@@ -89,10 +122,12 @@Request
- Request parameters +
+
Table 2 Request header parameters + + + Parameter
++ Mandatory
++ Type
++ Description
++ + Content-Type
++ Yes
++ String
++ Message body type (format). The value can be application/json or 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 an IAM API. The value of X-Subject-Token in the response header is the user token.
+- Example request
DELETE https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/tags/v1Error Codes
For details, see Error Codes.
+diff --git a/docs/swr/api-ref/swr_02_0042.html b/docs/swr/api-ref/swr_02_0042.html index 9ae3d3f0..cd240c68 100644 --- a/docs/swr/api-ref/swr_02_0042.html +++ b/docs/swr/api-ref/swr_02_0042.html @@ -3,26 +3,28 @@-Parent topic: API+Parent topic: Image Tag ManagementCreating Organization Permissions
+Function
Grant permissions of an organization to certain users so that they can manage, edit, and read images from the organization.
Constraints
None
+URI
POST /v2/manage/namespaces/{namespace}/access
Table 1 describes the parameters.
-
Table 1 Parameter description Parameter
+
Table 1 Parameter description - - Parameter
Mandatory
+- Mandatory
Type
+- Type
Description
+Description
namespace
+@@ -30,130 +32,164 @@ - namespace
Yes
+- Yes
String
+- String
Organization name.
+Organization name.
Request
- Request parameters -
Table 2 Request body description Parameter
+-
Table 2 Request header parameters - - Parameter
Mandatory
+- Mandatory
Type
+- Type
Description
+Description
[Array element]
++ - Content-Type
Yes
+- Yes
Array of objects
+- String
Information required for creating organization permissions.
++ Message body type (format). The value can be application/json or 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 an IAM API. The value of X-Subject-Token in the response header is the user token.
Table 3 [Array element] Parameter
++ ++
Table 3 Request body parameters - - Parameter
Mandatory
+- Mandatory
Type
+- Type
Description
+Description
user_id
+- - [Array element]
Yes
+- Yes
String
+- Array of objects
User ID.
+Information required for creating organization permissions.
+ user_name
+-
Table 4 [Array element] + + + Parameter
++ Mandatory
++ Type
++ Description
+- - user_id
Yes
+- Yes
String
+- String
Username.
+User ID. Obtain it from IAM.
auth
++ - user_name
Yes
+- Yes
Integer
+- String
User permission
++ Username. Obtain it from IAM.
++ auth
++ Yes
++ Integer
+User permission
- 7: Manage
- 3: Write
- 1: Read
- Example request
POST https://{Endpoint}/v2/manage/namespaces/group/access-Body:
-[ - { - "user_id": "fb3f175c1fd146ab8cdae3272be6107b", - "user_name": "user01", - "auth": 1 - } -]+- Example request
POST https://{endpoint}/v2/manage/namespaces/{namespace}/access + +[ { + "user_id" : "fb3f175c1fd146ab8cdae3272be6107b", + "user_name" : "user01", + "auth" : 1 +} ]Status Code
-
Status Code
++
- - Status Code
Description
+Description
201
+- - 201
Creation successful.
+Creation successful.
400
+- - 400
Request error.
+Request error.
401
+- - 401
Authentication failed.
+Authentication failed.
404
+- - 404
The organization does not exist.
+The organization does not exist.
409
+- - 409
The organization permission already exists.
+The organization permission already exists.
500
+- 500
Internal error.
+Internal error.
Error Codes
For details, see Error Codes.
+diff --git a/docs/swr/api-ref/swr_02_0043.html b/docs/swr/api-ref/swr_02_0043.html index a902068e..a4d443e7 100644 --- a/docs/swr/api-ref/swr_02_0043.html +++ b/docs/swr/api-ref/swr_02_0043.html @@ -30,31 +30,65 @@-Parent topic: API+Parent topic: Organization Permission Management+Request
- Request parameters -
Table 2 Request body parameter description Parameter
+-
Table 2 Request header parameters - - Parameter
Mandatory
+- Mandatory
Type
+- Type
Description
+Description
[Array element]
++ - Content-Type
Yes
+- Yes
Array of strings
+- String
ID array of users whose permissions need to be deleted.
++ Message body type (format). The value can be application/json or 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 an IAM API. The value of X-Subject-Token in the response header is the user token.
- Example request
DELETE https://{Endpoint}/v2/manage/namespaces/group/access-Body:
-["fb3f175c1fd146ab8cdae3272be6107b"]+ +++
Table 3 Request body parameter description + + + Parameter
++ Mandatory
++ Type
++ Description
++ + + [Array element]
++ Yes
++ Array of strings
++ ID list of users whose permissions need to be deleted. Obtain the list from IAM.
+- Example request
DELETE https://{Endpoint}/v2/manage/namespaces/group/access + +["fb3f175c1fd146ab8cdae3272be6107b"]Response
N/A
@@ -95,10 +129,12 @@Error Codes
For details, see Error Codes.
+diff --git a/docs/swr/api-ref/swr_02_0044.html b/docs/swr/api-ref/swr_02_0044.html index 11b57537..1a5a8ba3 100644 --- a/docs/swr/api-ref/swr_02_0044.html +++ b/docs/swr/api-ref/swr_02_0044.html @@ -30,79 +30,111 @@-Parent topic: API+Parent topic: Organization Permission Management-Request
- Request parameters -
Table 2 Request body parameter description Parameter
+-
Table 2 Request header parameters - - Parameter
Mandatory
+- Mandatory
Type
+- Type
Description
+Description
[Array element]
++ - Content-Type
Yes
+- Yes
Array of objects
+- String
Information required for updating organization permissions
++ Message body type (format). The value can be application/json or 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 an IAM API. The value of X-Subject-Token in the response header is the user token.
+
Table 3 [Array element] Parameter
++ ++
Table 3 Request body parameter description - - Parameter
Mandatory
+- Mandatory
Type
+- Type
Description
+Description
user_id
+- - [Array element]
Yes
+- Yes
String
+- Array of objects
User ID.
+Information required for updating organization permissions
+ user_name
+-
Table 4 [Array element] + + + Parameter
++ Mandatory
++ Type
++ Description
+- - user_id
Yes
+- Yes
String
+- String
Username.
+User ID. Obtain it from IAM.
auth
++ - user_name
Yes
+- Yes
Integer
+- String
User permission
++ Username. Obtain it from IAM.
++ auth
++ Yes
++ Integer
+User permission
- 7: Manage
- 3: Write
- 1: Read
- Example request
PATCH https://{Endpoint}/v2/manage/namespaces/group/access-Body:
-[ - { - "user_id": "fb3f175c1fd146ab8cdae3272be6107b", - "user_name": "user01", - "auth": 7 - } -]+- Example request
PATCH https://{endpoint}/v2/manage/namespaces/{namespace}/access + +[ { + "user_id" : "fb3f175c1fd146ab8cdae3272be6107b", + "user_name" : "user01", + "auth" : 7 +} ]Error Codes
For details, see Error Codes.
+diff --git a/docs/swr/api-ref/swr_02_0045.html b/docs/swr/api-ref/swr_02_0045.html index c6e55a05..e1a9b4fe 100644 --- a/docs/swr/api-ref/swr_02_0045.html +++ b/docs/swr/api-ref/swr_02_0045.html @@ -29,124 +29,124 @@-Parent topic: API+Parent topic: Organization Permission Management-Request
-Response
- Response parameters -
Table 2 Response body parameters Parameter
++Request
+
- Request parameters +
++
Table 2 Request header parameters - - Parameter
Type
+- Mandatory
Description
++ Type
+Description
id
+- - Content-Type
Integer
+- Yes
Permission ID.
++ String
+Message body type (format). The value can be application/json or charset=utf-8 application/json.
+The default value is application/json.
name
+- - X-Auth-Token
String
+- Yes
Organization name.
++ String
+User token.
+The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
+ creator_name
+- Example request
GET https://{Endpoint}/v2/manage/namespaces/group/access+Response
- Response parameters
Status code: 200 ++-
Table 3 Response body parameters + + + Parameter
++ Type
++ Description
+- - id
String
+- Integer
Organization creator.
+Permission ID.
self_auth
+- - name
+ - String
Permissions of the current user.
+Organization name.
others_auths
++ - creator_name
Array of objects
+- String
Permissions of other users.
++ Organization creator.
++ + self_auth
++ ++ Permissions of the current user.
++ others_auths
++ Array of objects
+Permissions of other users.
Error Codes
For details, see Error Codes.
+diff --git a/docs/swr/api-ref/swr_02_0046.html b/docs/swr/api-ref/swr_02_0046.html index ef6c5a3a..ed0a7f92 100644 --- a/docs/swr/api-ref/swr_02_0046.html +++ b/docs/swr/api-ref/swr_02_0046.html @@ -39,83 +39,115 @@-Parent topic: API+Parent topic: Organization Permission ManagementRequest
- Request parameters -
Table 2 Request body parameter description Parameter
+-
Table 2 Request header parameters - - Parameter
Mandatory
+- Mandatory
Type
+- Type
Description.
+Description
[Array element]
++ - Content-Type
Yes
+- Yes
Array of objects
+- String
User list
++ Message body type (format). The value can be application/json or 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 an IAM API. The value of X-Subject-Token in the response header is the user token.
+
Table 3 [Array element] parameters decription Parameter
++ ++
Table 3 Request body parameter description - - Parameter
Mandatory
+- Mandatory
Type
+- Type
Description
+Description.
user_id
+- - [Array element]
Yes
+- Yes
String
+- Array of objects
User ID.
+User list
+ user_name
+-
Table 4 [Array element] parameters decription + + + Parameter
++ Mandatory
++ Type
++ Description
+- - user_id
Yes
+- Yes
String
+- String
Username.
+User ID.
auth
++ - user_name
Yes
+- Yes
Integer
+- String
User permission that is configured.
++ Username.
++ auth
++ Yes
++ Integer
+User permission that is configured.
- 7: Manage
- 3: Write
- 1: Read
- Example request
POST https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/access-Body:
-[ - { - "user_id": "fb3f175c1fd146ab8cdae3272be6107b", - "user_name": "user01", - "auth": 1 - } -]+- Example request
POST https://{endpoint}/v2/manage/namespaces/{namespace}/repos/{repository}/access + +[ { + "user_id" : "fb3f175c1fd146ab8cdae3272be6107b", + "user_name" : "user01", + "auth" : 1 +} ]Status Code
@@ -154,10 +186,12 @@Error Codes
For details, see Error Codes.
+diff --git a/docs/swr/api-ref/swr_02_0047.html b/docs/swr/api-ref/swr_02_0047.html index 35f3caf9..d5284f17 100644 --- a/docs/swr/api-ref/swr_02_0047.html +++ b/docs/swr/api-ref/swr_02_0047.html @@ -3,35 +3,37 @@-Parent topic: API+Parent topic: Image Permission ManagementDeleting Image Permissions
+Function
Delete the image operation permissions of certain users.
Constraints
None
+URI
DELETE /v2/manage/namespaces/{namespace}/repos/{repository}/access
For details about parameters, see Table 1.
-
Table 1 Parameter description Parameter
+
Table 1 Parameter description - - Parameter
Mandatory
+- Mandatory
Type
+- Type
Description
+Description
namespace
+- - namespace
Yes
+- Yes
String
+- String
Organization name.
+Organization name.
repository
+@@ -39,75 +41,111 @@ - repository
Yes
+- Yes
String
+- String
Image name.
+Image name.
Request
- Request parameters -
Table 2 Request body parameter description Parameter
+-
Table 2 Request header parameters - - Parameter
Mandatory
+- Mandatory
Type
+- Type
Description
+Description
[Array element]
++ - Content-Type
Yes
+- Yes
Array of strings
+- String
ID array of users whose permissions need to be deleted.
++ Message body type (format). The value can be application/json or 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 an IAM API. The value of X-Subject-Token in the response header is the user token.
- Example request
DELETE https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/access-Body:
-["fb3f175c1fd146ab8cdae3272be6107b"]+ +++
Table 3 Request body parameter description + + + Parameter
++ Mandatory
++ Type
++ Description
++ + + [Array element]
++ Yes
++ Array of strings
++ ID array of users whose permissions need to be deleted.
+- Example request
DELETE https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/access + +[ "fb3f175c1fd146ab8cdae3272be6107b" ]Response
N/A
Status Code
-
Status Code
++
- - Status Code
Description
+Description
204
+- - 204
Deleted successfully.
+Deletion succeeded.
400
+- - 400
Request error.
+Request error.
401
+- - 401
Authentication failed.
+Authentication failed.
404
+- - 404
The image does not exist.
+The image does not exist.
500
+- 500
Internal error.
+Internal error.
Error Codes
For details, see Error Codes.
+diff --git a/docs/swr/api-ref/swr_02_0048.html b/docs/swr/api-ref/swr_02_0048.html index 6fdfd7dd..7b03e173 100644 --- a/docs/swr/api-ref/swr_02_0048.html +++ b/docs/swr/api-ref/swr_02_0048.html @@ -3,35 +3,37 @@-Parent topic: API+Parent topic: Image Permission ManagementUpdating Image Permissions
+Function
Update the image operation permissions for certain users.
Constraints
None
+URI
PATCH /v2/manage/namespaces/{namespace}/repos/{repository}/access
For details about parameters, see Table 1.
-
Table 1 Parameter description Parameter
+
Table 1 Parameter description - - Parameter
Mandatory
+- Mandatory
Type
+- Type
Description
+Description
namespace
+- - namespace
Yes
+- Yes
String
+- String
Organization name
+Organization name
repository
+@@ -39,102 +41,159 @@ - repository
Yes
+- Yes
String
+- String
Image name
+Image name
Request
- Request parameters -
Table 2 Request body parameter description Parameter
++ ++
Table 2 Request header parameters - - Parameter
Mandatory
+- Mandatory
Type
+- Type
Description
+Description
user_id
+- - Content-Type
Yes
+- Yes
String
+- String
User ID.
+Message body type (format). The value can be application/json or charset=utf-8 application/json.
+The default value is application/json.
user_name
+- - X-Auth-Token
Yes
+- Yes
String
+- String
Username.
+User token.
+The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
+ auth
++ ++
Table 3 Request body parameter description + + + Parameter
++ Mandatory
++ Type
++ Description
++ + - [Array element]
Yes
+- Yes
Integer
+- Array of objects
User permission that is configured.
++ Information about the image permission to be updated.
+-
Table 4 [Array element] parameter description + + + Parameter
++ Mandatory
++ Type
++ Description
++ + user_id
++ Yes
++ String
++ User ID. Obtain it from IAM.
++ + user_name
++ Yes
++ String
++ Username. Obtain it from IAM.
++ auth
++ Yes
++ Integer
+User permission that is configured.
- 7: Manage
- 3: Write
- 1: Read
- Example request
PATCH https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/access-Body:
-[ - { - "user_id": "fb3f175c1fd146ab8cdae3272be6107b", - "user_name": "user01", - "auth": 7 - } -]+- Example request
PATCH https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/access + +[ { + "user_id" : "fb3f175c1fd146ab8cdae3272be6107b", + "user_name" : "user01", + "auth" : 7 +} ]Status Code
-
Status Code
++
- - Status Code
Description
+Description
201
+- - 201
Updated successfully.
+Updated successfully.
400
+- - 400
Request error.
+Request error.
401
+- - 401
Authentication failed.
+Authentication failed.
404
+- - 404
The image or the image permission does not exist.
+The image or the image permission does not exist.
500
+- 500
Internal error.
+Internal error.
Error Codes
For details, see Error Codes.
+diff --git a/docs/swr/api-ref/swr_02_0049.html b/docs/swr/api-ref/swr_02_0049.html index 9b86ccc9..b53ac7e3 100644 --- a/docs/swr/api-ref/swr_02_0049.html +++ b/docs/swr/api-ref/swr_02_0049.html @@ -3,113 +3,148 @@-Parent topic: API+Parent topic: Image Permission ManagementQuerying Image Permissions
+Function
Query image permissions.
Constraints
None
+URI
GET /v2/manage/namespaces/{namespace}/repos/{repository}/access
For details about parameters, see Table 1.
-
Table 1 Parameter description Parameter
+-
Table 1 Parameter description - - Parameter
Mandatory
+- Mandatory
Type
+- Type
Description
+Description
namespace
+- - namespace
Yes
+- Yes
String
+- String
Organization name
+Organization name
repository
+- repository
Yes
+- Yes
String
+- String
Image name
+Image name
Request
- Request parameters +
Request
- Request parameters +
+
Table 2 Request header parameters + + + Parameter
++ Mandatory
++ Type
++ Description
++ + Content-Type
++ Yes
++ String
++ Message body type (format). The value can be application/json or 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 an IAM API. The value of X-Subject-Token in the response header is the user token.
+- Example request
GET https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/accessResponse
- Response parameters -
Table 2 Response body parameter description Parameter
+-
Table 3 Response body parameter description - - Parameter
Type
+- Type
Description
+Description
id
+- - id
Integer
+- Integer
Permission ID.
+Permission ID.
name
+- - name
String
+- String
Image name.
+Image name.
self_auth
+- - self_auth
+ - Permissions of the current user.
+Permissions of the current user.
others_auths
+- others_auths
Array of objects
+- Array of objects
Permissions of other users.
+Permissions of other users.
Table 3 self_auth parameter description Parameter
+-
Table 4 self_auth parameter description - - Parameter
Type
+- Type
Description
+Description
user_id
+- - user_id
String
+- String
User ID
+User ID
user_name
+- - user_name
String
+- String
Username
+Username
auth
+@@ -117,33 +152,33 @@ - auth
Integer
+- Integer
User permission
+User permission
- 7: Manage
- 3: Write
- 1: Read
Table 4 others_auths parameter description Parameter
+
Table 5 others_auths parameter description - - Parameter
Type
+- Type
Description
+Description
user_id
+- - user_id
String
+- String
User ID
+User ID
user_name
+- - user_name
String
+- String
Username
+Username
auth
+@@ -169,45 +204,47 @@ - auth
Integer
+- Integer
User permission
+User permission
- 7: Manage
- 3: Write
- 1: Read
+Status Code
-
- Status Code
++
- - Status Code
Description
+Description
200
+- - 200
Query succeeded.
+Query succeeded.
400
+- - 400
Request error.
+Request error.
401
+- - 401
Authentication failed.
+Authentication failed.
404
+- - 404
The image or the image permission does not exist.
+The image or the image permission does not exist.
500
+- 500
Internal error.
+Internal error.
Error Codes
For details, see Error Codes.
+diff --git a/docs/swr/api-ref/swr_02_0064.html b/docs/swr/api-ref/swr_02_0064.html index 708286e3..e842c5f1 100644 --- a/docs/swr/api-ref/swr_02_0064.html +++ b/docs/swr/api-ref/swr_02_0064.html @@ -8,7 +8,12 @@-Parent topic: API+Parent topic: Image Permission Management2021-08-30
++ + 2024-10-12
++ +
- Updated URIs, example requests, parameter descriptions, and other information.
- Classified APIs based on their functions.
2021-08-30
diff --git a/docs/swr/api-ref/swr_02_0070.html b/docs/swr/api-ref/swr_02_0070.html index 936b8652..8fdf6a16 100644 --- a/docs/swr/api-ref/swr_02_0070.html +++ b/docs/swr/api-ref/swr_02_0070.html @@ -1,7 +1,7 @@ Optimized the whole document, including optimizing the function introduction, adding request examples, and improving parameter descriptions.
Creating an Account Used for Image Sharing
-Function
Create an account used for image sharing. You can share your private images with other users, granting them permissions to pull the images.
+Function
Create an account used for image sharing. You can share your private images with other users, granting them permissions to pull the images.
URI
POST /v2/manage/namespaces/{namespace}/repositories/{repository}/access-domains
For details about parameters, see Table 1.
@@ -22,7 +22,7 @@- String
Organization name
+Organization name. An organization name contains 1 to 64 characters. It must start with a lowercase letter and end 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
@@ -39,50 +39,84 @@-Request
- Request parameters -
Table 2 Request body parameter description Parameter
++ ++
Table 2 Request header parameters - - Parameter
Mandatory
+- Mandatory
Type
+- Type
Description
+Description
access_domain
+- - Content-Type
Yes
+- Yes
String
+- String
Name of the account used for image sharing.
+Message body type (format). The value can be application/json or charset=utf-8 application/json.
+The default value is application/json.
permit
+- - X-Auth-Token
Yes
+- Yes
String
+- String
Currently, only the read permission is supported.
+User token.
+The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
+ deadline
++
Table 3 Request body parameter description + + + Parameter
++ Mandatory
++ Type
++ Description
+- - access_domain
Yes
+- Yes
String
+- String
Valid until (UTC). If the sharing is permanent, the value is forever. Otherwise, the sharing is valid until 00:00:00 of the next day.
+Name of the account used for image sharing.
description
++ - permit
No
+- Yes
String
+- String
Description.
++ Currently, only the read permission is supported.
++ + deadline
++ Yes
++ String
++ Valid until (UTC). If the sharing is permanent, the value is forever. Otherwise, the sharing is valid until 00:00:00 of the next day.
+@@ -99,7 +133,7 @@ + description
++ No
++ String
+Description.
Status Code
@@ -138,10 +172,12 @@Error Codes
For details, see Error Codes.
+diff --git a/docs/swr/api-ref/swr_02_0071.html b/docs/swr/api-ref/swr_02_0071.html index b67128f3..66bbedce 100644 --- a/docs/swr/api-ref/swr_02_0071.html +++ b/docs/swr/api-ref/swr_02_0071.html @@ -22,7 +22,7 @@-Parent topic: API+Parent topic: Shared Account Management- String
Organization name.
+Organization name. An organization name contains 1 to 64 characters. It must start with a lowercase letter and end 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
@@ -47,7 +47,40 @@Request
- Request parameters +
@@ -84,10 +117,12 @@Request
- Request parameters +
+
Table 2 Request header parameters + + + Parameter
++ Mandatory
++ Type
++ Description
++ + Content-Type
++ Yes
++ String
++ Message body type (format). The value can be application/json or 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 an IAM API. The value of X-Subject-Token in the response header is the user token.
+- Example request
DELETE https://{Endpoint}/v2/manage/namespaces/group/repositories/busybox/access-domains/domain_nameError Codes
For details, see Error Codes.
+diff --git a/docs/swr/api-ref/swr_02_0072.html b/docs/swr/api-ref/swr_02_0072.html index d57860ec..ff7209ba 100644 --- a/docs/swr/api-ref/swr_02_0072.html +++ b/docs/swr/api-ref/swr_02_0072.html @@ -48,41 +48,75 @@-Parent topic: API+Parent topic: Shared Account Management-Request
- Request parameters -
Table 2 Request body parameter description Parameter
++ ++
Table 2 Request header parameters - - Parameter
Mandatory
+- Mandatory
Type
+- Type
Description
+Description
permit
+- - Content-Type
Yes
+- Yes
String
+- String
Currently, only the read permission is supported.
+Message body type (format). The value can be application/json or charset=utf-8 application/json.
+The default value is application/json.
deadline
+- - X-Auth-Token
Yes
+- Yes
String
+- String
Valid until (UTC). If the sharing is permanent, the value is forever. Otherwise, the sharing is valid until 00:00:00 of the next day.
+User token.
+The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
+ description
+-
Table 3 Request body parameter description + + + Parameter
++ Mandatory
++ Type
++ Description
++ - permit
No
+- Yes
String
+- String
Description. This parameter is left blank by default.
++ Currently, only the read permission is supported.
++ + deadline
++ Yes
++ String
++ Valid until (UTC). If the sharing is permanent, the value is forever. Otherwise, the sharing is valid until 00:00:00 of the next day.
+@@ -133,7 +167,7 @@ + description
++ No
++ String
+Description. This parameter is left blank by default.
diff --git a/docs/swr/api-ref/swr_02_0073.html b/docs/swr/api-ref/swr_02_0073.html index a2b5b970..1192fb34 100644 --- a/docs/swr/api-ref/swr_02_0073.html +++ b/docs/swr/api-ref/swr_02_0073.html @@ -47,107 +47,141 @@-Parent topic: API+Parent topic: Shared Account Management-Request
-+Response
- Response parameters -
Table 2 Response body parameter description Parameter
++Request
+
- Request parameters +
++
Table 2 Request header parameters - - Parameter
Type
+- Mandatory
Description
++ Type
+Description
exist
+- - Content-Type
Boolean
+- Yes
true: Exist. false: Not exist.
++ String
+Message body type (format). The value can be application/json or charset=utf-8 application/json.
+The default value is application/json.
namespace
+- - X-Auth-Token
String
+- Yes
Organization name.
++ String
+User token.
+The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
+ repository
+- Example request
GET https://{Endpoint}/v2/manage/namespaces/group/repositories/busybox/access-domains/domain_name+Response
- Response parameters
Status code: 200 ++
Table 3 Response body parameter description + + + Parameter
++ Type
++ Description
+- - exist
String
+- Boolean
Image repository name.
+true: Exist. false: Not exist.
access_domain
+- - namespace
String
+- String
Name of the account used for image sharing.
+Organization name.
permit
+- - repository
String
+- String
Permission.
+Image repository name.
deadline
+- - access_domain
String
+- String
Expiration time.
+Name of the account used for image sharing.
description
+- - permit
String
+- String
Description.
+Permission.
creator_id
+- - deadline
String
+- String
Creator ID.
+Expiration time.
creator_name
+- - description
String
+- String
Name of the creator.
+Description.
created
+- - creator_id
String
+- String
Time when an image is created. It is the UTC standard time.
+Creator ID.
updated
+- - creator_name
String
+- String
Time when an image is updated. It is the UTC standard time.
+Name of the creator.
status
++ - created
Boolean
+- String
Status.
++ Time when an image is created. It is the UTC standard time.
++ + updated
++ String
++ Time when an image is updated. It is the UTC standard time.
++ status
++ Boolean
+Status.
true: valid. false: expired.
- Example response
{ "exist": true, "namespace": "group", @@ -195,10 +229,12 @@Error Codes
For details, see Error Codes.
+diff --git a/docs/swr/api-ref/swr_02_0074.html b/docs/swr/api-ref/swr_02_0074.html index d5daf355..db1bd45a 100644 --- a/docs/swr/api-ref/swr_02_0074.html +++ b/docs/swr/api-ref/swr_02_0074.html @@ -22,7 +22,7 @@-Parent topic: API+Parent topic: Shared Account Management- String
Organization name
+Organization name. An organization name contains 1 to 64 characters. It must start with a lowercase letter and end 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
@@ -38,95 +38,148 @@-Request
-Response
- Response parameters -
Table 2 Response body parameter description Parameter
++Request
+
- Request parameters +
++
Table 2 Request header parameters - - Parameter
Type
+- Mandatory
Description
++ Type
+Description
namespace
+- - Content-Type
String
+- Yes
Organization name.
++ String
+Message body type (format). The value can be application/json or charset=utf-8 application/json.
+The default value is application/json.
repository
+- - X-Auth-Token
String
+- Yes
Image repository name.
++ String
+User token.
+The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
+ access_domain
+- Example request
GET https://{Endpoint}/v2/manage/namespaces/group/repositories/busybox/access-domains++By default, 100 records will be returned.
+Response
- Response parameters +
+ ++
Table 3 Response body parameter description + + + Parameter
++ Type
++ Description
+- - [Array element]
String
+- Array of objects
Name of the account used for image sharing.
+Shared accounts.
+ permit
+
Table 4 [Array element] parameter description + + + Parameter
++ Type
++ Description
+- - namespace
String
+- String
Permission.
+Organization name.
deadline
+- - repository
String
+- String
Expiration time.
+Image repository name.
description
+- - access_domain
String
+- String
Description.
+Name of the account used for image sharing.
creator_id
+- - permit
String
+- String
Creator ID.
+Permission.
creator_name
+- - deadline
String
+- String
Name of the creator.
+Expiration time.
created
+- - description
String
+- String
Time when an image is created. It is the UTC standard time.
+Description.
updated
+- - creator_id
String
+- String
Time when an image is updated. It is the UTC standard time.
+Creator ID.
status
++ - creator_name
Boolean
+- String
Status.
-true: valid. false: expired.
++ Name of the creator.
++ + created
++ String
++ Time when an image was created. It is the UTC standard time. You 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 was updated. It is the UTC standard time. You need to calculate the offset based on the local time. For example, GMT+8 is 8 hours ahead the GMT time.
+@@ -150,40 +203,42 @@ + status
++ Boolean
+Status. true: valid; false: expired
Status Code
-
Status Code
++
- - Status Code
Description
+Description
200
+- - 200
The list of image sharing account is queried successfully.
+The list of image sharing accounts is returned successfully.
400
+- - 400
Request error. Error information is returned.
+Request error. Error information is returned.
401
+- - 401
Authentication failed.
+Authentication failed.
500
+- 500
Internal error. Error information is returned.
+Internal error. Error information is returned.
Error Codes
For details, see Error Codes.
+diff --git a/docs/swr/api-ref/swr_02_0075.html b/docs/swr/api-ref/swr_02_0075.html index eb46a09c..10732252 100644 --- a/docs/swr/api-ref/swr_02_0075.html +++ b/docs/swr/api-ref/swr_02_0075.html @@ -3,53 +3,89 @@-Parent topic: API+Parent topic: Shared Account ManagementViewing the List of Shared Images
-Function
View the list of shared images.
URI
GET /v2/manage/shared-repositories?filter=center::{center}|name::{name}|limit::{limit}|offset::{offset}
-For details about parameters, see Table 1.
+URI
GET /v2/manage/shared-repositories
-
Table 1 Parameter description Parameter
+
Table 1 Query parameters - - Parameter
Mandatory
+- Mandatory
Type
+- Type
Description
+Description
center
+- - namespace
Yes
+- No
String
+- String
+
- self: images shared by you.
- thirdparty: images shared with you by others.
Organization name. An organization name contains 1 to 64 characters. It must start with a lowercase letter and end 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
+- - name
No
+- No
String
+- String
Image repository name.
+Image repository name.
limit
+- - center
No
+- No
String
+- String
Number of returned records. Ensure that the offset and limit parameters are used together.
+self: images shared by you thirdparty: images shared with you by others.
offset
++ - limit
No
+- No
String
+- String
Start index. Ensure that the offset and limit parameters are used together.
++ Number of returned records. Ensure that the offset and limit parameters are used together. If this parameter is not specified, all records will be returned by default.
++ + offset
++ No
++ String
++ Start index. The value can be 0 or a positive integer multiple of the limit value. 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). Parameters order_column and order_type should always be used together.
++ + order_type
++ No
++ String
++ Sorting type. You can set this parameter to desc (descending sort) or asc (ascending sort). Parameters order_column and order_type should always be used together.
+@@ -57,182 +93,195 @@ + filter
++ No
++ String
+Set this parameter to center::{center}|name::{name}|limit::{limit}|offset::{offset}|namespace::{namespace}|order_column::{order_column}|order_type::{order_type}. center can be set to self (images shared by you). thirdparty indicates images shared by others. namespace indicates the organization name. name indicates the image repository name. limit indicates the number of returned records. offset indicates the start index. order_column indicates sorting by column, which can be name, updated_time, or tag_count. order_type indicates the sorting type, which can be desc (descending order) or asc (ascending order).
Request
Response
- Response parameters -
Table 2 Response header parameter description Parameter
+--
Table 2 Request header parameters - - Parameter
Type
+- Mandatory
Description
++ Type
+Description
Content-Range
+- - - Content-Type
String
+- Yes
Offset (Start index)–Count (Number of records on the current page)/Total (Total number of records)
++ String
+Message body type (format). The value can be application/json or charset=utf-8 application/json.
+The default value is application/json.
- -If the offset and limit parameters are transferred in the request, Content-Range will be added to the response header.
--
Table 3 Response body parameter description - - - Parameter
-- Type
-- Description
-[Array element]
+- X-Auth-Token
Array of objects
+- Yes
Viewing the list of shared images.
++ String
+User token.
+The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
Table 4 [Array element] parameters description Parameter
++ ++
Table 3 Response body parameter description - - Parameter
Type
+- Type
Description
+Description
name
+- - [Array element]
String
+- Array of objects
Image repository name.
+Viewing the list of shared images.
+ category
++
Table 4 [Array element] parameters description + + + Parameter
++ Type
++ Description
+- - name
String
+- String
Image repository type. The value can be app_server, linux, framework_app, database, lang, other, windows, or arm.
+Image repository name.
description
+- - category
String
+- String
Image repository description.
+Image repository type. The value can be app_server, linux, framework_app, database, lang, arm, or other.
size
+- - description
Integer
+- String
Total size of the images in an image repository.
+Image repository description.
is_public
+- - size
Boolean
+- Integer
Whether the image is a public image. The value can be true or false.
+Total size of the images in an image repository.
num_images
+- - is_public
Integer
+- Boolean
Number of image tags in an image repository.
+Whether the image is a public image. The value can be true or false.
num_download
+- - num_images
Integer
+- Integer
Download times.
+Number of image tags in an image repository.
created_at
+- - num_download
String
+- Integer
Time when an image repository is created. It is the UTC standard time.
+Download times.
updated_at
+- - created_at
String
+- String
Time when an image repository is updated. It is the UTC standard time.
+Time when an image repository is created. It is the UTC standard time.
logo
+- - updated_at
String
+- String
(Reserved field) Image repository logo address.
+Time when an image repository is updated. It is the UTC standard time.
url
+- - logo
String
+- String
(Reserved field) URL of the image repository logo.
+(Reserved field) Image repository logo address.
path
+- - url
String
+- String
External Docker pull address. The format is {Repository address}/{Namespace name}/{Repository name}.
+(Reserved field) URL of the image repository logo.
internal_path
+- - path
String
+- String
Internal Docker pull address. The format is {Repository address}/{Namespace name}/{Repository name}.
+External Docker pull address. The format is {Repository address}/{Namespace name}/{Repository name}.
domain_name
+- - internal_path
String
+- String
Account name.
+Internal Docker pull address. The format is {Repository address}/{Namespace name}/{Repository name}.
namespace
+- - domain_name
String
+- String
Organization name.
+Domain name.
tags
+- - namespace
Array of strings
+- String
Image tag list.
+Organization name.
status
+- - tags
Boolean
+- Array of strings
+
- Query the images shared by a third party: Check whether the sharing is expired.
- Query the images shared by me: The default value is false, indicating that no images are shared.
Image tag list.
total_range
++ - status
Integer
+- Boolean
Total number of records.
++ +
- Query the images shared by a third party: Check whether the sharing is expired.
- Query the images shared by me: The default value is false, indicating that no images are shared.
@@ -296,10 +345,12 @@ + total_range
++ Integer
+Total number of records.
Error Codes
For details, see Error Codes.
+diff --git a/docs/swr/api-ref/swr_02_0080.html b/docs/swr/api-ref/swr_02_0080.html index 73c653fc..4edbd66f 100644 --- a/docs/swr/api-ref/swr_02_0080.html +++ b/docs/swr/api-ref/swr_02_0080.html @@ -5,108 +5,142 @@-Parent topic: API+Parent topic: Image Repository Management-URI
GET /
-Request
N/A
-Response
- Response parameters -
Table 1 Response body parameter description Parameter
+