From 4894df0e64d5ff3162eb5f7dadbc253b142a7259 Mon Sep 17 00:00:00 2001 From: proposalbot Date: Thu, 10 Nov 2022 10:13:15 +0000 Subject: [PATCH] Changes to swr_api-ref from docs/doc-exports#415 (SWR API initial version reuplo Reviewed-by: Hasko, Vladimir Co-authored-by: proposalbot Co-committed-by: proposalbot --- ...e_of_an_account_used_for_image_sharing.rst | 113 +++++ ...ting_an_account_used_for_image_sharing.rst | 91 ++++ .../api/creating_an_image_repository.rst | 109 +++++ .../source/api/creating_an_organization.rst | 77 ++++ .../source/api/creating_image_permissions.rst | 104 +++++ .../api/creating_organization_permissions.rst | 104 +++++ ...ting_an_account_used_for_image_sharing.rst | 65 +++ .../api/deleting_an_image_repository.rst | 66 +++ .../source/api/deleting_an_organization.rst | 59 +++ .../source/api/deleting_image_permissions.rst | 72 ++++ .../api/deleting_organization_permissions.rst | 71 +++ ...eleting_the_image_with_a_specified_tag.rst | 65 +++ api-ref/source/api/index.rst | 66 +++ ...ist_of_accounts_used_for_image_sharing.rst | 109 +++++ .../api/querying_a_specific_api_version.rst | 119 +++++ .../source/api/querying_all_api_versions.rst | 101 +++++ .../source/api/querying_image_permissions.rst | 131 ++++++ .../api/querying_organization_permissions.rst | 138 ++++++ ...ief_information_on_an_image_repository.rst | 127 ++++++ ...uerying_the_details_of_an_organization.rst | 88 ++++ .../querying_the_image_repository_list.rst | 178 ++++++++ ...ying_the_list_of_image_repository_tags.rst | 148 +++++++ .../querying_the_list_of_organizations.rst | 102 +++++ ...ting_an_account_used_for_image_sharing.rst | 82 ++++ .../source/api/updating_image_permissions.rst | 94 ++++ .../api/updating_organization_permissions.rst | 103 +++++ ...ief_information_on_an_image_repository.rst | 103 +++++ .../api/viewing_the_list_of_shared_images.rst | 160 +++++++ api-ref/source/api_usage_guidelines.rst | 12 + api-ref/source/appendixes/error_code.rst | 408 ++++++++++++++++++ api-ref/source/appendixes/index.rst | 16 + api-ref/source/appendixes/status_codes.rst | 54 +++ api-ref/source/change_history.rst | 14 + api-ref/source/conf.py | 14 +- api-ref/source/index.rst | 7 + 35 files changed, 3361 insertions(+), 9 deletions(-) create mode 100644 api-ref/source/api/checking_the_existence_of_an_account_used_for_image_sharing.rst create mode 100644 api-ref/source/api/creating_an_account_used_for_image_sharing.rst create mode 100644 api-ref/source/api/creating_an_image_repository.rst create mode 100644 api-ref/source/api/creating_an_organization.rst create mode 100644 api-ref/source/api/creating_image_permissions.rst create mode 100644 api-ref/source/api/creating_organization_permissions.rst create mode 100644 api-ref/source/api/deleting_an_account_used_for_image_sharing.rst create mode 100644 api-ref/source/api/deleting_an_image_repository.rst create mode 100644 api-ref/source/api/deleting_an_organization.rst create mode 100644 api-ref/source/api/deleting_image_permissions.rst create mode 100644 api-ref/source/api/deleting_organization_permissions.rst create mode 100644 api-ref/source/api/deleting_the_image_with_a_specified_tag.rst create mode 100644 api-ref/source/api/index.rst create mode 100644 api-ref/source/api/obtaining_the_list_of_accounts_used_for_image_sharing.rst create mode 100644 api-ref/source/api/querying_a_specific_api_version.rst create mode 100644 api-ref/source/api/querying_all_api_versions.rst create mode 100644 api-ref/source/api/querying_image_permissions.rst create mode 100644 api-ref/source/api/querying_organization_permissions.rst create mode 100644 api-ref/source/api/querying_the_brief_information_on_an_image_repository.rst create mode 100644 api-ref/source/api/querying_the_details_of_an_organization.rst create mode 100644 api-ref/source/api/querying_the_image_repository_list.rst create mode 100644 api-ref/source/api/querying_the_list_of_image_repository_tags.rst create mode 100644 api-ref/source/api/querying_the_list_of_organizations.rst create mode 100644 api-ref/source/api/updating_an_account_used_for_image_sharing.rst create mode 100644 api-ref/source/api/updating_image_permissions.rst create mode 100644 api-ref/source/api/updating_organization_permissions.rst create mode 100644 api-ref/source/api/updating_the_brief_information_on_an_image_repository.rst create mode 100644 api-ref/source/api/viewing_the_list_of_shared_images.rst create mode 100644 api-ref/source/api_usage_guidelines.rst create mode 100644 api-ref/source/appendixes/error_code.rst create mode 100644 api-ref/source/appendixes/index.rst create mode 100644 api-ref/source/appendixes/status_codes.rst create mode 100644 api-ref/source/change_history.rst diff --git a/api-ref/source/api/checking_the_existence_of_an_account_used_for_image_sharing.rst b/api-ref/source/api/checking_the_existence_of_an_account_used_for_image_sharing.rst new file mode 100644 index 0000000..3c5f6d7 --- /dev/null +++ b/api-ref/source/api/checking_the_existence_of_an_account_used_for_image_sharing.rst @@ -0,0 +1,113 @@ +:original_name: swr_02_0073.html + +.. _swr_02_0073: + +Checking the Existence of an Account Used for Image Sharing +=========================================================== + +Function +-------- + +Check whether an account used for image sharing exists. + +URI +--- + +GET /v2/manage/namespaces/{*namespace*}/repositories/{*repository*}/access-domains/{*access_domain*} + +For details about parameters, see :ref:`Table 1 `. + +.. _swr_02_0073__table11843162810214: + +.. table:: **Table 1** Parameter description + + +---------------+-----------+--------+---------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===============+===========+========+=============================================+ + | namespace | Yes | String | Organization name | + +---------------+-----------+--------+---------------------------------------------+ + | repository | Yes | String | Image repository name | + +---------------+-----------+--------+---------------------------------------------+ + | access_domain | Yes | String | Name of the account used for image sharing. | + +---------------+-----------+--------+---------------------------------------------+ + +Request +------- + +- Request parameters + + N/A + +- Example request + + .. code-block:: text + + GET https://{Endpoint}/v2/manage/namespaces/group/repositories/busybox/access-domains/domain_name + +Response +-------- + +- Response parameters + + .. table:: **Table 2** Response body parameter description + + +-----------------------+-----------------------+-------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=============================================================+ + | exist | Boolean | **true**: Exist. **false**: Not exist. | + +-----------------------+-----------------------+-------------------------------------------------------------+ + | namespace | String | Organization name. | + +-----------------------+-----------------------+-------------------------------------------------------------+ + | repository | String | Image repository name. | + +-----------------------+-----------------------+-------------------------------------------------------------+ + | access_domain | String | Name of the account used for image sharing. | + +-----------------------+-----------------------+-------------------------------------------------------------+ + | permit | String | Permission. | + +-----------------------+-----------------------+-------------------------------------------------------------+ + | deadline | String | Expiration time. | + +-----------------------+-----------------------+-------------------------------------------------------------+ + | description | String | Description. | + +-----------------------+-----------------------+-------------------------------------------------------------+ + | creator_id | String | Creator ID. | + +-----------------------+-----------------------+-------------------------------------------------------------+ + | creator_name | String | Name of the creator. | + +-----------------------+-----------------------+-------------------------------------------------------------+ + | created | String | 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 + + .. code-block:: + + { + "exist": true, + "namespace": "group", + "repository": "busybox", + "access_domain": "xxx", + "permit": "read", + "deadline": "2021-10-01T16:00:00Z", + "description": "description", + "creator_id": "0504186e6a8010e01f3ec009a7279baa", + "creator_name": "xxx", + "created": "2021-06-10T08:14:42.56632Z", + "updated": "2021-06-10T08:14:42.566325Z", + "status": true + } + +Status Code +----------- + +=========== ====================== +Status Code Description +=========== ====================== +200 Query succeeded. +400 Request error. +401 Authentication failed. +500 Internal error. +=========== ====================== diff --git a/api-ref/source/api/creating_an_account_used_for_image_sharing.rst b/api-ref/source/api/creating_an_account_used_for_image_sharing.rst new file mode 100644 index 0000000..9ae655a --- /dev/null +++ b/api-ref/source/api/creating_an_account_used_for_image_sharing.rst @@ -0,0 +1,91 @@ +:original_name: swr_02_0070.html + +.. _swr_02_0070: + +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. + +URI +--- + +POST /v2/manage/namespaces/{*namespace*}/repositories/{*repository*}/access-domains + +For details about parameters, see :ref:`Table 1 `. + +.. _swr_02_0070__table11843162810214: + +.. table:: **Table 1** Parameter description + + ========== ========= ====== ===================== + Parameter Mandatory Type Description + ========== ========= ====== ===================== + namespace Yes String Organization name + repository Yes String Image repository name + ========== ========= ====== ===================== + +Request +------- + +- Request parameters + + .. table:: **Table 2** Request body parameter description + + +---------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===============+===========+========+===========================================================================================================================================+ + | access_domain | Yes | String | Name of the account used for image sharing. | + +---------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | permit | Yes | String | 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. | + +---------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Description. | + +---------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------+ + +- Example request + + .. code-block:: text + + POST https://{Endpoint}/v2/manage/namespaces/group/repositories/busybox/access-domains + + Body: + + .. code-block:: + + { + "access_domain": "domain_name", + "permit": "read", + "deadline": "2021-10-01T16:00:00.000Z", + "description": "description" + } + +Response +-------- + +- Response parameters + + N/A + +- Example response + + .. code-block:: + + {} + +Status Code +----------- + +=========== =============================== +Status Code Description +=========== =============================== +201 Creation successful. +400 Request error. +401 Authentication failed. +409 The repository has been shared. +500 Internal error. +=========== =============================== diff --git a/api-ref/source/api/creating_an_image_repository.rst b/api-ref/source/api/creating_an_image_repository.rst new file mode 100644 index 0000000..968fd57 --- /dev/null +++ b/api-ref/source/api/creating_an_image_repository.rst @@ -0,0 +1,109 @@ +:original_name: swr_02_0030.html + +.. _swr_02_0030: + +Creating an Image Repository +============================ + +Function +-------- + +Create an image repository in an organization. + +URI +--- + +POST /v2/manage/namespaces/{*namespace*}/repos + +For details about parameters, see :ref:`Table 1 `. + +.. _swr_02_0030__table155961192716: + +.. table:: **Table 1** Parameter description + + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request +------- + +- Request parameters + + .. table:: **Table 2** FormData parameter description + + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+================================================================================================================================================================================================================================================================================================================================+ + | repository | Yes | 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. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | category | No | 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. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +- Example request + + .. code-block:: text + + POST https://{Endpoint}/v2/manage/namespaces/group/repos + + Body: + + .. code-block:: + + -F "repository=busybox" \ + -F "category=linux" \ + -F "description=this is a busybox repository" \ + -F "is_public=true" + + Or + + .. code-block:: + + { + "repository": "busybox", + "category": "linux", + "description": "this is a busybox repository", + "is_public": true + } + + .. note:: + + The form format will no longer be supported soon. You are advised to use the body in the JSON format to call the API. + +Response +-------- + +- Response parameters + + N/A + +- Example response + + .. code-block:: + + {} + +Status Code +----------- + +=========== ============================================== +Status Code Description +=========== ============================================== +201 Creation successful. +400 Request error. Error information is returned. +401 Authentication failed. +409 The repository already exists. +500 Internal error. Error information is returned. +=========== ============================================== diff --git a/api-ref/source/api/creating_an_organization.rst b/api-ref/source/api/creating_an_organization.rst new file mode 100644 index 0000000..c7d7847 --- /dev/null +++ b/api-ref/source/api/creating_an_organization.rst @@ -0,0 +1,77 @@ +:original_name: swr_02_0026.html + +.. _swr_02_0026: + +Creating an Organization +======================== + +Function +-------- + +Create an organization. + +URI +--- + +POST /v2/manage/namespaces + +Request +------- + +- Request parameters + + .. table:: **Table 1** Request body parameter description + + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +- Example request + + Create an organization named **group**: + + .. code-block:: text + + POST https://{Endpoint}/v2/manage/namespaces + + Body: + + .. code-block:: + + { + "namespace": "group" + } + +Response +-------- + +- Response parameters + + N/A + +- Example response + + .. code-block:: + + {} + +Status Code +----------- + ++-------------+----------------------------------------------------------------------------------+ +| Status Code | Description | ++=============+==================================================================================+ +| 201 | Creation successful. | ++-------------+----------------------------------------------------------------------------------+ +| 400 | The request is incorrect or the number of organizations exceeds the upper limit. | ++-------------+----------------------------------------------------------------------------------+ +| 401 | Authentication failed. | ++-------------+----------------------------------------------------------------------------------+ +| 409 | The resource already exists. | ++-------------+----------------------------------------------------------------------------------+ +| 500 | Internal error. | ++-------------+----------------------------------------------------------------------------------+ diff --git a/api-ref/source/api/creating_image_permissions.rst b/api-ref/source/api/creating_image_permissions.rst new file mode 100644 index 0000000..c726dff --- /dev/null +++ b/api-ref/source/api/creating_image_permissions.rst @@ -0,0 +1,104 @@ +:original_name: swr_02_0046.html + +.. _swr_02_0046: + +Creating Image Permissions +========================== + +Function +-------- + +Grant permissions of an image to certain users so that they can manage, edit, and read the image. + +URI +--- + +POST /v2/manage/namespaces/{*namespace*}/repos/{*repository*}/access + +For details about parameters, see :ref:`Table 1 `. + +.. _swr_02_0046__table73271639103420: + +.. table:: **Table 1** Parameter description + + ========== ========= ====== ================== + Parameter Mandatory Type Description + ========== ========= ====== ================== + namespace Yes String Organization name. + repository Yes String Image name. + ========== ========= ====== ================== + +Request +------- + +- Request parameters + + .. table:: **Table 2** Request body parameter description + + +-------------------+-----------+--------------------------------------------------------+--------------+ + | Parameter | Mandatory | Type | Description. | + +===================+===========+========================================================+==============+ + | *[Array element]* | Yes | Array of :ref:`objects ` | User list | + +-------------------+-----------+--------------------------------------------------------+--------------+ + + .. _swr_02_0046__table6912142367: + + .. table:: **Table 3** *[Array element]* parameters decription + + +-----------------+-----------------+-----------------+-------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=====================================+ + | user_id | Yes | String | User ID. | + +-----------------+-----------------+-----------------+-------------------------------------+ + | user_name | Yes | String | Username. | + +-----------------+-----------------+-----------------+-------------------------------------+ + | auth | Yes | Integer | User permission that is configured. | + | | | | | + | | | | - 7: Manage | + | | | | - 3: Write | + | | | | - 1: Read | + +-----------------+-----------------+-----------------+-------------------------------------+ + +- Example request + + .. code-block:: text + + POST https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/access + + Body: + + .. code-block:: + + [ + { + "user_id": "fb3f175c1fd146ab8cdae3272be6107b", + "user_name": "user01", + "auth": 1 + } + ] + +Response +-------- + +- Response parameters + + N/A + +- Example response + + .. code-block:: + + {} + +Status Code +----------- + +=========== ========================= +Status Code Description +=========== ========================= +201 Creation successful. +400 Request error. +401 Authentication failed. +404 The image does not exist. +500 Internal error. +=========== ========================= diff --git a/api-ref/source/api/creating_organization_permissions.rst b/api-ref/source/api/creating_organization_permissions.rst new file mode 100644 index 0000000..379f683 --- /dev/null +++ b/api-ref/source/api/creating_organization_permissions.rst @@ -0,0 +1,104 @@ +:original_name: swr_02_0042.html + +.. _swr_02_0042: + +Creating Organization Permissions +================================= + +Function +-------- + +Grant permissions of an organization to certain users so that they can manage, edit, and read images from the organization. + +URI +--- + +POST /v2/manage/namespaces/{*namespace*}/access + +:ref:`Table 1 ` describes the parameters. + +.. _swr_02_0042__table1860452124716: + +.. table:: **Table 1** Parameter description + + ========= ========= ====== ================== + Parameter Mandatory Type Description + ========= ========= ====== ================== + namespace Yes String Organization name. + ========= ========= ====== ================== + +Request +------- + +- Request parameters + + .. table:: **Table 2** Request body description + + +-----------------+-----------+----------------------------------------------------------+-------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+===========+==========================================================+=============================================================+ + | [Array element] | Yes | Array of :ref:`objects ` | Information required for creating organization permissions. | + +-----------------+-----------+----------------------------------------------------------+-------------------------------------------------------------+ + + .. _swr_02_0042__table196185211479: + + .. table:: **Table 3** [Array element] + + +-----------------+-----------------+-----------------+-----------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=================+ + | user_id | Yes | String | User ID. | + +-----------------+-----------------+-----------------+-----------------+ + | user_name | Yes | String | Username. | + +-----------------+-----------------+-----------------+-----------------+ + | auth | Yes | Integer | User permission | + | | | | | + | | | | - 7: Manage | + | | | | - 3: Write | + | | | | - 1: Read | + +-----------------+-----------------+-----------------+-----------------+ + +- Example request + + .. code-block:: text + + POST https://{Endpoint}/v2/manage/namespaces/group/access + + Body: + + .. code-block:: + + [ + { + "user_id": "fb3f175c1fd146ab8cdae3272be6107b", + "user_name": "user01", + "auth": 1 + } + ] + +Response +-------- + +- Response parameters + + N/A + +- Example response + + .. code-block:: + + {} + +Status Code +----------- + +=========== =========================================== +Status Code Description +=========== =========================================== +201 Creation successful. +400 Request error. +401 Authentication failed. +404 The organization does not exist. +409 The organization permission already exists. +500 Internal error. +=========== =========================================== diff --git a/api-ref/source/api/deleting_an_account_used_for_image_sharing.rst b/api-ref/source/api/deleting_an_account_used_for_image_sharing.rst new file mode 100644 index 0000000..fc02057 --- /dev/null +++ b/api-ref/source/api/deleting_an_account_used_for_image_sharing.rst @@ -0,0 +1,65 @@ +:original_name: swr_02_0071.html + +.. _swr_02_0071: + +Deleting an Account Used for Image Sharing +========================================== + +Function +-------- + +Delete an account used for image sharing. + +URI +--- + +DELETE /v2/manage/namespaces/{*namespace*}/repositories/{*repository*}/access-domains/{*access_domain*} + +For details about parameters, see :ref:`Table 1 `. + +.. _swr_02_0071__table11843162810214: + +.. table:: **Table 1** Parameter description + + +---------------+-----------+--------+---------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===============+===========+========+=============================================+ + | namespace | Yes | String | Organization name. | + +---------------+-----------+--------+---------------------------------------------+ + | repository | Yes | String | Image repository name. | + +---------------+-----------+--------+---------------------------------------------+ + | access_domain | Yes | String | Name of the account used for image sharing. | + +---------------+-----------+--------+---------------------------------------------+ + +Request +------- + +- Request parameters + + N/A + +- Example request + + .. code-block:: text + + DELETE https://{Endpoint}/v2/manage/namespaces/group/repositories/busybox/access-domains/domain_name + +Response +-------- + +N/A + +Status Code +----------- + ++-------------+----------------------------------------------------------------------+ +| Status Code | Description | ++=============+======================================================================+ +| 204 | Deleted successfully. | ++-------------+----------------------------------------------------------------------+ +| 400 | Request error. | ++-------------+----------------------------------------------------------------------+ +| 401 | Authentication failed. | ++-------------+----------------------------------------------------------------------+ +| 500 | Failed to complete the request because of an internal service error. | ++-------------+----------------------------------------------------------------------+ diff --git a/api-ref/source/api/deleting_an_image_repository.rst b/api-ref/source/api/deleting_an_image_repository.rst new file mode 100644 index 0000000..52a4a18 --- /dev/null +++ b/api-ref/source/api/deleting_an_image_repository.rst @@ -0,0 +1,66 @@ +:original_name: swr_02_0031.html + +.. _swr_02_0031: + +Deleting an Image Repository +============================ + +Function +-------- + +Delete an image repository in an organization. + +URI +--- + +DELETE /v2/manage/namespaces/{*namespace*}/repos/{*repository*} + +For details about parameters, see :ref:`Table 1 `. + +.. _swr_02_0031__table184146147323: + +.. table:: **Table 1** Parameter description + + ========== ========= ====== ====================== + Parameter Mandatory Type Description + ========== ========= ====== ====================== + namespace Yes String Organization name. + repository Yes String Image repository name. + ========== ========= ====== ====================== + +Request +------- + +- Request parameters + + N/A + +- Example request + + .. code-block:: text + + DELETE https://{Endpoint}/v2/manage/namespaces/group/repos/busybox + +Response +-------- + +N/A + +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. | ++-------------+---------------------------------------------------------------------------+ diff --git a/api-ref/source/api/deleting_an_organization.rst b/api-ref/source/api/deleting_an_organization.rst new file mode 100644 index 0000000..7037068 --- /dev/null +++ b/api-ref/source/api/deleting_an_organization.rst @@ -0,0 +1,59 @@ +:original_name: swr_02_0027.html + +.. _swr_02_0027: + +Deleting an Organization +======================== + +Function +-------- + +Delete an organization. + +URI +--- + +DELETE /v2/manage/namespaces/{*namespace*} + +For details about parameters, see :ref:`Table 1 `. + +.. _swr_02_0027__tae82a09e27434bef9a38b734d798ae6c: + +.. table:: **Table 1** Parameter description + + ========= ========= ====== ================= + Parameter Mandatory Type Description + ========= ========= ====== ================= + namespace Yes String Organization name + ========= ========= ====== ================= + +Request +------- + +- Request parameters + + N/A + +- Example request + + .. code-block:: text + + DELETE https://{Endpoint}/v2/manage/namespaces/group + +Response +-------- + +N/A + +Status Code +----------- + +=========== ================================ +Status Code Description +=========== ================================ +204 Deleted successfully. +400 Request error. +401 Authentication failed. +404 The organization does not exist. +500 Internal error. +=========== ================================ diff --git a/api-ref/source/api/deleting_image_permissions.rst b/api-ref/source/api/deleting_image_permissions.rst new file mode 100644 index 0000000..44b90ed --- /dev/null +++ b/api-ref/source/api/deleting_image_permissions.rst @@ -0,0 +1,72 @@ +:original_name: swr_02_0047.html + +.. _swr_02_0047: + +Deleting Image Permissions +========================== + +Function +-------- + +Delete the image operation permissions of certain users. + +URI +--- + +DELETE /v2/manage/namespaces/{*namespace*}/repos/{*repository*}/access + +For details about parameters, see :ref:`Table 1 `. + +.. _swr_02_0047__table73271639103420: + +.. table:: **Table 1** Parameter description + + ========== ========= ====== ================== + Parameter Mandatory Type Description + ========== ========= ====== ================== + namespace Yes String Organization name. + repository Yes String Image name. + ========== ========= ====== ================== + +Request +------- + +- Request parameters + + .. table:: **Table 2** 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 + + .. code-block:: text + + DELETE https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/access + + Body: + + .. code-block:: + + ["fb3f175c1fd146ab8cdae3272be6107b"] + +Response +-------- + +N/A + +Status Code +----------- + +=========== ========================= +Status Code Description +=========== ========================= +204 Deleted successfully. +400 Request error. +401 Authentication failed. +404 The image does not exist. +500 Internal error. +=========== ========================= diff --git a/api-ref/source/api/deleting_organization_permissions.rst b/api-ref/source/api/deleting_organization_permissions.rst new file mode 100644 index 0000000..3d48526 --- /dev/null +++ b/api-ref/source/api/deleting_organization_permissions.rst @@ -0,0 +1,71 @@ +:original_name: swr_02_0043.html + +.. _swr_02_0043: + +Deleting Organization Permissions +================================= + +Function +-------- + +Delete the organization operation permissions of certain users. + +URI +--- + +DELETE /v2/manage/namespaces/{*namespace*}/access + +:ref:`Table 1 ` describes the parameters. + +.. _swr_02_0043__table15218458175016: + +.. table:: **Table 1** Parameter description + + ========= ========= ====== ================== + Parameter Mandatory Type Description + ========= ========= ====== ================== + namespace Yes String Organization name. + ========= ========= ====== ================== + +Request +------- + +- Request parameters + + .. table:: **Table 2** 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 + + .. code-block:: text + + DELETE https://{Endpoint}/v2/manage/namespaces/group/access + + Body: + + .. code-block:: + + ["fb3f175c1fd146ab8cdae3272be6107b"] + +Response +-------- + +N/A + +Status Code +----------- + +=========== ================================ +Status Code Description +=========== ================================ +204 Deleted successfully. +400 Request error. +401 Authentication failed. +404 The organization does not exist. +500 Internal error. +=========== ================================ diff --git a/api-ref/source/api/deleting_the_image_with_a_specified_tag.rst b/api-ref/source/api/deleting_the_image_with_a_specified_tag.rst new file mode 100644 index 0000000..1c667ed --- /dev/null +++ b/api-ref/source/api/deleting_the_image_with_a_specified_tag.rst @@ -0,0 +1,65 @@ +:original_name: swr_02_0036.html + +.. _swr_02_0036: + +Deleting the Image with a Specified Tag +======================================= + +Function +-------- + +Delete the image with a specified tag in an image repository. + +URI +--- + +DELETE /v2/manage/namespaces/{*namespace*}/repos/{*repository*}/tags/{*tag*} + +For details about parameters, see :ref:`Table 1 `. + +.. _swr_02_0036__table05962819187: + +.. table:: **Table 1** Parameter description + + ========== ========= ====== ===================== + Parameter Mandatory Type Description + ========== ========= ====== ===================== + namespace Yes String Organization name + repository Yes String Image repository name + tag Yes String Image tag name + ========== ========= ====== ===================== + +Request +------- + +- Request parameters + + N/A + +- Example request + + .. code-block:: text + + DELETE https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/tags/v1 + +Response +-------- + +N/A + +Status Code +----------- + ++-------------+------------------------------------------------------------------+ +| Status Code | Description | ++=============+==================================================================+ +| 204 | The image with a specified tag is deleted successfully. | ++-------------+------------------------------------------------------------------+ +| 400 | Request error. Error information is returned. | ++-------------+------------------------------------------------------------------+ +| 401 | Authentication failed. | ++-------------+------------------------------------------------------------------+ +| 404 | The repository or the image with a specified tag does not exist. | ++-------------+------------------------------------------------------------------+ +| 500 | Internal error. Error information is returned. | ++-------------+------------------------------------------------------------------+ diff --git a/api-ref/source/api/index.rst b/api-ref/source/api/index.rst new file mode 100644 index 0000000..b42ed65 --- /dev/null +++ b/api-ref/source/api/index.rst @@ -0,0 +1,66 @@ +:original_name: swr_02_0011.html + +.. _swr_02_0011: + +API +=== + +- :ref:`Creating an Organization ` +- :ref:`Deleting an Organization ` +- :ref:`Querying the List of Organizations ` +- :ref:`Querying the Details of an Organization ` +- :ref:`Creating an Image Repository ` +- :ref:`Deleting an Image Repository ` +- :ref:`Updating the Brief Information on an Image Repository ` +- :ref:`Querying the Brief Information on an Image Repository ` +- :ref:`Querying the Image Repository List ` +- :ref:`Querying the List of Image Repository Tags ` +- :ref:`Deleting the Image with a Specified Tag ` +- :ref:`Creating an Account Used for Image Sharing ` +- :ref:`Deleting an Account Used for Image Sharing ` +- :ref:`Updating an Account Used for Image Sharing ` +- :ref:`Checking the Existence of an Account Used for Image Sharing ` +- :ref:`Obtaining the List of Accounts Used for Image Sharing ` +- :ref:`Viewing the List of Shared Images ` +- :ref:`Querying All API Versions ` +- :ref:`Querying a Specific API Version ` +- :ref:`Creating Organization Permissions ` +- :ref:`Deleting Organization Permissions ` +- :ref:`Updating Organization Permissions ` +- :ref:`Querying Organization Permissions ` +- :ref:`Creating Image Permissions ` +- :ref:`Deleting Image Permissions ` +- :ref:`Updating Image Permissions ` +- :ref:`Querying Image Permissions ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + creating_an_organization + deleting_an_organization + querying_the_list_of_organizations + querying_the_details_of_an_organization + creating_an_image_repository + deleting_an_image_repository + updating_the_brief_information_on_an_image_repository + querying_the_brief_information_on_an_image_repository + querying_the_image_repository_list + querying_the_list_of_image_repository_tags + deleting_the_image_with_a_specified_tag + creating_an_account_used_for_image_sharing + deleting_an_account_used_for_image_sharing + updating_an_account_used_for_image_sharing + checking_the_existence_of_an_account_used_for_image_sharing + obtaining_the_list_of_accounts_used_for_image_sharing + viewing_the_list_of_shared_images + querying_all_api_versions + querying_a_specific_api_version + creating_organization_permissions + deleting_organization_permissions + updating_organization_permissions + querying_organization_permissions + creating_image_permissions + deleting_image_permissions + updating_image_permissions + querying_image_permissions diff --git a/api-ref/source/api/obtaining_the_list_of_accounts_used_for_image_sharing.rst b/api-ref/source/api/obtaining_the_list_of_accounts_used_for_image_sharing.rst new file mode 100644 index 0000000..1c4a72e --- /dev/null +++ b/api-ref/source/api/obtaining_the_list_of_accounts_used_for_image_sharing.rst @@ -0,0 +1,109 @@ +:original_name: swr_02_0074.html + +.. _swr_02_0074: + +Obtaining the List of Accounts Used for Image Sharing +===================================================== + +Function +-------- + +Obtain the list of accounts used for image sharing. + +URI +--- + +GET /v2/manage/namespaces/{*namespace*}/repositories/{*repository*}/access-domains + +For details about parameters, see :ref:`Table 1 `. + +.. _swr_02_0074__table11843162810214: + +.. table:: **Table 1** Parameter description + + ========== ========= ====== ===================== + Parameter Mandatory Type Description + ========== ========= ====== ===================== + namespace Yes String Organization name + repository Yes String Image repository name + ========== ========= ====== ===================== + +Request +------- + +- Request parameters + + N/A + +- Example request + + .. code-block:: text + + GET https://{Endpoint}/v2/manage/namespaces/group/repositories/busybox/access-domains + +Response +-------- + +- Response parameters + + .. table:: **Table 2** Response body parameter description + + +-----------------------+-----------------------+-------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=============================================================+ + | namespace | String | Organization name. | + +-----------------------+-----------------------+-------------------------------------------------------------+ + | repository | String | Image repository name. | + +-----------------------+-----------------------+-------------------------------------------------------------+ + | access_domain | String | Name of the account used for image sharing. | + +-----------------------+-----------------------+-------------------------------------------------------------+ + | permit | String | Permission. | + +-----------------------+-----------------------+-------------------------------------------------------------+ + | deadline | String | Expiration time. | + +-----------------------+-----------------------+-------------------------------------------------------------+ + | description | String | Description. | + +-----------------------+-----------------------+-------------------------------------------------------------+ + | creator_id | String | Creator ID. | + +-----------------------+-----------------------+-------------------------------------------------------------+ + | creator_name | String | Name of the creator. | + +-----------------------+-----------------------+-------------------------------------------------------------+ + | created | String | 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 + + .. code-block:: + + [ + { + "namespace": "group", + "repository": "busybox", + "access_domain": "swr", + "permit": "read", + "deadline": "2021-10-01T16:00:00Z", + "description": "description", + "creator_id": "fb3f175c1fd146ab8cdae3272be6107b", + "creator_name": "group", + "created": "2021-06-10T08:14:42.56632Z", + "updated": "2021-06-10T08:14:42.566325Z", + "status": true + } + ] + +Status Code +----------- + +=========== ========================================================== +Status Code Description +=========== ========================================================== +200 The list of image sharing account is queried successfully. +400 Request error. Error information is returned. +401 Authentication failed. +500 Internal error. Error information is returned. +=========== ========================================================== diff --git a/api-ref/source/api/querying_a_specific_api_version.rst b/api-ref/source/api/querying_a_specific_api_version.rst new file mode 100644 index 0000000..fbbf6ef --- /dev/null +++ b/api-ref/source/api/querying_a_specific_api_version.rst @@ -0,0 +1,119 @@ +:original_name: swr_02_0081.html + +.. _swr_02_0081: + +Querying a Specific API Version +=============================== + +Function +-------- + +Query a specific API version of SWR. + +URI +--- + +GET /{*api_version*} + +For details about parameters, see :ref:`Table 1 `. + +.. _swr_02_0081__tae82a09e27434bef9a38b734d798ae6c: + +.. table:: **Table 1** Parameter description + + =========== ========= ====== =========== + Parameter Mandatory Type Description + =========== ========= ====== =========== + api_version Yes String API version + =========== ========= ====== =========== + +Request +------- + +- Request parameters + + N/A + +- Example request + + .. code-block:: text + + GET https://{Endpoint}/v2 + +Response +-------- + +- Response parameters + + .. table:: **Table 2** Response body parameter description + + +-----------+--------------------------------------------------+-------------------------------------------+ + | Parameter | Type | Description | + +===========+==================================================+===========================================+ + | version | :ref:`Object ` | A list of objects related to the version. | + +-----------+--------------------------------------------------+-------------------------------------------+ + + .. _swr_02_0081__table45446245174724: + + .. table:: **Table 3** version parameter description + + +-----------------------+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+================================================+================================================================================================================================================================================+ + | id | String | Version ID (version number), for example, v2. | + +-----------------------+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | links | :ref:`Object ` | API URL. | + +-----------------------+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | version | String | If the APIs of this version support microversions, set this parameter to the supported maximum microversion. If the microversion is not supported, leave this parameter blank. | + +-----------------------+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Version status. The options are as follows: | + | | | | + | | | - **CURRENT**: The version is the primary version. | + | | | - **SUPPORTED**: The version is an old version, but it is still supported. | + | | | - **DEPRECATED**: The version is a deprecated version, which may be deleted later. | + +-----------------------+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated | String | Version release time, which must be the UTC time. For example, the release time of v2 is **2018-06-28T12:20:21Z**. | + +-----------------------+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | min_version | String | If APIs of this version support microversions, set this parameter to the supported minimum microversion. If the microversion is not supported, leave this parameter blank. | + +-----------------------+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + + .. _swr_02_0081__table453717423323: + + .. table:: **Table 4** links parameter description + + ========= ====== =========== + Parameter Type Description + ========= ====== =========== + href String Link + rel String Description + ========= ====== =========== + +- Example response + + .. code-block:: + + { + "version": { + "id": "v2", + "links": + { + "href": "https://xxx", + "rel": "self" + } + "min_version": "2.0", + "status": "CURRENT", + "updated": "2017-12-09T00:00:00Z", + "version": "2.26" + } + } + +Status Code +----------- + ++-------------+----------------------------------------------------------------------+ +| Status Code | Description | ++=============+======================================================================+ +| 200 | Request successful. | ++-------------+----------------------------------------------------------------------+ +| 500 | Failed to complete the request because of an internal service error. | ++-------------+----------------------------------------------------------------------+ diff --git a/api-ref/source/api/querying_all_api_versions.rst b/api-ref/source/api/querying_all_api_versions.rst new file mode 100644 index 0000000..bf63d9c --- /dev/null +++ b/api-ref/source/api/querying_all_api_versions.rst @@ -0,0 +1,101 @@ +:original_name: swr_02_0080.html + +.. _swr_02_0080: + +Querying All API Versions +========================= + +Function +-------- + +Query all available API versions of SWR. + +URI +--- + +GET / + +Request +------- + +N/A + +Response +-------- + +- Response parameters + + .. table:: **Table 1** Response body parameter description + + +-----------+------------------------------------------------------------+-------------------------------------------+ + | Parameter | Type | Description | + +===========+============================================================+===========================================+ + | versions | Array of :ref:`objects ` | A list of objects related to the version. | + +-----------+------------------------------------------------------------+-------------------------------------------+ + + .. _swr_02_0080__table45446245174724: + + .. table:: **Table 2** versions parameter description + + +-----------------------+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+================================================+================================================================================================================================================================================+ + | id | String | Version ID (version number), for example, v2. | + +-----------------------+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | links | :ref:`Object ` | API URL. | + +-----------------------+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | version | String | If the APIs of this version support microversions, set this parameter to the supported maximum microversion. If the microversion is not supported, leave this parameter blank. | + +-----------------------+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Version status. The options are as follows: | + | | | | + | | | - **CURRENT**: The version is the primary version. | + | | | - **SUPPORTED**: The version is an old version, but it is still supported. | + | | | - **DEPRECATED**: The version is a deprecated version, which may be deleted later. | + +-----------------------+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated | String | Version release time, which must be the UTC time. For example, the release time of v2 is **2014-06-28T12:20:21Z**. | + +-----------------------+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | min_version | String | If APIs of this version support microversions, set this parameter to the supported minimum microversion. If the microversion is not supported, leave this parameter blank. | + +-----------------------+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + + .. _swr_02_0080__table453717423323: + + .. table:: **Table 3** links parameter description + + ========= ====== =========== + Parameter Type Description + ========= ====== =========== + href String Link + rel String Description + ========= ====== =========== + +- Example response + + .. code-block:: + + { + "versions": [ + { + "id": "v2", + "links": + { + "href": "https://xxx", + "rel": "self" + } + "min_version": "2.0", + "status": "CURRENT", + "updated": "2020-07-09T00:00:00Z", + "version": "2.26", + } + ] + } + +Status Code +----------- + ++-------------+----------------------------------------------------------------------+ +| Status Code | Description | ++=============+======================================================================+ +| 200 | Request successful. | ++-------------+----------------------------------------------------------------------+ +| 500 | Failed to complete the request because of an internal service error. | ++-------------+----------------------------------------------------------------------+ diff --git a/api-ref/source/api/querying_image_permissions.rst b/api-ref/source/api/querying_image_permissions.rst new file mode 100644 index 0000000..5724dd3 --- /dev/null +++ b/api-ref/source/api/querying_image_permissions.rst @@ -0,0 +1,131 @@ +:original_name: swr_02_0049.html + +.. _swr_02_0049: + +Querying Image Permissions +========================== + +Function +-------- + +Query image permissions. + +URI +--- + +GET /v2/manage/namespaces/{*namespace*}/repos/{*repository*}/access + +For details about parameters, see :ref:`Table 1 `. + +.. _swr_02_0049__table73271639103420: + +.. table:: **Table 1** Parameter description + + ========== ========= ====== ================= + Parameter Mandatory Type Description + ========== ========= ====== ================= + namespace Yes String Organization name + repository Yes String Image name + ========== ========= ====== ================= + +Request +------- + +- Request parameters + + N/A + +- Example request + + .. code-block:: text + + GET https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/access + +Response +-------- + +- Response parameters + + .. table:: **Table 2** Response body parameter description + + +--------------+-----------------------------------------------------------+----------------------------------+ + | Parameter | Type | Description | + +==============+===========================================================+==================================+ + | id | Integer | Permission ID. | + +--------------+-----------------------------------------------------------+----------------------------------+ + | name | String | Image name. | + +--------------+-----------------------------------------------------------+----------------------------------+ + | self_auth | :ref:`Object ` | Permissions of the current user. | + +--------------+-----------------------------------------------------------+----------------------------------+ + | others_auths | Array of :ref:`objects ` | Permissions of other users. | + +--------------+-----------------------------------------------------------+----------------------------------+ + + .. _swr_02_0049__table16690123312516: + + .. table:: **Table 3** self_auth parameter description + + +-----------------------+-----------------------+-----------------------+ + | Parameter | Type | Description | + +=======================+=======================+=======================+ + | user_id | String | User ID | + +-----------------------+-----------------------+-----------------------+ + | user_name | String | Username | + +-----------------------+-----------------------+-----------------------+ + | auth | Integer | User permission | + | | | | + | | | - 7: Manage | + | | | - 3: Write | + | | | - 1: Read | + +-----------------------+-----------------------+-----------------------+ + + .. _swr_02_0049__table2060620585538: + + .. table:: **Table 4** others_auths parameter description + + +-----------------------+-----------------------+-----------------------+ + | Parameter | Type | Description | + +=======================+=======================+=======================+ + | user_id | String | User ID | + +-----------------------+-----------------------+-----------------------+ + | user_name | String | Username | + +-----------------------+-----------------------+-----------------------+ + | auth | Integer | User permission | + | | | | + | | | - 7: Manage | + | | | - 3: Write | + | | | - 1: Read | + +-----------------------+-----------------------+-----------------------+ + +- Example response + + .. code-block:: + + { + "id": 1422, + "name": "busybox", + "self_auth": { + "user_id": "3059e6b5562241fda3fa441cca6f228b", + "user_name": "admin", + "auth": 7 + }, + "others_auths": [ + { + "user_id": "fb3f175c1fd146ab8cdae3272be6107b", + "user_name": "user", + "auth": 1 + } + ] + } + +Status Code +----------- + +=========== ================================================= +Status Code Description +=========== ================================================= +200 Query succeeded. +400 Request error. +401 Authentication failed. +404 The image or the image permission does not exist. +500 Internal error. +=========== ================================================= diff --git a/api-ref/source/api/querying_organization_permissions.rst b/api-ref/source/api/querying_organization_permissions.rst new file mode 100644 index 0000000..cb83cdd --- /dev/null +++ b/api-ref/source/api/querying_organization_permissions.rst @@ -0,0 +1,138 @@ +:original_name: swr_02_0045.html + +.. _swr_02_0045: + +Querying Organization Permissions +================================= + +Function +-------- + +Query organization permissions. + +URI +--- + +GET /v2/manage/namespaces/{namespace}/access + +For details about parameters, see :ref:`Table 1 `. + +.. _swr_02_0045__table73271639103420: + +.. table:: **Table 1** Parameter description + + ========= ========= ====== ================== + Parameter Mandatory Type Description + ========= ========= ====== ================== + namespace Yes String Organization name. + ========= ========= ====== ================== + +Request +------- + +- Request parameters + + N/A + +- Example request + + .. code-block:: text + + GET https://{Endpoint}/v2/manage/namespaces/group/access + +Response +-------- + +- Response parameters + + .. table:: **Table 2** Response body parameters + + +--------------+-----------------------------------------------------------+----------------------------------+ + | Parameter | Type | Description | + +==============+===========================================================+==================================+ + | id | Integer | Permission ID. | + +--------------+-----------------------------------------------------------+----------------------------------+ + | name | String | Organization name. | + +--------------+-----------------------------------------------------------+----------------------------------+ + | creator_name | String | Organization creator. | + +--------------+-----------------------------------------------------------+----------------------------------+ + | self_auth | :ref:`Object ` | Permissions of the current user. | + +--------------+-----------------------------------------------------------+----------------------------------+ + | others_auths | Array of :ref:`objects ` | Permissions of other users. | + +--------------+-----------------------------------------------------------+----------------------------------+ + + .. _swr_02_0045__table16690123312516: + + .. table:: **Table 3** self_auth parameter description + + +-----------------------+-----------------------+-----------------------+ + | Parameter | Type | Description | + +=======================+=======================+=======================+ + | user_id | String | User ID. | + +-----------------------+-----------------------+-----------------------+ + | user_name | String | Username. | + +-----------------------+-----------------------+-----------------------+ + | auth | Integer | User permission | + | | | | + | | | - 7: Manage | + | | | - 3: Write | + | | | - 1: Read | + +-----------------------+-----------------------+-----------------------+ + + .. _swr_02_0045__table2060620585538: + + .. table:: **Table 4** others_auths parameter description + + +-----------------------+-----------------------+-----------------------+ + | Parameter | Type | Description | + +=======================+=======================+=======================+ + | user_id | String | User ID. | + +-----------------------+-----------------------+-----------------------+ + | user_name | String | Username. | + +-----------------------+-----------------------+-----------------------+ + | auth | Integer | User permission | + | | | | + | | | - 7: Manage | + | | | - 3: Write | + | | | - 1: Read | + +-----------------------+-----------------------+-----------------------+ + +- Example response + + .. code-block:: + + { + "id": 1334795, + "name": "group", + "creator_name": "user", + "self_auth": { + "user_id": "050b12577f00269a1fcfc01f65239697", + "user_name": "user", + "auth": 7 + }, + "others_auths": [ + { + "user_id": "06d89c3b6d800f2d1f28c01f0d882285", + "user_name": "user_01", + "auth": 1 + }, + { + "user_id": "050b12577f00269a1fcfc01f65239697", + "user_name": "user", + "auth": 7 + } + ] + } + +Status Code +----------- + +=========== ================================ +Status Code Description +=========== ================================ +200 Request successful. +400 Request error. +401 Authentication failed. +404 The organization does not exist. +500 Internal error. +=========== ================================ diff --git a/api-ref/source/api/querying_the_brief_information_on_an_image_repository.rst b/api-ref/source/api/querying_the_brief_information_on_an_image_repository.rst new file mode 100644 index 0000000..e63e3a4 --- /dev/null +++ b/api-ref/source/api/querying_the_brief_information_on_an_image_repository.rst @@ -0,0 +1,127 @@ +:original_name: swr_02_0033.html + +.. _swr_02_0033: + +Querying the Brief Information on an Image Repository +===================================================== + +Function +-------- + +Query the brief information on an image repository in an organization. + +URI +--- + +GET /v2/manage/namespaces/{*namespace*}/repos/{*repository*} + +For details about parameters, see :ref:`Table 1 `. + +.. _swr_02_0033__table184146147323: + +.. table:: **Table 1** Parameter description + + ========== ========= ====== ===================== + Parameter Mandatory Type Description + ========== ========= ====== ===================== + namespace Yes String Organization name + repository Yes String Image repository name + ========== ========= ====== ===================== + +Request +------- + +- Request parameters + + N/A + +- Example request + + .. code-block:: text + + GET https://{Endpoint}/v2/manage/namespaces/group/repos/busybox + +Response +-------- + +- Response parameters + + .. table:: **Table 2** Response body parameter description + + +---------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===============+=========+===================================================================================================================================================+ + | id | Integer | Image repository ID. | + +---------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | ns_id | Integer | Organization ID. | + +---------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Image repository name. | + +---------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | category | String | Image repository type. The value can be **app_server**, **linux**, **framework_app**, **database**, **lang**, **other**, **windows**, or **arm**. | + +---------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Brief description of the image repository. | + +---------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | creator_id | String | Image repository creator ID. | + +---------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | creator_name | String | Image repository creator. | + +---------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | size | Integer | Image repository size. | + +---------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | is_public | Boolean | Whether the image repository is a public repository. The value can be **true** or **false**. | + +---------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | num_images | Integer | Number of images in an image repository. | + +---------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | num_download | Integer | Download times of an image repository. | + +---------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | url | String | URL of the image repository logo image. This field has been discarded and is left empty by default. | + +---------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | path | String | External image pull address. The format is {*Repository address*}/{*Namespace name*}/{*Repository name*}. | + +---------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | internal_path | String | Internal image pull address. The format is {*Repository address*}/{*Namespace name*}/{*Repository name*}. | + +---------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | created | String | Time when an image repository is created. It is the UTC standard time. | + +---------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated | String | Time when an image repository is updated. It is the UTC standard time. | + +---------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_id | String | Account ID. | + +---------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | priority | Integer | Image sorting priority. | + +---------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + +- Example response + + .. code-block:: + + { + "id": 865151, + "ns_id": 1334795, + "name": "busybox", + "category": "other", + "description": "containerops", + "creator_id": "050b12577f00269a1fcfc01f65239697", + "creator_name": "admin", + "size": 2099575, + "is_public": false, + "num_images": 1, + "num_download": 0, + "url": "", + "path": "{Repository address}/group/busybox", + "internal_path": "{Repository address}/group/busybox", + "created": "2021-06-02T09:59:25.51307Z", + "updated": "2021-06-02T17:59:25.538056Z", + "domain_id": "da44776c316c4a99b3683bb174f8821b", + "priority": 0 + } + +Status Code +----------- + +=========== ============================================== +Status Code Description +=========== ============================================== +200 Request successful. +400 Request error. Error information is returned. +401 Authentication failed. +404 The repository does not exist. +500 Internal error. Error information is returned. +=========== ============================================== diff --git a/api-ref/source/api/querying_the_details_of_an_organization.rst b/api-ref/source/api/querying_the_details_of_an_organization.rst new file mode 100644 index 0000000..223a492 --- /dev/null +++ b/api-ref/source/api/querying_the_details_of_an_organization.rst @@ -0,0 +1,88 @@ +:original_name: swr_02_0029.html + +.. _swr_02_0029: + +Querying the Details of an Organization +======================================= + +Function +-------- + +Query the details of an organization by its name. + +URI +--- + +GET /v2/manage/namespaces/{*namespace*} + +For details about parameters, see :ref:`Table 1 `. + +.. _swr_02_0029__table05962819187: + +.. table:: **Table 1** Parameter description + + ========= ========= ====== ================= + Parameter Mandatory Type Description + ========= ========= ====== ================= + namespace Yes String Organization name + ========= ========= ====== ================= + +Request +------- + +- Request parameters + + N/A + +- Example request + + .. code-block:: text + + GET https://{Endpoint}/v2/manage/namespaces/group + +Response +-------- + +- Response parameters + + .. table:: **Table 2** Response body parameter description + + +-----------------------+-----------------------+-----------------------+ + | Parameter | Type | Description | + +=======================+=======================+=======================+ + | id | Integer | Organization ID | + +-----------------------+-----------------------+-----------------------+ + | name | String | Organization name | + +-----------------------+-----------------------+-----------------------+ + | creator_name | String | IAM username | + +-----------------------+-----------------------+-----------------------+ + | auth | Integer | User permission | + | | | | + | | | - 7: Manage | + | | | - 3: Write | + | | | - 1: Read | + +-----------------------+-----------------------+-----------------------+ + +- Example response + + .. code-block:: + + { + "id": 1422, + "name": "group", + "creator_name": "username", + "auth": 7 + } + +Status Code +----------- + +=========== ================================ +Status Code Description +=========== ================================ +200 Query succeeded. +400 Request error. +401 Authentication failed. +404 The organization does not exist. +500 Internal error. +=========== ================================ diff --git a/api-ref/source/api/querying_the_image_repository_list.rst b/api-ref/source/api/querying_the_image_repository_list.rst new file mode 100644 index 0000000..67ec47f --- /dev/null +++ b/api-ref/source/api/querying_the_image_repository_list.rst @@ -0,0 +1,178 @@ +:original_name: swr_02_0034.html + +.. _swr_02_0034: + +Querying 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 :ref:`Table 1 `. + +.. caution:: + + At least one filter parameter must be transferred. + +.. _swr_02_0034__table11843162810214: + +.. table:: **Table 1** Parameter description + + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+===================================================================================================================================================+ + | center | No | String | The value can only be self, indicating that the image is a self-owned image. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | namespace | No | String | Organization name. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | No | String | Image repository name. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | category | No | String | Image repository type. The value can be **app_server**, **linux**, **framework_app**, **database**, **lang**, **other**, **windows**, or **arm**. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | No | String | Start index. | + | | | | | + | | | | Ensure that the **offset** and **limit** parameters are used together. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | No | String | Number of returned records. | + | | | | | + | | | | Ensure that the **offset** and **limit** parameters are used together. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | order_column | No | 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. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | order_type | No | 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. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request +------- + +- Request parameters + + N/A + +- Example request + + .. code-block:: text + + GET https://{Endpoint}/v2/manage/repos?filter=center::self|namespace::group|name::busybox + +Response +-------- + +- Response parameters + + .. table:: **Table 2** Response header parameter description + + +---------------+--------+----------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===============+========+====================================================================================================+ + | Content-Range | String | Offset (Start index)-Count (Number of records on the current page)/Total (Total number of records) | + +---------------+--------+----------------------------------------------------------------------------------------------------+ + + .. note:: + + If the **offset** and **limit** parameters are transferred in the request, **Content-Range** will be added to the response header. + + .. table:: **Table 3** Response body parameter description + + +-------------------+------------------------------------------------------------+------------------------+ + | Parameter | Type | Description | + +===================+============================================================+========================+ + | *[Array element]* | Array of :ref:`objects ` | Image repository list. | + +-------------------+------------------------------------------------------------+------------------------+ + + .. _swr_02_0034__table45446245174724: + + .. table:: **Table 4** *[Array element]* parameters description + + +---------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===============+==================+===================================================================================================================================================+ + | name | String | Image repository name. | + +---------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | category | String | Image repository type. The value can be **app_server**, **linux**, **framework_app**, **database**, **lang**, **other**, **windows**, or **arm**. | + +---------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Image repository description. | + +---------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | size | Integer | Total size of the images in an image repository. | + +---------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | is_public | Boolean | Whether the image is a public image. The value can be **true** or **false**. | + +---------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | num_images | Integer | Number of image tags in an image repository. | + +---------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | num_download | Integer | Download times. | + +---------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Time when an image repository is created. It is the UTC standard time. | + +---------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Time when an image repository is updated. It is the UTC standard time. | + +---------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | logo | String | (Reserved field) Image repository logo address. | + +---------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | url | String | (Reserved field) URL of the image repository logo. | + +---------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | path | String | External Docker pull address. The format is {*Repository address*}/{*Namespace name*}/{*Repository name*}. | + +---------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | internal_path | String | Internal Docker pull address. The format is {*Repository address*}/{*Namespace name*}/{*Repository name*}. | + +---------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_name | String | Account name. | + +---------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | namespace | String | Organization name. | + +---------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | Array of strings | Image tag list. | + +---------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | Boolean | (Reserved field) Status. | + +---------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | total_range | Integer | Total number of records. | + +---------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + +- Example response + + .. code-block:: + + [ + { + "name": "busybox", + "category": "linux", + "description": "this is a busybox repository", + "size": 200977474, + "is_public": false, + "num_images": 2, + "num_download": 0, + "created_at": "2021-06-10T03:24:44.784402Z", + "updated_at": "2021-06-10T03:40:59.199352Z", + "logo": "", + "url": "", + "path": "{Repository address}/group/busybox", + "internal_path": "{Repository address}/group/busybox", + "domain_name": "root", + "namespace": "group", + "tags": [ + "latest", + "log" + ], + "status": false, + "total_range": 1 + } + ] + +Status Code +----------- + +=========== ============================================== +Status Code Description +=========== ============================================== +200 Request successful. +400 Request error. Error information is returned. +401 Authentication failed. +500 Internal error. Error information is returned. +=========== ============================================== diff --git a/api-ref/source/api/querying_the_list_of_image_repository_tags.rst b/api-ref/source/api/querying_the_list_of_image_repository_tags.rst new file mode 100644 index 0000000..9deed64 --- /dev/null +++ b/api-ref/source/api/querying_the_list_of_image_repository_tags.rst @@ -0,0 +1,148 @@ +:original_name: swr_02_0035.html + +.. _swr_02_0035: + +Querying 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*} + +For details about parameters, see :ref:`Table 1 `. + +.. _swr_02_0035__table11843162810214: + +.. table:: **Table 1** Parameter description + + +--------------+-----------+---------+------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+=========+======================================================================================================+ + | namespace | Yes | String | Organization name | + +--------------+-----------+---------+------------------------------------------------------------------------------------------------------+ + | repository | Yes | String | Image repository name. | + +--------------+-----------+---------+------------------------------------------------------------------------------------------------------+ + | offset | No | Integer | Start index. | + +--------------+-----------+---------+------------------------------------------------------------------------------------------------------+ + | limit | No | Integer | Number of responses. | + +--------------+-----------+---------+------------------------------------------------------------------------------------------------------+ + | order_column | No | String | Sorting by column. You can set this parameter to **updated_at** (sorting by update time). | + +--------------+-----------+---------+------------------------------------------------------------------------------------------------------+ + | order_type | No | String | Sorting type. You can set this parameter to **desc** (descending sort) and **asc** (ascending sort). | + +--------------+-----------+---------+------------------------------------------------------------------------------------------------------+ + | tag | No | String | Image tag name. | + +--------------+-----------+---------+------------------------------------------------------------------------------------------------------+ + +Request +------- + +- Request parameters + + N/A + +- Example request + + .. code-block:: text + + GET https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/tags + +Response +-------- + +- Response parameters + + .. table:: **Table 2** Response body parameter description + + +-------------------+------------------------------------------------------------+----------------------------+ + | Parameter | Type | Description. | + +===================+============================================================+============================+ + | *[Array element]* | Array of :ref:`objects ` | Image repository tag list. | + +-------------------+------------------------------------------------------------+----------------------------+ + + .. _swr_02_0035__table45446245174724: + + .. table:: **Table 3** *[Array element]* parameters description + + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+===========================================================================================================================================================================+ + | id | Integer | ID | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | repo_id | Integer | Repository ID. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Tag | String | Image tag name. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | image_id | String | Image ID. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | manifest | String | Image manifest. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | digest | String | SHA value of an image. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | schema | Integer | Docker protocol version. The version can be **1** or **2**. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | path | String | External image pull address. The format is {*Repository address*}/{*Namespace name*}/{*Repository name*}:{*Tag name*}. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | internal_path | String | 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 | Boolean | By default, the value is **false**. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created | 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. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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 was deleted. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_id | String | Account ID. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tag_type | Integer | 0: manifest. 1: manifest list. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +- Example response + + .. code-block:: + + [ + { + "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": "{Repository address}/group/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": "0503dda878000fed0f75c0096d70a960", + "tag_type": 0 + } + ] + +Status Code +----------- + +=========== ========================================================== +Status Code Description +=========== ========================================================== +200 All tags in the image repository are successfully queried. +400 Request error. Error information is returned. +401 Authentication failed. +404 The repository does not exist. +500 Internal error. Error information is returned. +=========== ========================================================== diff --git a/api-ref/source/api/querying_the_list_of_organizations.rst b/api-ref/source/api/querying_the_list_of_organizations.rst new file mode 100644 index 0000000..6d35cc5 --- /dev/null +++ b/api-ref/source/api/querying_the_list_of_organizations.rst @@ -0,0 +1,102 @@ +:original_name: swr_02_0028.html + +.. _swr_02_0028: + +Querying the List of Organizations +================================== + +Function +-------- + +Query the list of organizations. + +URI +--- + +GET /v2/manage/namespaces?filter=namespace::{*namespace*} + +For details about parameters, see :ref:`Table 1 `. + +.. _swr_02_0028__tae82a09e27434bef9a38b734d798ae6c: + +.. table:: **Table 1** Parameter description + + ========= ========= ====== ================= + Parameter Mandatory Type Description + ========= ========= ====== ================= + namespace No String Organization name + ========= ========= ====== ================= + +Request +------- + +- Request parameters + + N/A + +- Example request + + .. code-block:: text + + GET https://{Endpoint}/v2/manage/namespaces?filter=namespace::group + +Response +-------- + +- Response parameters + + .. table:: **Table 2** Response body parameter description + + +------------+-----------------------------------------------------------+-------------------+ + | Parameter | Type | Description | + +============+===========================================================+===================+ + | namespaces | Array of :ref:`objects ` | Organization list | + +------------+-----------------------------------------------------------+-------------------+ + + .. _swr_02_0028__table1787854911167: + + .. table:: **Table 3** namespaces parameter description + + +-----------------------+-----------------------+-----------------------+ + | Parameter | Type | Description | + +=======================+=======================+=======================+ + | ID | Integer | Organization ID | + +-----------------------+-----------------------+-----------------------+ + | name | String | Organization name | + +-----------------------+-----------------------+-----------------------+ + | creator_name | String | IAM username | + +-----------------------+-----------------------+-----------------------+ + | auth | Integer | User permission | + | | | | + | | | - 7: Manage | + | | | - 3: Write | + | | | - 1: Read | + +-----------------------+-----------------------+-----------------------+ + +- Example response + + .. code-block:: + + { + "namespaces": [ + { + "id": 1343008, + "name": "group", + "creator_name": "username", + "auth": 7 + } + ] + } + +Status Code +----------- + +=========== ================================ +Status Code Description +=========== ================================ +200 Query succeeded. +400 Request error. +401 Authentication failed. +404 The organization does not exist. +500 Internal error. +=========== ================================ diff --git a/api-ref/source/api/updating_an_account_used_for_image_sharing.rst b/api-ref/source/api/updating_an_account_used_for_image_sharing.rst new file mode 100644 index 0000000..ec34333 --- /dev/null +++ b/api-ref/source/api/updating_an_account_used_for_image_sharing.rst @@ -0,0 +1,82 @@ +:original_name: swr_02_0072.html + +.. _swr_02_0072: + +Updating an Account Used for Image Sharing +========================================== + +Function +-------- + +Update an account used for image sharing. + +URI +--- + +PATCH /v2/manage/namespaces/{*namespace*}/repositories/{*repository*}/access-domains/{*access_domain*} + +For details about parameters, see :ref:`Table 1 `. + +.. _swr_02_0072__table11843162810214: + +.. table:: **Table 1** Parameter description + + +---------------+-----------+--------+--------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===============+===========+========+============================================+ + | namespace | Yes | String | Organization name | + +---------------+-----------+--------+--------------------------------------------+ + | repository | Yes | String | Image repository name | + +---------------+-----------+--------+--------------------------------------------+ + | access_domain | Yes | String | Name of the account used for image sharing | + +---------------+-----------+--------+--------------------------------------------+ + +Request +------- + +- Request parameters + + .. table:: **Table 2** Request body parameter description + + +-------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=============+===========+========+===========================================================================================================================================+ + | permit | Yes | String | 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. | + +-------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Description. This parameter is left blank by default. | + +-------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------+ + +- Example request + + .. code-block:: + + PATCH https://{Endpoint}/v2/manage/namespaces/group/repositories/busybox/access-domains/domain_name + + Body: + + .. code-block:: + + { + "permit": "read", + "deadline": "forever", + "description": "description" + } + +Response +-------- + +N/A + +Status Code +----------- + +=========== ====================== +Status Code Description +=========== ====================== +201 Modified successfully. +400 Request error. +401 Authentication failed. +500 Internal error. +=========== ====================== diff --git a/api-ref/source/api/updating_image_permissions.rst b/api-ref/source/api/updating_image_permissions.rst new file mode 100644 index 0000000..b925054 --- /dev/null +++ b/api-ref/source/api/updating_image_permissions.rst @@ -0,0 +1,94 @@ +:original_name: swr_02_0048.html + +.. _swr_02_0048: + +Updating Image Permissions +========================== + +Function +-------- + +Update the image operation permissions for certain users. + +URI +--- + +PATCH /v2/manage/namespaces/{*namespace*}/repos/{*repository*}/access + +For details about parameters, see :ref:`Table 1 `. + +.. _swr_02_0048__table73271639103420: + +.. table:: **Table 1** Parameter description + + ========== ========= ====== ================= + Parameter Mandatory Type Description + ========== ========= ====== ================= + namespace Yes String Organization name + repository Yes String Image name + ========== ========= ====== ================= + +Request +------- + +- Request parameters + + .. table:: **Table 2** Request body parameter description + + +-----------------+-----------------+-----------------+-------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=====================================+ + | user_id | Yes | String | User ID. | + +-----------------+-----------------+-----------------+-------------------------------------+ + | user_name | Yes | String | Username. | + +-----------------+-----------------+-----------------+-------------------------------------+ + | auth | Yes | Integer | User permission that is configured. | + | | | | | + | | | | - 7: Manage | + | | | | - 3: Write | + | | | | - 1: Read | + +-----------------+-----------------+-----------------+-------------------------------------+ + +- Example request + + .. code-block:: + + PATCH https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/access + + Body: + + .. code-block:: + + [ + { + "user_id": "fb3f175c1fd146ab8cdae3272be6107b", + "user_name": "user01", + "auth": 7 + } + ] + +Response +-------- + +- Response parameters + + N/A + +- Example response + + .. code-block:: + + {} + +Status Code +----------- + +=========== ================================================= +Status Code Description +=========== ================================================= +201 Updated successfully. +400 Request error. +401 Authentication failed. +404 The image or the image permission does not exist. +500 Internal error. +=========== ================================================= diff --git a/api-ref/source/api/updating_organization_permissions.rst b/api-ref/source/api/updating_organization_permissions.rst new file mode 100644 index 0000000..1c40d60 --- /dev/null +++ b/api-ref/source/api/updating_organization_permissions.rst @@ -0,0 +1,103 @@ +:original_name: swr_02_0044.html + +.. _swr_02_0044: + +Updating Organization Permissions +================================= + +Function +-------- + +Update the organization operation permissions for certain users. + +URI +--- + +PATCH /v2/manage/namespaces/{*namespace*}/access + +For details about parameters, see :ref:`Table 1 `. + +.. _swr_02_0044__table73271639103420: + +.. table:: **Table 1** Parameter description + + ========= ========= ====== ================== + Parameter Mandatory Type Description + ========= ========= ====== ================== + namespace Yes String Organization name. + ========= ========= ====== ================== + +Request +------- + +- Request parameters + + .. table:: **Table 2** Request body parameter description + + +-----------------+-----------+--------------------------------------------------------+------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+===========+========================================================+============================================================+ + | [Array element] | Yes | Array of :ref:`objects ` | Information required for updating organization permissions | + +-----------------+-----------+--------------------------------------------------------+------------------------------------------------------------+ + + .. _swr_02_0044__table6912142367: + + .. table:: **Table 3** [Array element] + + +-----------------+-----------------+-----------------+-----------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=================+ + | user_id | Yes | String | User ID. | + +-----------------+-----------------+-----------------+-----------------+ + | user_name | Yes | String | Username. | + +-----------------+-----------------+-----------------+-----------------+ + | auth | Yes | Integer | User permission | + | | | | | + | | | | - 7: Manage | + | | | | - 3: Write | + | | | | - 1: Read | + +-----------------+-----------------+-----------------+-----------------+ + +- Example request + + .. code-block:: + + PATCH https://{Endpoint}/v2/manage/namespaces/group/access + + Body: + + .. code-block:: + + [ + { + "user_id": "fb3f175c1fd146ab8cdae3272be6107b", + "user_name": "user01", + "auth": 7 + } + ] + +Response +-------- + +- Response parameters + + N/A + +- Example response + + .. code-block:: + + {} + +Status Code +----------- + +=========== ================================ +Status Code Description +=========== ================================ +201 Updated successfully. +400 Request error. +401 Authentication failed. +404 The organization does not exist. +500 Internal error. +=========== ================================ diff --git a/api-ref/source/api/updating_the_brief_information_on_an_image_repository.rst b/api-ref/source/api/updating_the_brief_information_on_an_image_repository.rst new file mode 100644 index 0000000..d336c25 --- /dev/null +++ b/api-ref/source/api/updating_the_brief_information_on_an_image_repository.rst @@ -0,0 +1,103 @@ +:original_name: swr_02_0032.html + +.. _swr_02_0032: + +Updating the Brief Information on an Image Repository +===================================================== + +Function +-------- + +Update the brief information on an image repository in an organization, including the **category**, **is_public**, and **description**. + +URI +--- + +PATCH /v2/manage/namespaces/{*namespace*}/repos/{*repository*} + +For details about parameters, see :ref:`Table 1 `. + +.. _swr_02_0032__table16521054337: + +.. table:: **Table 1** Parameter description + + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+===========================================================================================================================+ + | namespace | Yes | String | Organization name. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------+ + | repository | Yes | 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**. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------+ + +Request +------- + +- Request parameters + + N/A + +- Example request + + .. code-block:: + + PATCH https://{Endpoint}/v2/manage/namespaces/group/repos/busybox + + Body: + + .. code-block:: + + -F "category=linux" \ + -F "description=this is a busybox repository" \ + -F "is_public=false" + + Or + + .. code-block:: + + { + "category": "linux", + "description": "this is a busybox repository", + "is_public": false + } + + .. note:: + + The form format will no longer be supported soon. You are advised to use the body in the JSON format to call the API. + +Response +-------- + +- Response parameters + + N/A + +- Example response + + .. code-block:: + + {} + +Status Code +----------- + ++-------------+---------------------------------------------------------------------------+ +| Status Code | Description | ++=============+===========================================================================+ +| 201 | The brief information about the image repository is successfully updated. | ++-------------+---------------------------------------------------------------------------+ +| 400 | Request error. Error information is returned. | ++-------------+---------------------------------------------------------------------------+ +| 401 | Authentication failed. | ++-------------+---------------------------------------------------------------------------+ +| 404 | The repository does not exist. | ++-------------+---------------------------------------------------------------------------+ +| 500 | Internal error. Error information is returned. | ++-------------+---------------------------------------------------------------------------+ diff --git a/api-ref/source/api/viewing_the_list_of_shared_images.rst b/api-ref/source/api/viewing_the_list_of_shared_images.rst new file mode 100644 index 0000000..fc60ad5 --- /dev/null +++ b/api-ref/source/api/viewing_the_list_of_shared_images.rst @@ -0,0 +1,160 @@ +:original_name: swr_02_0075.html + +.. _swr_02_0075: + +Viewing 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 :ref:`Table 1 `. + +.. _swr_02_0075__table591824984318: + +.. table:: **Table 1** Parameter description + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+====================================================================================================+ + | center | Yes | String | - **self**: images shared by you. | + | | | | - **thirdparty**: images shared with you by others. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------+ + | name | No | String | Image repository name. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------+ + | limit | No | String | Number of returned records. Ensure that the **offset** and **limit** parameters are used together. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------+ + | offset | No | String | Start index. Ensure that the **offset** and **limit** parameters are used together. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------+ + +Request +------- + +- Request parameters + + N/A + +- Example request + + .. code-block:: text + + GET https://{Endpoint}/v2/manage/shared-repositories?filter=center::self|name::busybox + +Response +-------- + +- Response parameters + + .. table:: **Table 2** Response header parameter description + + +---------------+--------+----------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===============+========+====================================================================================================+ + | Content-Range | String | Offset (Start index)-Count (Number of records on the current page)/Total (Total number of records) | + +---------------+--------+----------------------------------------------------------------------------------------------------+ + + .. note:: + + If the **offset** and **limit** parameters are transferred in the request, **Content-Range** will be added to the response header. + + .. table:: **Table 3** Response body parameter description + + +-------------------+------------------------------------------------------------+------------------------------------+ + | Parameter | Type | Description | + +===================+============================================================+====================================+ + | *[Array element]* | Array of :ref:`objects ` | Viewing the list of shared images. | + +-------------------+------------------------------------------------------------+------------------------------------+ + + .. _swr_02_0075__table45446245174724: + + .. table:: **Table 4** *[Array element]* parameters description + + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+===================================================================================================================================================+ + | name | String | Image repository name. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | category | String | Image repository type. The value can be **app_server**, **linux**, **framework_app**, **database**, **lang**, **other**, **windows**, or **arm**. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Image repository description. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | size | Integer | Total size of the images in an image repository. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | is_public | Boolean | Whether the image is a public image. The value can be **true** or **false**. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | num_images | Integer | Number of image tags in an image repository. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | num_download | Integer | Download times. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Time when an image repository is created. It is the UTC standard time. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Time when an image repository is updated. It is the UTC standard time. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | logo | String | (Reserved field) Image repository logo address. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | url | String | (Reserved field) URL of the image repository logo. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | path | String | External Docker pull address. The format is {*Repository address*}/{*Namespace name*}/{*Repository name*}. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | internal_path | String | Internal Docker pull address. The format is {*Repository address*}/{*Namespace name*}/{*Repository name*}. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_name | String | Account name. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | namespace | String | Organization name. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | Array of strings | Image tag list. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | Boolean | - 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. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | total_range | Integer | Total number of records. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + +- Example response + + .. code-block:: + + [ + { + "name": "busybox", + "category": "other", + "description": "", + "size": 115645792, + "is_public": false, + "num_images": 1, + "num_download": 0, + "created_at": "2021-06-02T09:23:01.751202Z", + "updated_at": "2021-06-10T07:24:35.204517Z", + "logo": "", + "url": "", + "path": "{Repository address}/group/busybox", + "internal_path": "{Repository address}/group/busybox", + "domain_name": "domain", + "namespace": "namespace", + "tags": [ + "v1", + "v2" + ], + "status": true, + "total_range": 1 + } + ] + +Status Code +----------- + +=========== ============================================== +Status Code Description +=========== ============================================== +200 Request successful. +400 Request error. Error information is returned. +401 Authentication failed. +500 Internal error. Error information is returned. +=========== ============================================== diff --git a/api-ref/source/api_usage_guidelines.rst b/api-ref/source/api_usage_guidelines.rst new file mode 100644 index 0000000..9b732f0 --- /dev/null +++ b/api-ref/source/api_usage_guidelines.rst @@ -0,0 +1,12 @@ +:original_name: swr_02_0078.html + +.. _swr_02_0078: + +API Usage Guidelines +==================== + +Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: *https://Endpoint/uri*. In the URL, **uri** indicates the resource path, that is, the API access path. + +Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by **Application/json**. + +For details about how to use APIs, see `API Usage Guidelines `__. diff --git a/api-ref/source/appendixes/error_code.rst b/api-ref/source/appendixes/error_code.rst new file mode 100644 index 0000000..2b1f487 --- /dev/null +++ b/api-ref/source/appendixes/error_code.rst @@ -0,0 +1,408 @@ +:original_name: swr_02_0024.html + +.. _swr_02_0024: + +Error Code +========== + +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. + +.. code-block:: + + [ + { + "errorCode": "SVCSTG.SWR.4001048", + "errorMessage": "Failed to get Token from Context", + "detail": "" + } + ] + +In the preceding information, **errorCode** indicates error code, **errorMessage** indicates error description, and **detail** provides error details. + +Error Code Description +---------------------- + ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Status Code | Error Code | Description | ++=============+====================+======================================================================================================================================================================+ +| 401 | SVCSTG.SWR.4010000 | Authentication failed. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000001 | Internal server error: Failed to obtain the application description. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000002 | Internal server error: Failed to obtain the image information. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000003 | Internal server error: Failed to obtain the image list. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 404 | SVCSTG.SWR.4040004 | The software package does not exist. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000005 | Internal server error: Deletion fails. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 409 | SVCSTG.SWR.4090006 | The image already exists. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000007 | Internal server error: Operation fails. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000008 | Internal server error: Failed to obtain the list. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 404 | SVCSTG.SWR.4040009 | The image list cannot be found. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 404 | SVCSTG.SWR.4040010 | The image does not exist. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000011 | Internal server error: Update fails. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 406 | SVCSTG.SWR.4060012 | Failed to delete the image repository because it contains images. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4000013 | Invalid digest. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4000014 | Invalid parameter. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4000015 | Invalid package name. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4000016 | Invalid version number. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000017 | Internal server error: The application signature function is disabled. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000018 | Internal server error: Failed to read public keys. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000019 | Internal server error: Failed to find local files. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000020 | Internal server error: Failed to obtain session locks. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000021 | Internal server error: Failed to synchronize files. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000022 | Internal server error: Failed to synchronize meta files. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 409 | SVCSTG.SWR.4090023 | The system is busy. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000024 | Internal server error: Failed to generate the SHA value. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 413 | SVCSTG.SWR.4130025 | The file exceeds the maximum size allowed. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000027 | Internal server error: Failed to decompress the package. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4000028 | Incorrect image format. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4000029 | Incorrect image format: The image name is inconsistent. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000030 | Internal server error: Failed to locate the file pointer. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4000031 | Invalid AK/SK. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000032 | Internal server error: JSON conversion fails. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000033 | Internal server error: Failed to save the application file. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000034 | Internal server error: Failed to delete the application. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000035 | Internal server error: Failed to save the application to the database. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000036 | Internal server error: Failed to update the application database. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000037 | Internal server error: Failed to create the signature. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000038 | Internal server error: Failed to delete the signature. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4000039 | Invalid session ID. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000040 | Failed to update status. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000041 | Internal server error: Failed to read the session. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000042 | Internal server error: Failed to reclaim the session. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 404 | SVCSTG.SWR.4040043 | The session does not exist. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000044 | Internal server error: Failed to generate the session. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4000045 | Internal server error: Failed to bind the session. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000046 | Internal server error: Creation fails. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4000047 | This version is not supported. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 404 | SVCSTG.SWR.4040048 | The image tag does not exist. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000049 | Internal server error: Failed to delete the image. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000050 | Internal server error: Failed to generate the digest. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000051 | Internal server error: Failed to obtain the SHA list. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000052 | Internal server error: Failed to reduce image references. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 406 | SVCSTG.SWR.4060053 | Deletion fails. Please first delete the software package. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000054 | Internal server error: Saving fails. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4000055 | No search content. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4000056 | Invalid page size. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000057 | Internal server error: Failed to obtain the organization. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 404 | SVCSTG.SWR.4040058 | The organization does not exist. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000059 | Internal server error: Failed to create the organization. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 409 | SVCSTG.SWR.4090060 | The organization already exists. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000061 | Failed to obtain the IP address of the software instance. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000062 | Failed to obtain the local IP address of the software. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000063 | Failed to obtain the tag list. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4000064 | Invalid image: The manifest file contains empty RepoTags. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4000065 | Invalid image: The manifest file does not have layer information. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4000066 | Invalid image: The manifest file does not have configuration information. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4000067 | Invalid image package: The image package does not have a manifest file. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4000068 | Invalid image: Failed to parse the manifest file. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4000069 | Invalid image: The image format is incorrect or not supported. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 507 | SVCSTG.SWR.5070070 | Your OBS service is disabled or incorrect. Please first check your OBS service. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000071 | Internal server error: Failed to obtain the user list. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000073 | Internal server error: Restoration fails. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000075 | Internal server error: Failed to update the organization. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 409 | SVCSTG.SWR.4090076 | The organization permission already exists. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000077 | Internal server error: Failed to obtain the organization permission. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 404 | SVCSTG.SWR.4040078 | The organization permission does not exist. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000079 | Internal server error: Failed to update the organization permission. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000080 | Internal server error: Failed to create the organization permission. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000081 | Internal server error: Failed to delete the organization permission. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000082 | Internal server error: Failed to parse the JSON file. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 404 | SVCSTG.SWR.4040083 | The requested URL cannot be found. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000084 | Internal server error: Failed to obtain the service. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000085 | Internal server error: Failed to create the tag. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000086 | Internal server error: Failed to update the tag. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000087 | Internal server error: Failed to obtain the image layer. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000088 | Internal server error: Failed to delete the image layer from UDS. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 409 | SVCSTG.SWR.4090089 | The permission already exists. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000090 | Internal server error: Failed to obtain the permission. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 404 | SVCSTG.SWR.4040091 | The permission does not exist. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000092 | Internal server error: Failed to update the permission. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000093 | Internal server error: Failed to create the permission. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4000097 | The maximum number of organizations has been exceeded. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4000098 | The maximum number of images has been exceeded. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4000099 | The maximum number of image tags has been exceeded. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000112 | Internal server error. Failed to obtain the image. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 404 | SVCSTG.SWR.4040113 | The image does not exist. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5000114 | Internal server error. Failed to obtain the image tag. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 404 | SVCSTG.SWR.4040115 | The image tag does not exist. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001000 | **Content-Type** must be set to **multipart/form-data**. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 413 | SVCSTG.SWR.4131001 | The request exceeds the maximum size allowed. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5001002 | Internal server error: The external address is disabled. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001003 | Failed to obtain the form file. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001004 | **Type** must be set to **app**. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001005 | Failed to parse the form. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001006 | Invalid meta file format. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001008 | Invalid organization or name. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001009 | **is_public** must be set to **true** or **false**. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001010 | **Type** must be set to **app** or **image**. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001011 | **Type** must be set to **app**, **image** or left blank. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 413 | SVCSTG.SWR.4131012 | The description exceeds the maximum length allowed. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001013 | **ak** or **sk** cannot be left blank. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001014 | Mandatory parameters must be set. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001015 | The form file cannot be found. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001016 | At least **is_public** and **manifests** must be set. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001018 | Incorrect request body type. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001019 | Failed to parse the form file. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5001020 | Internal server error: Failed to read the form file. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001021 | The version number cannot be left blank. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001022 | Incorrect file type. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001023 | Unsupported file type. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001024 | Failed to query parameters. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001025 | Invalid parameter. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5001026 | Failed to obtain the manifest file. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001027 | **Status** must be set to **done** or **error**. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001028 | Invalid organization name. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001029 | Invalid image name. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001030 | Invalid package. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 403 | SVCSTG.SWR.4031032 | The number of requests exceeds the maximum number allowed. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 403 | SVCSTG.SWR.4031033 | Unavailable request. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001035 | Invalid filtering criteria. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001036 | Parameters are lost. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001037 | The registration center type is not supported. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5001038 | The registration center is unavailable. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5001039 | Search fails. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001041 | Invalid **domain**. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 403 | SVCSTG.SWR.4031042 | There are too many requests. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 403 | SVCSTG.SWR.4031043 | Invalid JWT token request. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 401 | SVCSTG.SWR.4011044 | The image to be uploaded has been created by another user. You do not have the permission to upload the image. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001045 | The **SWRServer** parameter is missing. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5001046 | Internal server error: Failed to check the organization. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5001047 | Internal server error: Failed to save the organization. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001048 | Failed to obtain the token. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5001049 | Internal server error: Failed to delete the organization. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5001050 | Internal server error: Failed to obtain the image layer. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 404 | SVCSTG.SWR.4041051 | The image layer does not exist. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5001052 | Internal server error: Invalid image layer. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5001053 | Internal server error: Invalid upload of an image layer. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5001054 | Internal server error: Failed to create the image layer path. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5001055 | Internal server error: Failed to save the image layer. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 404 | SVCSTG.SWR.4041056 | The image tag does not exist. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5001056 | Internal server error: Failed to obtain the tag list. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 404 | SVCSTG.SWR.4041057 | The tag list does not exist. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5001058 | Internal server error: Failed to save the image. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5001059 | Internal server error: Failed to obtain the image. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 404 | SVCSTG.SWR.4041060 | The manifest file does not exist. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 404 | SVCSTG.SWR.4041061 | The organization does not exist. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5001062 | Internal server error: Failed to update the organization. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5001063 | Internal server error: Failed to delete the image layer. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 401 | SVCSTG.SWR.4011064 | Cross-account error. Insufficient permissions. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001065 | Invalid organization permissions. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001066 | Invalid permissions. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4001067 | Invalid username. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5001076 | Failed to obtain the service token. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 401 | SVCSTG.S2I.4019000 | Authentication error: No user token or user AK/SK information found. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 403 | SVCSTG.SWR.4039001 | You cannot apply for or operate the resources that do not belong to you. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 403 | SVCSTG.SWR.4039002 | You do not have the permission to perform this operation. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4009010 | Invalid organization. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4009011 | Invalid image name. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4009012 | Invalid code source type. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4009013 | Invalid ID. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4009014 | Invalid filtering criteria. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4009015 | Failed to parse the build task. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4009016 | Invalid file path. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4009017 | Invalid source code owner. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4009018 | Invalid source code repository. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4009019 | Invalid source code repository ID. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4009020 | Invalid source code branch. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4009021 | Invalid image label. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4009022 | Invalid source code username. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4009023 | Invalid commit ID. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4006030 | Failed to execute the build task. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | SVCSTG.SWR.4006031 | The build record already exists. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 404 | SVCSTG.SWR.4046032 | The build record does not exist. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5006033 | Failed to obtain the build record from the database. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 403 | SVCSTG.SWR.4037017 | You do not have the permission to edit or manage any organization. Please first create an organization or obtain the edit/management permission of the organization. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 403 | SVCSTG.SWR.4037018 | You do not have the permission to edit or manage any image in the image repository. Please first create an image or obtain an editable/manageable image. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | SVCSTG.SWR.5007019 | Failed to create the image. The maximum number of images have been reached. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 403 | SVCSTG.SWR.4037020 | You do not have the permission to operate the image repository resource. Please improve your organization permissions. | ++-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/appendixes/index.rst b/api-ref/source/appendixes/index.rst new file mode 100644 index 0000000..eb2daa8 --- /dev/null +++ b/api-ref/source/appendixes/index.rst @@ -0,0 +1,16 @@ +:original_name: swr_02_0008.html + +.. _swr_02_0008: + +Appendixes +========== + +- :ref:`Status Codes ` +- :ref:`Error Code ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + status_codes + error_code diff --git a/api-ref/source/appendixes/status_codes.rst b/api-ref/source/appendixes/status_codes.rst new file mode 100644 index 0000000..b8c9513 --- /dev/null +++ b/api-ref/source/appendixes/status_codes.rst @@ -0,0 +1,54 @@ +:original_name: swr_02_0023.html + +.. _swr_02_0023: + +Status Codes +============ + +- Normal + + +----------------+-----------------------------------------------------------------+ + | Returned Value | Description | + +================+=================================================================+ + | 200 OK | The results of GET and PUT operations are returned as expected. | + +----------------+-----------------------------------------------------------------+ + | 201 Created | The results of the POST operation are returned as expected. | + +----------------+-----------------------------------------------------------------+ + | 202 Accepted | The request has been accepted for processing. | + +----------------+-----------------------------------------------------------------+ + | 204 No Content | The results of the DELETE operation are returned as expected. | + +----------------+-----------------------------------------------------------------+ + +- Abnormal + + +-----------------------------------+--------------------------------------------------------------------------------------------+ + | Returned Value | Description | + +===================================+============================================================================================+ + | 400 Bad Request | The server failed to process the request. | + +-----------------------------------+--------------------------------------------------------------------------------------------+ + | 401 Unauthorized | You must enter a username and password to access the requested page. | + +-----------------------------------+--------------------------------------------------------------------------------------------+ + | 403 Forbidden | You are forbidden to access the requested page. | + +-----------------------------------+--------------------------------------------------------------------------------------------+ + | 404 Not Found | The server cannot find the requested page. | + +-----------------------------------+--------------------------------------------------------------------------------------------+ + | 405 Method Not Allowed | You are not allowed to use the method specified in the request. | + +-----------------------------------+--------------------------------------------------------------------------------------------+ + | 406 Not Acceptable | The response generated by the server cannot be accepted by the client. | + +-----------------------------------+--------------------------------------------------------------------------------------------+ + | 407 Proxy Authentication Required | You must use the proxy server for authentication so that the request can be processed. | + +-----------------------------------+--------------------------------------------------------------------------------------------+ + | 408 Request Timeout | The request timed out. | + +-----------------------------------+--------------------------------------------------------------------------------------------+ + | 409 Conflict | The request could not be processed due to a conflict. | + +-----------------------------------+--------------------------------------------------------------------------------------------+ + | 500 Internal Server Error | Failed to complete the request because of a service error. | + +-----------------------------------+--------------------------------------------------------------------------------------------+ + | 501 Not Implemented | Failed to complete the request because the server does not support the requested function. | + +-----------------------------------+--------------------------------------------------------------------------------------------+ + | 502 Bad Gateway | Failed to complete the request because the request is invalid. | + +-----------------------------------+--------------------------------------------------------------------------------------------+ + | 503 Service Unavailable | Failed to complete the request. The service is unavailable. | + +-----------------------------------+--------------------------------------------------------------------------------------------+ + | 504 Gateway Timeout | A gateway timeout error occurred. | + +-----------------------------------+--------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst new file mode 100644 index 0000000..b4acc65 --- /dev/null +++ b/api-ref/source/change_history.rst @@ -0,0 +1,14 @@ +:original_name: swr_02_0064.html + +.. _swr_02_0064: + +Change History +============== + ++--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| Release Date | Description | ++==============+==============================================================================================================================================+ +| 2021-08-30 | Optimized the whole document, including optimizing the function introduction, adding request examples, and improving parameter descriptions. | ++--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| 2020-04-21 | This issue is the first official release. | ++--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index 344dbf0..1de77e7 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -26,9 +26,6 @@ otcdocs_auto_version = False project = 'Software Repository for Containers' otcdocs_repo_name = 'docs/software-repository-container' -# Those variables are required for edit/bug links -otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com' -otcdocs_git_type = 'gitea' # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the @@ -75,12 +72,11 @@ show_authors = False html_theme = 'otcdocs' # Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the +# further. For a list of options available for each theme, see the # documentation. html_theme_options = { - "disable_search": True, - "site_name": "Internal Documentation Portal", - "logo_url": "https://docs-int.otc-service.com", + 'disable_search': True, + 'site_name': 'Internal Documentation Portal' } # The name for this set of Sphinx documents. If None, it defaults to @@ -96,8 +92,8 @@ html_static_path = ['_static'] # -- Options for PDF output -------------------------------------------------- latex_documents = [ - ('index', +('index', 'swr-api-ref.tex', u'Software Repository for Containers - API Reference', u'OpenTelekomCloud', 'manual'), -] +] \ No newline at end of file diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index a0dd253..8d6d53a 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -2,3 +2,10 @@ Software Repository for Containers - API Reference ================================================== +.. toctree:: + :maxdepth: 1 + + api_usage_guidelines + api/index + appendixes/index + change_history