From f5c28c856a77c7481141ec9de22e84237fd0b289 Mon Sep 17 00:00:00 2001 From: "Dong, Qiu Jian" Date: Fri, 18 Oct 2024 07:19:46 +0000 Subject: [PATCH] SWR API update 20241012 Reviewed-by: Eotvos, Oliver Co-authored-by: Dong, Qiu Jian Co-committed-by: Dong, Qiu Jian --- docs/swr/api-ref/.placeholder | 0 docs/swr/api-ref/ALL_META.TXT.json | 601 +++++++++++++++--- docs/swr/api-ref/CLASS.TXT.json | 217 ++++--- .../api-ref/en-us_topic_0000001420528490.html | 25 + .../api-ref/en-us_topic_0000001420688458.html | 17 + .../api-ref/en-us_topic_0000001420846090.html | 21 + .../api-ref/en-us_topic_0000001421005366.html | 21 + .../api-ref/en-us_topic_0000001470804877.html | 23 + .../api-ref/en-us_topic_0000001470924909.html | 21 + .../api-ref/en-us_topic_0000001471005441.html | 17 + .../public_sys-resources/icon-arrowdn.gif | Bin 68 -> 1887 bytes .../public_sys-resources/icon-arrowrt.gif | Bin 70 -> 1890 bytes docs/swr/api-ref/swr_02_0008.html | 2 +- docs/swr/api-ref/swr_02_0011.html | 54 +- docs/swr/api-ref/swr_02_0024.html | 8 +- docs/swr/api-ref/swr_02_0026.html | 104 +-- docs/swr/api-ref/swr_02_0027.html | 41 +- docs/swr/api-ref/swr_02_0028.html | 149 +++-- docs/swr/api-ref/swr_02_0029.html | 106 ++- docs/swr/api-ref/swr_02_0030.html | 157 +++-- docs/swr/api-ref/swr_02_0031.html | 101 ++- docs/swr/api-ref/swr_02_0032.html | 184 +++--- docs/swr/api-ref/swr_02_0033.html | 6 +- docs/swr/api-ref/swr_02_0034.html | 103 +-- docs/swr/api-ref/swr_02_0035.html | 247 ++++--- docs/swr/api-ref/swr_02_0036.html | 39 +- docs/swr/api-ref/swr_02_0042.html | 150 +++-- docs/swr/api-ref/swr_02_0043.html | 60 +- docs/swr/api-ref/swr_02_0044.html | 102 ++- docs/swr/api-ref/swr_02_0045.html | 140 ++-- docs/swr/api-ref/swr_02_0046.html | 104 ++- docs/swr/api-ref/swr_02_0047.html | 110 ++-- docs/swr/api-ref/swr_02_0048.html | 161 +++-- docs/swr/api-ref/swr_02_0049.html | 167 +++-- docs/swr/api-ref/swr_02_0064.html | 7 +- docs/swr/api-ref/swr_02_0070.html | 84 ++- docs/swr/api-ref/swr_02_0071.html | 41 +- docs/swr/api-ref/swr_02_0072.html | 68 +- docs/swr/api-ref/swr_02_0073.html | 126 ++-- docs/swr/api-ref/swr_02_0074.html | 163 +++-- docs/swr/api-ref/swr_02_0075.html | 259 +++++--- docs/swr/api-ref/swr_02_0080.html | 116 ++-- docs/swr/api-ref/swr_02_0081.html | 45 +- 43 files changed, 2870 insertions(+), 1297 deletions(-) delete mode 100644 docs/swr/api-ref/.placeholder create mode 100644 docs/swr/api-ref/en-us_topic_0000001420528490.html create mode 100644 docs/swr/api-ref/en-us_topic_0000001420688458.html create mode 100644 docs/swr/api-ref/en-us_topic_0000001420846090.html create mode 100644 docs/swr/api-ref/en-us_topic_0000001421005366.html create mode 100644 docs/swr/api-ref/en-us_topic_0000001470804877.html create mode 100644 docs/swr/api-ref/en-us_topic_0000001470924909.html create mode 100644 docs/swr/api-ref/en-us_topic_0000001471005441.html diff --git a/docs/swr/api-ref/.placeholder b/docs/swr/api-ref/.placeholder deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/swr/api-ref/ALL_META.TXT.json b/docs/swr/api-ref/ALL_META.TXT.json index c7fde3e7..2e2982ec 100644 --- a/docs/swr/api-ref/ALL_META.TXT.json +++ b/docs/swr/api-ref/ALL_META.TXT.json @@ -1,331 +1,764 @@ [ + { + "dockw":"API Reference" + }, { "uri":"swr_02_0078.html", + "node_id":"swr_02_0078.xml", "product_code":"swr", "code":"1", "des":"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 ", "doc_type":"api", "kw":"API Usage Guidelines,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], "title":"API Usage Guidelines", "githuburl":"" }, { "uri":"swr_02_0011.html", + "node_id":"swr_02_0011.xml", "product_code":"swr", "code":"2", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"API", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], "title":"API", "githuburl":"" }, { - "uri":"swr_02_0026.html", + "uri":"en-us_topic_0000001420846090.html", + "node_id":"en-us_topic_0000001420846090.xml", "product_code":"swr", "code":"3", - "des":"Create an organization.POST /v2/manage/namespacesRequest parametersRequest body parameter descriptionParameterMandatoryTypeDescriptionnamespaceYesStringOrganization name.", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"Creating an Organization,API,API Reference", + "kw":"Organization Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], + "title":"Organization Management", + "githuburl":"" + }, + { + "uri":"swr_02_0026.html", + "node_id":"swr_02_0026.xml", + "product_code":"swr", + "code":"4", + "des":"Create an organization.POST /v2/manage/namespacesN/AN/A", + "doc_type":"api", + "kw":"Creating an Organization,Organization Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], "title":"Creating an Organization", "githuburl":"" }, { "uri":"swr_02_0027.html", + "node_id":"swr_02_0027.xml", "product_code":"swr", - "code":"4", - "des":"Delete an organization.DELETE /v2/manage/namespaces/{namespace}For details about parameters, see Table 1.Request parametersN/AN/AExample requestDELETE https://{Endpoint}/", + "code":"5", + "des":"Delete an organization.DELETE /v2/manage/namespaces/{namespace}For details about parameters, see Table 1.N/A", "doc_type":"api", - "kw":"Deleting an Organization,API,API Reference", + "kw":"Deleting an Organization,Organization Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], "title":"Deleting an Organization", "githuburl":"" }, { "uri":"swr_02_0028.html", + "node_id":"swr_02_0028.xml", "product_code":"swr", - "code":"5", - "des":"Query the list of organizations.GET /v2/manage/namespaces?filter=namespace::{namespace}For details about parameters, see Table 1.Request parametersN/AN/AExample requestGE", + "code":"6", + "des":"Query the list of organizations.GET /v2/manage/namespacesBy default, all organizations will be returned.Status code: 200The list of organizations is returned successfully", "doc_type":"api", - "kw":"Querying the List of Organizations,API,API Reference", + "kw":"Querying the List of Organizations,Organization Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], "title":"Querying the List of Organizations", "githuburl":"" }, { "uri":"swr_02_0029.html", + "node_id":"swr_02_0029.xml", "product_code":"swr", - "code":"6", - "des":"Query the details of an organization by its name.GET /v2/manage/namespaces/{namespace}For details about parameters, see Table 1.Request parametersN/AN/AExample requestGET", + "code":"7", + "des":"Query the details of an organization by its name.GET /v2/manage/namespaces/{namespace}For details about parameters, see Table 1.Status code: 200Response body parameter de", "doc_type":"api", - "kw":"Querying the Details of an Organization,API,API Reference", + "kw":"Querying the Details of an Organization,Organization Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], "title":"Querying the Details of an Organization", "githuburl":"" }, { - "uri":"swr_02_0030.html", + "uri":"en-us_topic_0000001420528490.html", + "node_id":"en-us_topic_0000001420528490.xml", "product_code":"swr", - "code":"7", - "des":"Create an image repository in an organization.POST /v2/manage/namespaces/{namespace}/reposFor details about parameters, see Table 1.Request parametersFormData parameter d", + "code":"8", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"Creating an Image Repository,API,API Reference", + "kw":"Image Repository Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], + "title":"Image Repository Management", + "githuburl":"" + }, + { + "uri":"swr_02_0030.html", + "node_id":"swr_02_0030.xml", + "product_code":"swr", + "code":"9", + "des":"Create an image repository in an organization.POST /v2/manage/namespaces/{namespace}/reposFor details about parameters, see Table 1.NoneNoneFor details, see Error Codes.", + "doc_type":"api", + "kw":"Creating an Image Repository,Image Repository Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], "title":"Creating an Image Repository", "githuburl":"" }, { "uri":"swr_02_0031.html", + "node_id":"swr_02_0031.xml", "product_code":"swr", - "code":"8", - "des":"Delete an image repository in an organization.DELETE /v2/manage/namespaces/{namespace}/repos/{repository}For details about parameters, see Table 1.Request parametersN/AN/", + "code":"10", + "des":"Delete an image repository in an organization.DELETE /v2/manage/namespaces/{namespace}/repos/{repository}For details about parameters, see Table 1.NoneNoneFor details, se", "doc_type":"api", - "kw":"Deleting an Image Repository,API,API Reference", + "kw":"Deleting an Image Repository,Image Repository Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], "title":"Deleting an Image Repository", "githuburl":"" }, { "uri":"swr_02_0032.html", + "node_id":"swr_02_0032.xml", "product_code":"swr", - "code":"9", + "code":"11", "des":"Update the brief information on an image repository in an organization, including the category, is_public, and description.PATCH /v2/manage/namespaces/{namespace}/repos/{", "doc_type":"api", - "kw":"Updating the Brief Information on an Image Repository,API,API Reference", + "kw":"Updating the Brief Information on an Image Repository,Image Repository Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], "title":"Updating the Brief Information on an Image Repository", "githuburl":"" }, { "uri":"swr_02_0033.html", + "node_id":"swr_02_0033.xml", "product_code":"swr", - "code":"10", + "code":"12", "des":"Query the brief information on an image repository in an organization.GET /v2/manage/namespaces/{namespace}/repos/{repository}For details about parameters, see Table 1.Re", "doc_type":"api", - "kw":"Querying the Brief Information on an Image Repository,API,API Reference", + "kw":"Querying the Brief Information on an Image Repository,Image Repository Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], "title":"Querying the Brief Information on an Image Repository", "githuburl":"" }, { "uri":"swr_02_0034.html", + "node_id":"swr_02_0034.xml", "product_code":"swr", - "code":"11", - "des":"Query the image repository list.GET /v2/manage/repos?filter=center::self|namespace::{namespace}|name::{name}|category::{category}|offset::{offset}|limit::{limit}|order_co", + "code":"13", + "des":"Query the image repository list.GET /v2/manage/reposRequest parametersN/AN/AExample requestGET https://{Endpoint}/v2/manage/repos?center=self&namespace=group&name=busybox", "doc_type":"api", - "kw":"Querying the Image Repository List,API,API Reference", + "kw":"Querying the Image Repository List,Image Repository Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], "title":"Querying the Image Repository List", "githuburl":"" }, { - "uri":"swr_02_0035.html", + "uri":"swr_02_0075.html", + "node_id":"swr_02_0075.xml", "product_code":"swr", - "code":"12", - "des":"Query all image tags of an image repository.GET /v2/manage/namespaces/{namespace}/repos/{repository}/tags?filter=offset::{offset}|limit::{limit}|order_column::{order_colu", + "code":"14", + "des":"View the list of shared images.GET /v2/manage/shared-repositoriesRequest parametersN/AN/AExample requestGET https://{Endpoint}/v2/manage/shared-repositories?center=self&n", "doc_type":"api", - "kw":"Querying the List of Image Repository Tags,API,API Reference", + "kw":"Viewing the List of Shared Images,Image Repository Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], + "title":"Viewing the List of Shared Images", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000001420688458.html", + "node_id":"en-us_topic_0000001420688458.xml", + "product_code":"swr", + "code":"15", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Image Tag Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], + "title":"Image Tag Management", + "githuburl":"" + }, + { + "uri":"swr_02_0035.html", + "node_id":"swr_02_0035.xml", + "product_code":"swr", + "code":"16", + "des":"Query all image tags of an image repository.GET /v2/manage/namespaces/{namespace}/repos/{repository}/tags?offset={offset}&limit={limit}&order_column={order_column}&order_", + "doc_type":"api", + "kw":"Querying the List of Image Repository Tags,Image Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], "title":"Querying the List of Image Repository Tags", "githuburl":"" }, { "uri":"swr_02_0036.html", + "node_id":"swr_02_0036.xml", "product_code":"swr", - "code":"13", + "code":"17", "des":"Delete the image with a specified tag in an image repository.DELETE /v2/manage/namespaces/{namespace}/repos/{repository}/tags/{tag}For details about parameters, see Table", "doc_type":"api", - "kw":"Deleting the Image with a Specified Tag,API,API Reference", + "kw":"Deleting the Image with a Specified Tag,Image Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], "title":"Deleting the Image with a Specified Tag", "githuburl":"" }, { - "uri":"swr_02_0070.html", + "uri":"en-us_topic_0000001470804877.html", + "node_id":"en-us_topic_0000001470804877.xml", "product_code":"swr", - "code":"14", + "code":"18", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Shared Account Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], + "title":"Shared Account Management", + "githuburl":"" + }, + { + "uri":"swr_02_0070.html", + "node_id":"swr_02_0070.xml", + "product_code":"swr", + "code":"19", "des":"Create an account used for image sharing. You can share your private images with other users, granting them permissions to pull the images.POST /v2/manage/namespaces/{nam", "doc_type":"api", - "kw":"private images,Creating an Account Used for Image Sharing,API,API Reference", + "kw":"private images,Creating an Account Used for Image Sharing,Shared Account Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], "title":"Creating an Account Used for Image Sharing", "githuburl":"" }, { "uri":"swr_02_0071.html", + "node_id":"swr_02_0071.xml", "product_code":"swr", - "code":"15", + "code":"20", "des":"Delete an account used for image sharing.DELETE /v2/manage/namespaces/{namespace}/repositories/{repository}/access-domains/{access_domain}For details about parameters, se", "doc_type":"api", - "kw":"Deleting an Account Used for Image Sharing,API,API Reference", + "kw":"Deleting an Account Used for Image Sharing,Shared Account Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], "title":"Deleting an Account Used for Image Sharing", "githuburl":"" }, { "uri":"swr_02_0072.html", + "node_id":"swr_02_0072.xml", "product_code":"swr", - "code":"16", + "code":"21", "des":"Update an account used for image sharing.PATCH /v2/manage/namespaces/{namespace}/repositories/{repository}/access-domains/{access_domain}For details about parameters, see", "doc_type":"api", - "kw":"Updating an Account Used for Image Sharing,API,API Reference", + "kw":"Updating an Account Used for Image Sharing,Shared Account Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], "title":"Updating an Account Used for Image Sharing", "githuburl":"" }, { "uri":"swr_02_0073.html", + "node_id":"swr_02_0073.xml", "product_code":"swr", - "code":"17", + "code":"22", "des":"Check whether an account used for image sharing exists.GET /v2/manage/namespaces/{namespace}/repositories/{repository}/access-domains/{access_domain}For details about par", "doc_type":"api", - "kw":"Checking the Existence of an Account Used for Image Sharing,API,API Reference", + "kw":"Checking the Existence of an Account Used for Image Sharing,Shared Account Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], "title":"Checking the Existence of an Account Used for Image Sharing", "githuburl":"" }, { "uri":"swr_02_0074.html", + "node_id":"swr_02_0074.xml", "product_code":"swr", - "code":"18", + "code":"23", "des":"Obtain the list of accounts used for image sharing.GET /v2/manage/namespaces/{namespace}/repositories/{repository}/access-domainsFor details about parameters, see Table 1", "doc_type":"api", - "kw":"Obtaining the List of Accounts Used for Image Sharing,API,API Reference", + "kw":"Obtaining the List of Accounts Used for Image Sharing,Shared Account Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], "title":"Obtaining the List of Accounts Used for Image Sharing", "githuburl":"" }, { - "uri":"swr_02_0075.html", + "uri":"en-us_topic_0000001471005441.html", + "node_id":"en-us_topic_0000001471005441.xml", "product_code":"swr", - "code":"19", - "des":"View the list of shared images.GET /v2/manage/shared-repositories?filter=center::{center}|name::{name}|limit::{limit}|offset::{offset}For details about parameters, see Ta", + "code":"24", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"Viewing the List of Shared Images,API,API Reference", - "title":"Viewing the List of Shared Images", + "kw":"API Versions", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], + "title":"API Versions", "githuburl":"" }, { "uri":"swr_02_0080.html", + "node_id":"swr_02_0080.xml", "product_code":"swr", - "code":"20", - "des":"Query all available API versions of SWR.GET /N/AResponse parametersResponse body parameter descriptionParameterTypeDescriptionversionsArray of objectsA list of objects re", + "code":"25", + "des":"Query all available API versions of SWR.GET /Response parametersStatus code: 200Response body parameter descriptionParameterTypeDescriptionversionsArray of objectsA list ", "doc_type":"api", - "kw":"Querying All API Versions,API,API Reference", + "kw":"Querying All API Versions,API Versions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], "title":"Querying All API Versions", "githuburl":"" }, { "uri":"swr_02_0081.html", + "node_id":"swr_02_0081.xml", "product_code":"swr", - "code":"21", - "des":"Query a specific API version of SWR.GET /{api_version}For details about parameters, see Table 1.Request parametersN/AN/AExample requestGET https://{Endpoint}/v2Response p", + "code":"26", + "des":"Query a specific API version of SWR.GET /{api_version}For details about parameters, see Table 1.Request parametersRequest header parametersParameterMandatoryTypeDescripti", "doc_type":"api", - "kw":"Querying a Specific API Version,API,API Reference", + "kw":"Querying a Specific API Version,API Versions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], "title":"Querying a Specific API Version", "githuburl":"" }, { - "uri":"swr_02_0042.html", + "uri":"en-us_topic_0000001421005366.html", + "node_id":"en-us_topic_0000001421005366.xml", "product_code":"swr", - "code":"22", - "des":"Grant permissions of an organization to certain users so that they can manage, edit, and read images from the organization.POST /v2/manage/namespaces/{namespace}/accessTa", + "code":"27", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"Creating Organization Permissions,API,API Reference", + "kw":"Organization Permission Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], + "title":"Organization Permission Management", + "githuburl":"" + }, + { + "uri":"swr_02_0042.html", + "node_id":"swr_02_0042.xml", + "product_code":"swr", + "code":"28", + "des":"Grant permissions of an organization to certain users so that they can manage, edit, and read images from the organization.NonePOST /v2/manage/namespaces/{namespace}/acce", + "doc_type":"api", + "kw":"Creating Organization Permissions,Organization Permission Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], "title":"Creating Organization Permissions", "githuburl":"" }, { "uri":"swr_02_0043.html", + "node_id":"swr_02_0043.xml", "product_code":"swr", - "code":"23", - "des":"Delete the organization operation permissions of certain users.DELETE /v2/manage/namespaces/{namespace}/accessTable 1 describes the parameters.Request parametersRequest b", + "code":"29", + "des":"Delete the organization operation permissions of certain users.DELETE /v2/manage/namespaces/{namespace}/accessTable 1 describes the parameters.Request parametersRequest h", "doc_type":"api", - "kw":"Deleting Organization Permissions,API,API Reference", + "kw":"Deleting Organization Permissions,Organization Permission Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], "title":"Deleting Organization Permissions", "githuburl":"" }, { "uri":"swr_02_0044.html", + "node_id":"swr_02_0044.xml", "product_code":"swr", - "code":"24", + "code":"30", "des":"Update the organization operation permissions for certain users.PATCH /v2/manage/namespaces/{namespace}/accessFor details about parameters, see Table 1.Request parameters", "doc_type":"api", - "kw":"Updating Organization Permissions,API,API Reference", + "kw":"Updating Organization Permissions,Organization Permission Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], "title":"Updating Organization Permissions", "githuburl":"" }, { "uri":"swr_02_0045.html", + "node_id":"swr_02_0045.xml", "product_code":"swr", - "code":"25", - "des":"Query organization permissions.GET /v2/manage/namespaces/{namespace}/accessFor details about parameters, see Table 1.Request parametersN/AN/AExample requestGET https://{E", + "code":"31", + "des":"Query organization permissions.GET /v2/manage/namespaces/{namespace}/accessFor details about parameters, see Table 1.Request parametersRequest header parametersParameterM", "doc_type":"api", - "kw":"Querying Organization Permissions,API,API Reference", + "kw":"Querying Organization Permissions,Organization Permission Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], "title":"Querying Organization Permissions", "githuburl":"" }, { - "uri":"swr_02_0046.html", + "uri":"en-us_topic_0000001470924909.html", + "node_id":"en-us_topic_0000001470924909.xml", "product_code":"swr", - "code":"26", + "code":"32", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Image Permission Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], + "title":"Image Permission Management", + "githuburl":"" + }, + { + "uri":"swr_02_0046.html", + "node_id":"swr_02_0046.xml", + "product_code":"swr", + "code":"33", "des":"Grant permissions of an image to certain users so that they can manage, edit, and read the image.POST /v2/manage/namespaces/{namespace}/repos/{repository}/accessFor detai", "doc_type":"api", - "kw":"Creating Image Permissions,API,API Reference", + "kw":"Creating Image Permissions,Image Permission Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], "title":"Creating Image Permissions", "githuburl":"" }, { "uri":"swr_02_0047.html", + "node_id":"swr_02_0047.xml", "product_code":"swr", - "code":"27", - "des":"Delete the image operation permissions of certain users.DELETE /v2/manage/namespaces/{namespace}/repos/{repository}/accessFor details about parameters, see Table 1.Reques", + "code":"34", + "des":"Delete the image operation permissions of certain users.NoneDELETE /v2/manage/namespaces/{namespace}/repos/{repository}/accessFor details about parameters, see Table 1.Re", "doc_type":"api", - "kw":"Deleting Image Permissions,API,API Reference", + "kw":"Deleting Image Permissions,Image Permission Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], "title":"Deleting Image Permissions", "githuburl":"" }, { "uri":"swr_02_0048.html", + "node_id":"swr_02_0048.xml", "product_code":"swr", - "code":"28", - "des":"Update the image operation permissions for certain users.PATCH /v2/manage/namespaces/{namespace}/repos/{repository}/accessFor details about parameters, see Table 1.Reques", + "code":"35", + "des":"Update the image operation permissions for certain users.NonePATCH /v2/manage/namespaces/{namespace}/repos/{repository}/accessFor details about parameters, see Table 1.Re", "doc_type":"api", - "kw":"Updating Image Permissions,API,API Reference", + "kw":"Updating Image Permissions,Image Permission Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], "title":"Updating Image Permissions", "githuburl":"" }, { "uri":"swr_02_0049.html", + "node_id":"swr_02_0049.xml", "product_code":"swr", - "code":"29", - "des":"Query image permissions.GET /v2/manage/namespaces/{namespace}/repos/{repository}/accessFor details about parameters, see Table 1.Request parametersN/AN/AExample requestGE", + "code":"36", + "des":"Query image permissions.NoneGET /v2/manage/namespaces/{namespace}/repos/{repository}/accessFor details about parameters, see Table 1.Request parametersRequest header para", "doc_type":"api", - "kw":"Querying Image Permissions,API,API Reference", + "kw":"Querying Image Permissions,Image Permission Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], "title":"Querying Image Permissions", "githuburl":"" }, { "uri":"swr_02_0008.html", + "node_id":"swr_02_0008.xml", "product_code":"swr", - "code":"30", + "code":"37", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Appendixes", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], "title":"Appendixes", "githuburl":"" }, { "uri":"swr_02_0023.html", + "node_id":"swr_02_0023.xml", "product_code":"swr", - "code":"31", + "code":"38", "des":"NormalReturned ValueDescription200 OKThe results of GET and PUT operations are returned as expected.201 CreatedThe results of the POST operation are returned as expected.", "doc_type":"api", "kw":"Status Codes,Appendixes,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], "title":"Status Codes", "githuburl":"" }, { "uri":"swr_02_0024.html", + "node_id":"swr_02_0024.xml", "product_code":"swr", - "code":"32", + "code":"39", "des":"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 stat", "doc_type":"api", - "kw":"Error Code,Appendixes,API Reference", - "title":"Error Code", + "kw":"Error Codes,Appendixes,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], + "title":"Error Codes", "githuburl":"" }, { "uri":"swr_02_0064.html", + "node_id":"swr_02_0064.xml", "product_code":"swr", - "code":"33", + "code":"40", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Change History,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true" + } + ], "title":"Change History", "githuburl":"" } diff --git a/docs/swr/api-ref/CLASS.TXT.json b/docs/swr/api-ref/CLASS.TXT.json index ceff62e8..10815308 100644 --- a/docs/swr/api-ref/CLASS.TXT.json +++ b/docs/swr/api-ref/CLASS.TXT.json @@ -18,58 +18,76 @@ "code":"2" }, { - "desc":"Create an organization.POST /v2/manage/namespacesRequest parametersRequest body parameter descriptionParameterMandatoryTypeDescriptionnamespaceYesStringOrganization name.", + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"swr", - "title":"Creating an Organization", - "uri":"swr_02_0026.html", + "title":"Organization Management", + "uri":"en-us_topic_0000001420846090.html", "doc_type":"api", "p_code":"2", "code":"3" }, { - "desc":"Delete an organization.DELETE /v2/manage/namespaces/{namespace}For details about parameters, see Table 1.Request parametersN/AN/AExample requestDELETE https://{Endpoint}/", + "desc":"Create an organization.POST /v2/manage/namespacesN/AN/A", + "product_code":"swr", + "title":"Creating an Organization", + "uri":"swr_02_0026.html", + "doc_type":"api", + "p_code":"3", + "code":"4" + }, + { + "desc":"Delete an organization.DELETE /v2/manage/namespaces/{namespace}For details about parameters, see Table 1.N/A", "product_code":"swr", "title":"Deleting an Organization", "uri":"swr_02_0027.html", "doc_type":"api", - "p_code":"2", - "code":"4" + "p_code":"3", + "code":"5" }, { - "desc":"Query the list of organizations.GET /v2/manage/namespaces?filter=namespace::{namespace}For details about parameters, see Table 1.Request parametersN/AN/AExample requestGE", + "desc":"Query the list of organizations.GET /v2/manage/namespacesBy default, all organizations will be returned.Status code: 200The list of organizations is returned successfully", "product_code":"swr", "title":"Querying the List of Organizations", "uri":"swr_02_0028.html", "doc_type":"api", - "p_code":"2", - "code":"5" + "p_code":"3", + "code":"6" }, { - "desc":"Query the details of an organization by its name.GET /v2/manage/namespaces/{namespace}For details about parameters, see Table 1.Request parametersN/AN/AExample requestGET", + "desc":"Query the details of an organization by its name.GET /v2/manage/namespaces/{namespace}For details about parameters, see Table 1.Status code: 200Response body parameter de", "product_code":"swr", "title":"Querying the Details of an Organization", "uri":"swr_02_0029.html", "doc_type":"api", - "p_code":"2", - "code":"6" + "p_code":"3", + "code":"7" }, { - "desc":"Create an image repository in an organization.POST /v2/manage/namespaces/{namespace}/reposFor details about parameters, see Table 1.Request parametersFormData parameter d", + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"swr", + "title":"Image Repository Management", + "uri":"en-us_topic_0000001420528490.html", + "doc_type":"api", + "p_code":"2", + "code":"8" + }, + { + "desc":"Create an image repository in an organization.POST /v2/manage/namespaces/{namespace}/reposFor details about parameters, see Table 1.NoneNoneFor details, see Error Codes.", "product_code":"swr", "title":"Creating an Image Repository", "uri":"swr_02_0030.html", "doc_type":"api", - "p_code":"2", - "code":"7" + "p_code":"8", + "code":"9" }, { - "desc":"Delete an image repository in an organization.DELETE /v2/manage/namespaces/{namespace}/repos/{repository}For details about parameters, see Table 1.Request parametersN/AN/", + "desc":"Delete an image repository in an organization.DELETE /v2/manage/namespaces/{namespace}/repos/{repository}For details about parameters, see Table 1.NoneNoneFor details, se", "product_code":"swr", "title":"Deleting an Image Repository", "uri":"swr_02_0031.html", "doc_type":"api", - "p_code":"2", - "code":"8" + "p_code":"8", + "code":"10" }, { "desc":"Update the brief information on an image repository in an organization, including the category, is_public, and description.PATCH /v2/manage/namespaces/{namespace}/repos/{", @@ -77,8 +95,8 @@ "title":"Updating the Brief Information on an Image Repository", "uri":"swr_02_0032.html", "doc_type":"api", - "p_code":"2", - "code":"9" + "p_code":"8", + "code":"11" }, { "desc":"Query the brief information on an image repository in an organization.GET /v2/manage/namespaces/{namespace}/repos/{repository}For details about parameters, see Table 1.Re", @@ -86,26 +104,44 @@ "title":"Querying the Brief Information on an Image Repository", "uri":"swr_02_0033.html", "doc_type":"api", - "p_code":"2", - "code":"10" + "p_code":"8", + "code":"12" }, { - "desc":"Query the image repository list.GET /v2/manage/repos?filter=center::self|namespace::{namespace}|name::{name}|category::{category}|offset::{offset}|limit::{limit}|order_co", + "desc":"Query the image repository list.GET /v2/manage/reposRequest parametersN/AN/AExample requestGET https://{Endpoint}/v2/manage/repos?center=self&namespace=group&name=busybox", "product_code":"swr", "title":"Querying the Image Repository List", "uri":"swr_02_0034.html", "doc_type":"api", - "p_code":"2", - "code":"11" + "p_code":"8", + "code":"13" }, { - "desc":"Query all image tags of an image repository.GET /v2/manage/namespaces/{namespace}/repos/{repository}/tags?filter=offset::{offset}|limit::{limit}|order_column::{order_colu", + "desc":"View the list of shared images.GET /v2/manage/shared-repositoriesRequest parametersN/AN/AExample requestGET https://{Endpoint}/v2/manage/shared-repositories?center=self&n", + "product_code":"swr", + "title":"Viewing the List of Shared Images", + "uri":"swr_02_0075.html", + "doc_type":"api", + "p_code":"8", + "code":"14" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"swr", + "title":"Image Tag Management", + "uri":"en-us_topic_0000001420688458.html", + "doc_type":"api", + "p_code":"2", + "code":"15" + }, + { + "desc":"Query all image tags of an image repository.GET /v2/manage/namespaces/{namespace}/repos/{repository}/tags?offset={offset}&limit={limit}&order_column={order_column}&order_", "product_code":"swr", "title":"Querying the List of Image Repository Tags", "uri":"swr_02_0035.html", "doc_type":"api", - "p_code":"2", - "code":"12" + "p_code":"15", + "code":"16" }, { "desc":"Delete the image with a specified tag in an image repository.DELETE /v2/manage/namespaces/{namespace}/repos/{repository}/tags/{tag}For details about parameters, see Table", @@ -113,8 +149,17 @@ "title":"Deleting the Image with a Specified Tag", "uri":"swr_02_0036.html", "doc_type":"api", + "p_code":"15", + "code":"17" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"swr", + "title":"Shared Account Management", + "uri":"en-us_topic_0000001470804877.html", + "doc_type":"api", "p_code":"2", - "code":"13" + "code":"18" }, { "desc":"Create an account used for image sharing. You can share your private images with other users, granting them permissions to pull the images.POST /v2/manage/namespaces/{nam", @@ -122,8 +167,8 @@ "title":"Creating an Account Used for Image Sharing", "uri":"swr_02_0070.html", "doc_type":"api", - "p_code":"2", - "code":"14" + "p_code":"18", + "code":"19" }, { "desc":"Delete an account used for image sharing.DELETE /v2/manage/namespaces/{namespace}/repositories/{repository}/access-domains/{access_domain}For details about parameters, se", @@ -131,8 +176,8 @@ "title":"Deleting an Account Used for Image Sharing", "uri":"swr_02_0071.html", "doc_type":"api", - "p_code":"2", - "code":"15" + "p_code":"18", + "code":"20" }, { "desc":"Update an account used for image sharing.PATCH /v2/manage/namespaces/{namespace}/repositories/{repository}/access-domains/{access_domain}For details about parameters, see", @@ -140,8 +185,8 @@ "title":"Updating an Account Used for Image Sharing", "uri":"swr_02_0072.html", "doc_type":"api", - "p_code":"2", - "code":"16" + "p_code":"18", + "code":"21" }, { "desc":"Check whether an account used for image sharing exists.GET /v2/manage/namespaces/{namespace}/repositories/{repository}/access-domains/{access_domain}For details about par", @@ -149,8 +194,8 @@ "title":"Checking the Existence of an Account Used for Image Sharing", "uri":"swr_02_0073.html", "doc_type":"api", - "p_code":"2", - "code":"17" + "p_code":"18", + "code":"22" }, { "desc":"Obtain the list of accounts used for image sharing.GET /v2/manage/namespaces/{namespace}/repositories/{repository}/access-domainsFor details about parameters, see Table 1", @@ -158,53 +203,62 @@ "title":"Obtaining the List of Accounts Used for Image Sharing", "uri":"swr_02_0074.html", "doc_type":"api", - "p_code":"2", - "code":"18" + "p_code":"18", + "code":"23" }, { - "desc":"View the list of shared images.GET /v2/manage/shared-repositories?filter=center::{center}|name::{name}|limit::{limit}|offset::{offset}For details about parameters, see Ta", + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"swr", - "title":"Viewing the List of Shared Images", - "uri":"swr_02_0075.html", + "title":"API Versions", + "uri":"en-us_topic_0000001471005441.html", "doc_type":"api", "p_code":"2", - "code":"19" + "code":"24" }, { - "desc":"Query all available API versions of SWR.GET /N/AResponse parametersResponse body parameter descriptionParameterTypeDescriptionversionsArray of objectsA list of objects re", + "desc":"Query all available API versions of SWR.GET /Response parametersStatus code: 200Response body parameter descriptionParameterTypeDescriptionversionsArray of objectsA list ", "product_code":"swr", "title":"Querying All API Versions", "uri":"swr_02_0080.html", "doc_type":"api", - "p_code":"2", - "code":"20" + "p_code":"24", + "code":"25" }, { - "desc":"Query a specific API version of SWR.GET /{api_version}For details about parameters, see Table 1.Request parametersN/AN/AExample requestGET https://{Endpoint}/v2Response p", + "desc":"Query a specific API version of SWR.GET /{api_version}For details about parameters, see Table 1.Request parametersRequest header parametersParameterMandatoryTypeDescripti", "product_code":"swr", "title":"Querying a Specific API Version", "uri":"swr_02_0081.html", "doc_type":"api", - "p_code":"2", - "code":"21" + "p_code":"24", + "code":"26" }, { - "desc":"Grant permissions of an organization to certain users so that they can manage, edit, and read images from the organization.POST /v2/manage/namespaces/{namespace}/accessTa", + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"swr", + "title":"Organization Permission Management", + "uri":"en-us_topic_0000001421005366.html", + "doc_type":"api", + "p_code":"2", + "code":"27" + }, + { + "desc":"Grant permissions of an organization to certain users so that they can manage, edit, and read images from the organization.NonePOST /v2/manage/namespaces/{namespace}/acce", "product_code":"swr", "title":"Creating Organization Permissions", "uri":"swr_02_0042.html", "doc_type":"api", - "p_code":"2", - "code":"22" + "p_code":"27", + "code":"28" }, { - "desc":"Delete the organization operation permissions of certain users.DELETE /v2/manage/namespaces/{namespace}/accessTable 1 describes the parameters.Request parametersRequest b", + "desc":"Delete the organization operation permissions of certain users.DELETE /v2/manage/namespaces/{namespace}/accessTable 1 describes the parameters.Request parametersRequest h", "product_code":"swr", "title":"Deleting Organization Permissions", "uri":"swr_02_0043.html", "doc_type":"api", - "p_code":"2", - "code":"23" + "p_code":"27", + "code":"29" }, { "desc":"Update the organization operation permissions for certain users.PATCH /v2/manage/namespaces/{namespace}/accessFor details about parameters, see Table 1.Request parameters", @@ -212,17 +266,26 @@ "title":"Updating Organization Permissions", "uri":"swr_02_0044.html", "doc_type":"api", - "p_code":"2", - "code":"24" + "p_code":"27", + "code":"30" }, { - "desc":"Query organization permissions.GET /v2/manage/namespaces/{namespace}/accessFor details about parameters, see Table 1.Request parametersN/AN/AExample requestGET https://{E", + "desc":"Query organization permissions.GET /v2/manage/namespaces/{namespace}/accessFor details about parameters, see Table 1.Request parametersRequest header parametersParameterM", "product_code":"swr", "title":"Querying Organization Permissions", "uri":"swr_02_0045.html", "doc_type":"api", + "p_code":"27", + "code":"31" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"swr", + "title":"Image Permission Management", + "uri":"en-us_topic_0000001470924909.html", + "doc_type":"api", "p_code":"2", - "code":"25" + "code":"32" }, { "desc":"Grant permissions of an image to certain users so that they can manage, edit, and read the image.POST /v2/manage/namespaces/{namespace}/repos/{repository}/accessFor detai", @@ -230,35 +293,35 @@ "title":"Creating Image Permissions", "uri":"swr_02_0046.html", "doc_type":"api", - "p_code":"2", - "code":"26" + "p_code":"32", + "code":"33" }, { - "desc":"Delete the image operation permissions of certain users.DELETE /v2/manage/namespaces/{namespace}/repos/{repository}/accessFor details about parameters, see Table 1.Reques", + "desc":"Delete the image operation permissions of certain users.NoneDELETE /v2/manage/namespaces/{namespace}/repos/{repository}/accessFor details about parameters, see Table 1.Re", "product_code":"swr", "title":"Deleting Image Permissions", "uri":"swr_02_0047.html", "doc_type":"api", - "p_code":"2", - "code":"27" + "p_code":"32", + "code":"34" }, { - "desc":"Update the image operation permissions for certain users.PATCH /v2/manage/namespaces/{namespace}/repos/{repository}/accessFor details about parameters, see Table 1.Reques", + "desc":"Update the image operation permissions for certain users.NonePATCH /v2/manage/namespaces/{namespace}/repos/{repository}/accessFor details about parameters, see Table 1.Re", "product_code":"swr", "title":"Updating Image Permissions", "uri":"swr_02_0048.html", "doc_type":"api", - "p_code":"2", - "code":"28" + "p_code":"32", + "code":"35" }, { - "desc":"Query image permissions.GET /v2/manage/namespaces/{namespace}/repos/{repository}/accessFor details about parameters, see Table 1.Request parametersN/AN/AExample requestGE", + "desc":"Query image permissions.NoneGET /v2/manage/namespaces/{namespace}/repos/{repository}/accessFor details about parameters, see Table 1.Request parametersRequest header para", "product_code":"swr", "title":"Querying Image Permissions", "uri":"swr_02_0049.html", "doc_type":"api", - "p_code":"2", - "code":"29" + "p_code":"32", + "code":"36" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -267,7 +330,7 @@ "uri":"swr_02_0008.html", "doc_type":"api", "p_code":"", - "code":"30" + "code":"37" }, { "desc":"NormalReturned ValueDescription200 OKThe results of GET and PUT operations are returned as expected.201 CreatedThe results of the POST operation are returned as expected.", @@ -275,17 +338,17 @@ "title":"Status Codes", "uri":"swr_02_0023.html", "doc_type":"api", - "p_code":"30", - "code":"31" + "p_code":"37", + "code":"38" }, { "desc":"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 stat", "product_code":"swr", - "title":"Error Code", + "title":"Error Codes", "uri":"swr_02_0024.html", "doc_type":"api", - "p_code":"30", - "code":"32" + "p_code":"37", + "code":"39" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -294,6 +357,6 @@ "uri":"swr_02_0064.html", "doc_type":"api", "p_code":"", - "code":"33" + "code":"40" } ] \ No newline at end of file diff --git a/docs/swr/api-ref/en-us_topic_0000001420528490.html b/docs/swr/api-ref/en-us_topic_0000001420528490.html new file mode 100644 index 00000000..28cb3b2e --- /dev/null +++ b/docs/swr/api-ref/en-us_topic_0000001420528490.html @@ -0,0 +1,25 @@ + + +

Image Repository Management

+
+
+ + +
+
Parent topic: API
+
+
+ diff --git a/docs/swr/api-ref/en-us_topic_0000001420688458.html b/docs/swr/api-ref/en-us_topic_0000001420688458.html new file mode 100644 index 00000000..2ef6ad22 --- /dev/null +++ b/docs/swr/api-ref/en-us_topic_0000001420688458.html @@ -0,0 +1,17 @@ + + +

Image Tag Management

+
+
+ + +
+
Parent topic: API
+
+
+ diff --git a/docs/swr/api-ref/en-us_topic_0000001420846090.html b/docs/swr/api-ref/en-us_topic_0000001420846090.html new file mode 100644 index 00000000..d54f1592 --- /dev/null +++ b/docs/swr/api-ref/en-us_topic_0000001420846090.html @@ -0,0 +1,21 @@ + + +

Organization Management

+
+
+ + +
+
Parent topic: API
+
+
+ diff --git a/docs/swr/api-ref/en-us_topic_0000001421005366.html b/docs/swr/api-ref/en-us_topic_0000001421005366.html new file mode 100644 index 00000000..2bc2928f --- /dev/null +++ b/docs/swr/api-ref/en-us_topic_0000001421005366.html @@ -0,0 +1,21 @@ + + +

Organization Permission Management

+
+
+ + +
+
Parent topic: API
+
+
+ diff --git a/docs/swr/api-ref/en-us_topic_0000001470804877.html b/docs/swr/api-ref/en-us_topic_0000001470804877.html new file mode 100644 index 00000000..d08d4d5f --- /dev/null +++ b/docs/swr/api-ref/en-us_topic_0000001470804877.html @@ -0,0 +1,23 @@ + + +

Shared Account Management

+
+
+ + +
+
Parent topic: API
+
+
+ diff --git a/docs/swr/api-ref/en-us_topic_0000001470924909.html b/docs/swr/api-ref/en-us_topic_0000001470924909.html new file mode 100644 index 00000000..5479373c --- /dev/null +++ b/docs/swr/api-ref/en-us_topic_0000001470924909.html @@ -0,0 +1,21 @@ + + +

Image Permission Management

+
+
+ + +
+
Parent topic: API
+
+
+ diff --git a/docs/swr/api-ref/en-us_topic_0000001471005441.html b/docs/swr/api-ref/en-us_topic_0000001471005441.html new file mode 100644 index 00000000..d9fdf57b --- /dev/null +++ b/docs/swr/api-ref/en-us_topic_0000001471005441.html @@ -0,0 +1,17 @@ + + +

API Versions

+
+
+ + +
+
Parent topic: API
+
+
+ diff --git a/docs/swr/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/swr/api-ref/public_sys-resources/icon-arrowdn.gif index 84eec9be2f2ce458e888f8a9b803f9387247726a..379428032932289326e52c2772bd90ba3d88b906 100644 GIT binary patch literal 1887 zcmZ?wbhEHbCgqow z*eU^C3h_d20o>TUVm+{T^pf*)^(zt!^bPe4Kwg3=^!3HBG&dKny0|1L72#g21{a4^ z7NqJ2r55Lx7A2Jm>Ih`8X1|p zSh~8p7&*iAy5uL9=BDPA!1Sgd^t#~G3rY&P1wfl!Qj0RnQd8WD@^clyUbf1_?G{Iz z=0WwQ;C71>PQCg-$LND17Ac}(Lcr7mV#1RxkONQnsd>QEUIa|mjQ{`r{qy_R&mZ5v zef{$J)5j0*-@SeF`qj%9&!0Vg^7zri2lwyYy>t84%^TORUA=Po(!~qs&z(JU`qar2 z$B!L7a`@1}1N-;w-Lrew&K=vgZQZhY)5ZeMTG_VdAT{+S(zE> zX{jm6Nr?&Zaj`McQIQehVWA3>*p!%p5Wn0u7E$th{n6D>ft^YU5&dnB%c=(a~-RV>2EO25SIA CZ-yWM literal 68 zcmZ?wbhEHbzkByxQ$u Mo$o?7J5~m305MV#!~g&Q diff --git a/docs/swr/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/swr/api-ref/public_sys-resources/icon-arrowrt.gif index 39583d168d6db303b366b5b8c1780698a6bb6017..6aaaa11c23e919c4798d7dcd2b1ae98dd35dd316 100644 GIT binary patch literal 1890 zcmZ?wbhEHb7yetOgf{ zR2HP_2c;J0mlh?b0+lO+tSYc_E=o--$uA1Y&(DE{Vn9ZINq%ugeu08>u$h8JcxGNo zetEGbSiP^Wm1kaYNn&1ds;7&s63_&_%*+%k11Cod14Ab>6ALqQLqk^=3j-5FHzP|& zBUd9gQwvj9m|mCsATTyHM;rzL?XHK6w zdE)r7qel)OI(T6JzP)>P@7lRz`?jrHHgDRvVg0(bYgVsXxnlXUrArnsTDV~Tyt#8` z&zd=7`n0K2CQq6;p}()Ur@O1OqrI)QrMaoGp}wxRrn;)KqP(oMq`0WCAU`iRCp#-M zBRwrOB{?ZEAwDiPCORrIB0MZKBseHAz~9f;$J@)(!`;o*#o5Wx!QRf+#@fo#!raW% z#MsEtKwnQ+M_Wr%LtRZ(MOjHvL0(Q)Mp{ZzLR?H#L|8~rfS-?-hntI&gPo0)g_((w zfkE*n3y@@B&;b#k`jUY|nSq%>!ec`MLnAA%oR7zc2TpB#@>)|YCO&lN;uMU!b7Eqm H1A{dHTIz>f literal 70 zcmZ?wbhEHb
  • Status Codes
    • -
  • Error Code
    +
  • Error Codes
    • diff --git a/docs/swr/api-ref/swr_02_0011.html b/docs/swr/api-ref/swr_02_0011.html index 36b0989b..911f7635 100644 --- a/docs/swr/api-ref/swr_02_0011.html +++ b/docs/swr/api-ref/swr_02_0011.html @@ -4,59 +4,19 @@
    diff --git a/docs/swr/api-ref/swr_02_0024.html b/docs/swr/api-ref/swr_02_0024.html index 51ada032..fcd309aa 100644 --- a/docs/swr/api-ref/swr_02_0024.html +++ b/docs/swr/api-ref/swr_02_0024.html @@ -1,6 +1,6 @@ -

    Error Code

    +

    Error Codes

    If an error occurs in API calling, no result is returned. Identify the causes of errors based on the error codes of each API. If an error occurs in API calling, HTTP status code 4xx or 5xx is returned. The response body contains the specific error code and information.

    Format of an Error Response Body

    If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.

    [
@@ -25,7 +25,7 @@
 
 
    SVCSTG.SWR.4010000
    
 
-
    Authentication failed.
    
+
    Authentication failed. Obtain a new token and try again.
    
 
 
 
    500
    
@@ -123,7 +123,7 @@
 
 
    SVCSTG.SWR.4000014
    
 
-
    Invalid parameter.
    
+
    Invalid API parameter. Modify the request body based on the returned message and the SWR API documentation, or contact technical support.
    
 
 
 
    400
    
@@ -1131,7 +1131,7 @@
 
 
    SVCSTG.SWR.4011064
    
 
-
    Cross-account error. Insufficient permissions.
    
+
    Insufficient permissions.
    
 
 
 
    400
    
diff --git a/docs/swr/api-ref/swr_02_0026.html b/docs/swr/api-ref/swr_02_0026.html
index 81a822a7..c68847a5 100644
--- a/docs/swr/api-ref/swr_02_0026.html
+++ b/docs/swr/api-ref/swr_02_0026.html
@@ -5,72 +5,104 @@

    URI

    POST /v2/manage/namespaces

    -

    Request

    • Request parameters -
      Table 1 Request body parameter description

      Parameter

      +

      Request Parameters

      +
      - - - - - - - + + + + +
      Table 1 Request header parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      namespace

      +

      Content-Type

      Yes

      +

      Yes

      String

      +

      String

      Organization name.

      -

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

      +

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

      +

      The default value is application/json.

      +

      X-Auth-Token

      +

      Yes

      +

      String

      +

      User token.

      +

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

      Create an organization named group:

      -
      POST https://{Endpoint}/v2/manage/namespaces
      -

      Body:

      -
      {
-    "namespace": "group"
-}
      -
      • -
      -

      Response

      • Response parameters

        N/A

        -
      • Example response
        {}
        -
      -
      -

      Status Code

      -

      Status Code

      + +
      - + + - - + + - +
      Table 2 Request body parameter

      Parameter

      Description

      +

      Mandatory

      +

      Type

      +

      Description

      201

      +

      namespace

      Creation successful.

      +

      Yes

      +

      String

      +

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

      400

      +
      +
      + +

      Response Parameters

      N/A

      +
      +

      Example Request

      POST https://{endpoint}/v2/manage/namespaces
+
+{
+  "namespace" : "group"
+}
      +
      +

      Example Response

      N/A

      +
      +

      Status Code

      +
      + + + + - - - - - - - + + + @@ -80,7 +112,7 @@
      -
      Parent topic: API
      +
      Parent topic: Organization Management
      diff --git a/docs/swr/api-ref/swr_02_0027.html b/docs/swr/api-ref/swr_02_0027.html index a6291eec..e3604fa6 100644 --- a/docs/swr/api-ref/swr_02_0027.html +++ b/docs/swr/api-ref/swr_02_0027.html @@ -22,16 +22,47 @@ -

      Status Code

      +

      Description

      +

      201

      The request is incorrect or the number of organizations exceeds the upper limit.

      +

      Creation successful.

      401

      +

      400

      Authentication failed.

      +

      The request is incorrect or the number of organizations exceeds the upper limit.

      409

      +

      401

      The resource already exists.

      +

      Authentication failed.

      500

      +

      409

      Internal error.

      +

      The resource already exists.

      +

      500

      +

      Internal error.

      String

      Organization name

      +

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

      Request

      • Request parameters

        N/A

        -
      • Example request
        DELETE https://{Endpoint}/v2/manage/namespaces/group
        -
      +

      Request Parameters

      +
      + + + + + + + + + + + + + + + + +
      Table 2 Request header parameters

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      Content-Type

      +

      Yes

      +

      String

      +

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

      +

      The default value is application/json.

      +

      X-Auth-Token

      +

      Yes

      +

      String

      +

      User token.

      +

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

      +
      +

      Response

      N/A

      @@ -74,7 +105,7 @@
      -
      Parent topic: API
      +
      Parent topic: Organization Management
      diff --git a/docs/swr/api-ref/swr_02_0028.html b/docs/swr/api-ref/swr_02_0028.html index 7a9e3856..0e8aaa14 100644 --- a/docs/swr/api-ref/swr_02_0028.html +++ b/docs/swr/api-ref/swr_02_0028.html @@ -3,97 +3,143 @@

      Querying the List of Organizations

      Function

      Query the list of organizations.

      -

      URI

      GET /v2/manage/namespaces?filter=namespace::{namespace}

      -

      For details about parameters, see Table 1.

      +

      URI

      GET /v2/manage/namespaces

      -
      Table 1 Parameter description

      Parameter

      +
      - - - - - - - + + + + +
      Table 1 Query parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      namespace

      +

      namespace

      No

      +

      No

      String

      +

      String

      Organization name

      +

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

      +

      filter

      +

      No

      +

      String

      +

      Enter namespace::{namespace}|mode::{mode}. {namespace} indicates the organization name. If {mode} is not set, the list of authorized organizations is displayed. If {mode} is set to visible, the list of visible organizations is displayed. (Some organizations can be viewed by the repository, but cannot by the organization.)
      -

      Request

      • Request parameters

        N/A

        -
      • Example request
        GET https://{Endpoint}/v2/manage/namespaces?filter=namespace::group
        -
      -
      -

      Response

      • Response parameters -
        Table 2 Response body parameter description

        Parameter

        +

        Request Parameters

        +
        - - + - - - + + + + + + + + +
        Table 2 Request header parameters

        Parameter

        Type

        +

        Mandatory

        Description

        +

        Type

        +

        Description

        namespaces

        +

        Content-Type

        Array of objects

        +

        Yes

        Organization list

        +

        String

        +

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

        +

        The default value is application/json.

        +

        X-Auth-Token

        +

        Yes

        +

        String

        +

        User token.

        +

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

        +
        +
        +

        By default, all organizations will be returned.

        +
        +
        +

        Response Parameters

        +
        + + + + + + +
        Table 3 Response body parameter description

        Parameter

        +

        Type

        +

        Description

        +

        namespaces

        +

        Array of objects

        +

        Organization list
        -
        Table 3 namespaces parameter description

        Parameter

        +
        - - - - - - - - - - - - - -
        Table 4 namespaces parameter description

        Parameter

        Type

        +

        Type

        Description

        +

        Description

        ID

        +

        ID

        Integer

        +

        Integer

        Organization ID

        +

        Organization ID

        name

        +

        name

        String

        +

        String

        Organization name

        +

        Organization name

        creator_name

        +

        creator_name

        String

        +

        String

        IAM username

        +

        IAM username

        auth

        +

        auth

        Integer

        +

        Integer

        User permission

        +

        User permission

        • 7: Manage
        • 3: Write
        • 1: Read
        -
      • Example response
        {
+
+
        Example Request
        GET https://{Endpoint}/v2/manage/namespaces?namespace=group
        
+
        
+
        Example Response
        Status code: 200
        
+
        The list of organizations is returned successfully.
        
+
        {
     "namespaces": [
         {
             "id": 1343008,
@@ -103,48 +149,49 @@
         }
     ]
 }
        
-

        • Status Code

        -

        Status Code

        +
        - - - - - - - - - - -

        Status Code

        Description

        +

        Description

        200

        +

        200

        Query succeeded.

        +

        Query succeeded.

        400

        +

        400

        Request error.

        +

        Request error.

        401

        +

        401

        Authentication failed.

        +

        Authentication failed.

        404

        +

        404

        The organization does not exist.

        +

        The organization does not exist.

        500

        +

        500

        Internal error.

        +

        Internal error.
        +

        Error Codes

        For details, see Error Codes.

        +
        -
        Parent topic: API
        +
        Parent topic: Organization Management
        diff --git a/docs/swr/api-ref/swr_02_0029.html b/docs/swr/api-ref/swr_02_0029.html index 0f3a6ca0..34430ca5 100644 --- a/docs/swr/api-ref/swr_02_0029.html +++ b/docs/swr/api-ref/swr_02_0029.html @@ -29,99 +29,135 @@
        -

        Request

        • Request parameters

          N/A

          -
        • Example request
          GET https://{Endpoint}/v2/manage/namespaces/group
          -
        -
        -

        Response

        • Response parameters -
          Table 2 Response body parameter description

          Parameter

          +

          Request Parameters

          +
          - - + - - - + - - - + - +
          Table 2 Request header parameters

          Parameter

          Type

          +

          Mandatory

          Description

          +

          Type

          +

          Description

          id

          +

          Content-Type

          Integer

          +

          Yes

          Organization ID

          +

          String

          +

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

          +

          The default value is application/json.

          name

          +

          X-Auth-Token

          String

          +

          Yes

          Organization name

          +

          String

          +

          User token.

          +

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

          creator_name

          +
          +
          +
          +

          Response Parameters

          Status code: 200 +
          + + + + + - - - - - + + + + + + + +
          Table 3 Response body parameter description

          Parameter

          +

          Type

          +

          Description

          +

          id

          String

          +

          Integer

          IAM username

          +

          Organization ID

          auth

          +

          name

          Integer

          +

          String

          User permission

          +

          Organization name

          +

          creator_name

          +

          String

          +

          IAM username

          +

          auth

          +

          Integer

          +

          User permission

          • 7: Manage
          • 3: Write
          • 1: Read
          -
        • Example response
          {
+
          • +
          +

          Example Request

          GET https://{Endpoint}/v2/manage/namespaces/group
          +
          +

          Example Response

          {
     "id": 1422,
     "name": "group",
     "creator_name": "username",
     "auth": 7
 }
          -

          Status Code

          -

          Status Code

          +
          - - - - - - - - - - -

          Status Code

          Description

          +

          Description

          200

          +

          200

          Query succeeded.

          +

          Query succeeded.

          400

          +

          400

          Request error.

          +

          Request error.

          401

          +

          401

          Authentication failed.

          +

          Authentication failed.

          404

          +

          404

          The organization does not exist.

          +

          The organization does not exist.

          500

          +

          500

          Internal error.

          +

          Internal error.
          +

          Error Codes

          For details, see Error Codes.

          +
          -
          Parent topic: API
          +
          Parent topic: Organization Management
          diff --git a/docs/swr/api-ref/swr_02_0030.html b/docs/swr/api-ref/swr_02_0030.html index 5ad86ca4..e9e73965 100644 --- a/docs/swr/api-ref/swr_02_0030.html +++ b/docs/swr/api-ref/swr_02_0030.html @@ -30,119 +30,146 @@
          -

          Request

          • Request parameters -
            Table 2 FormData parameter description

            Parameter

            +

            Request Parameters

            +
            - - - - - - - - - - - - - - - - - - - - -
            Table 2 Request header parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            repository

            +

            Content-Type

            Yes

            +

            Yes

            String

            +

            String

            Image repository name.

            -

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

            +

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

            +

            The default value is application/json.

            category

            +

            X-Auth-Token

            No

            +

            Yes

            String

            +

            String

            Repository type.

            -

            The value can be app_server, linux, framework_app, database, lang, other, windows or arm.

            -

            description

            -

            No

            -

            String

            -

            Brief description of the image repository.

            -

            is_public

            -

            Yes

            -

            Boolean

            -

            Whether the repository is a public repository. When the value is true, it indicates the repository is public. When the value is false, it indicates the repository is private.

            +

            User token.

            +

            The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
            -
          • Example request
            POST https://{Endpoint}/v2/manage/namespaces/group/repos
            -

            Body:

            -
            -F "repository=busybox" \
--F "category=linux" \
--F "description=this is a busybox repository" \
--F "is_public=true"
            -

            Or

            -
            {
-    "repository": "busybox",
-    "category": "linux",
-    "description": "this is a busybox repository",
-    "is_public": true
-}
            -

            The form format will no longer be supported soon. You are advised to use the body in the JSON format to call the API.

            -
            -
            • + +
            + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Table 3 Request body parameters

            Parameter

            +

            Mandatory

            +

            Type

            +

            Description

            +

            repository

            +

            Yes

            +

            String

            +

            Image repository name. An image repository name contains 1 to 128 characters. It must start and end with a lowercase letter or digit. Only lowercase letters, digits, periods (.), slashes (/), underscores (_), and hyphens (-) are allowed. Periods, slashes, underscores, and hyphens cannot be placed next to each other. A maximum of two consecutive underscores are allowed.

            +

            is_public

            +

            Yes

            +

            Boolean

            +

            Whether the repository is public. true indicates that the repository is public. false indicates that the repository is private.

            +

            category

            +

            No

            +

            String

            +

            Repository type. The value can be app_server, linux, framework_app, database, lang, arm, or other.

            +

            description

            +

            No

            +

            String

            +

            Brief description of the image repository.

            +
            -

            Response

            • Response parameters

              N/A

              -
            • Example response
              {}
              -
            +
            +

            Response Parameters

            None

            +
            +

            Example Request

            POST https://{endpoint}/v2/manage/namespaces/{namespace}/repos
+
+{
+  "repository" : "busybox",
+  "category" : "linux",
+  "description" : "this is a busybox repository",
+  "is_public" : true
+}
            +
            +

            Example Response

            None

            Status Code

            -

            Status Code

            +
            - - - - - - - - - - -

            Status Code

            Description

            +

            Description

            201

            +

            201

            Creation successful.

            +

            Creation successful.

            400

            +

            400

            Request error. Error information is returned.

            +

            Request error. Error information is returned.

            401

            +

            401

            Authentication failed.

            +

            Authentication failed.

            409

            +

            409

            The repository already exists.

            +

            The repository already exists.

            500

            +

            500

            Internal error. Error information is returned.

            +

            Internal error. Error information is returned.
            +

            Error Codes

            For details, see Error Codes.

            +
            -
            Parent topic: API
            +
            Parent topic: Image Repository Management
            diff --git a/docs/swr/api-ref/swr_02_0031.html b/docs/swr/api-ref/swr_02_0031.html index 1c22ee34..a7214a17 100644 --- a/docs/swr/api-ref/swr_02_0031.html +++ b/docs/swr/api-ref/swr_02_0031.html @@ -38,57 +38,94 @@
            -

            Request

            • Request parameters

              N/A

              -
            • Example request
              DELETE https://{Endpoint}/v2/manage/namespaces/group/repos/busybox
              -
            -
            -

            Response

            N/A

            -
            -

            Status Code

            -

            Status Code

            +

            Request Parameters

            +
            - + + - - + + - - - - - - - - - - - - - -
            Table 2 Request header parameters

            Parameter

            Description

            +

            Mandatory

            +

            Type

            +

            Description

            204

            +

            Content-Type

            The brief information about the image repository is successfully deleted.

            +

            Yes

            +

            String

            +

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

            +

            The default value is application/json.

            400

            +

            X-Auth-Token

            Request error. Error information is returned.

            +

            Yes

            401

            +

            String

            Authentication failed.

            -

            404

            -

            The repository does not exist.

            -

            406

            -

            The repository cannot be deleted because it contains images.

            -

            500

            -

            Internal error. Error information is returned.

            +

            User token.

            +

            The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
            +

            Response Parameters

            None

            +
            +

            Example Request

            DELETE https://{endpoint}/v2/manage/namespaces/{namespace}}/repos/{repository}
            +
            +

            Example Response

            None

            +
            +

            Status Code

            +
            + + + + + + + + + + + + + + + + + + + + + + +

            Status Code

            +

            Description

            +

            204

            +

            The brief information about the image repository is successfully deleted.

            +

            400

            +

            Request error. Error information is returned.

            +

            401

            +

            Authentication failed.

            +

            404

            +

            The repository does not exist.

            +

            406

            +

            The repository cannot be deleted because it contains images.

            +

            500

            +

            Internal error. Error information is returned.

            +
            +
            +
            +

            Error Codes

            For details, see Error Codes.

            +
            -
            Parent topic: API
            +
            Parent topic: Image Repository Management
            diff --git a/docs/swr/api-ref/swr_02_0032.html b/docs/swr/api-ref/swr_02_0032.html index 1788ad65..85d717bf 100644 --- a/docs/swr/api-ref/swr_02_0032.html +++ b/docs/swr/api-ref/swr_02_0032.html @@ -6,126 +6,168 @@

            URI

            PATCH /v2/manage/namespaces/{namespace}/repos/{repository}

            For details about parameters, see Table 1.

            -
            Table 1 Parameter description

            Parameter

            +
            - - - - - - - - - - - - - - - - - - - - - - - - - -
            Table 1 Path parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            namespace

            +

            namespace

            Yes

            +

            Yes

            String

            +

            String

            Organization name.

            +

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

            repository

            +

            repository

            Yes

            +

            Yes

            String

            +

            String

            Image repository name.

            -

            category

            -

            No

            -

            String

            -

            Repository type.

            -

            The value can be app_server, linux, framework_app, database, lang, other, windows or arm.

            -

            description

            -

            No

            -

            String

            -

            Repository description.

            -

            is_public

            -

            No

            -

            Boolean

            -

            Whether the repository is a public repository. The value can be either true or false.

            +

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

            Request

            • Request parameters

              N/A

              -
            • Example request
              PATCH https://{Endpoint}/v2/manage/namespaces/group/repos/busybox
              -

              Body:

              -
              -F "category=linux" \  
--F "description=this is a busybox repository" \  
--F "is_public=false"
              -

              Or

              -
              {
-    "category": "linux",
-    "description": "this is a busybox repository",
-    "is_public": false
-}
              -

              The form format will no longer be supported soon. You are advised to use the body in the JSON format to call the API.

              -
              -
            +

            Request Parameters

            +
            + + + + + + + + + + + + + + + + +
            Table 2 Request header parameters

            Parameter

            +

            Mandatory

            +

            Type

            +

            Description

            +

            Content-Type

            +

            Yes

            +

            String

            +

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

            +

            The default value is application/json.

            +

            X-Auth-Token

            +

            Yes

            +

            String

            +

            User token.

            +

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

            +
            -

            Response

            • Response parameters

              N/A

              -
            • Example response
              {}
              -
            + +
            + + + + + + + + + + + + + + + + + + + + + +
            Table 3 Request body parameters

            Parameter

            +

            Mandatory

            +

            Type

            +

            Description

            +

            is_public

            +

            Yes

            +

            Boolean

            +

            Whether the repository is public. true indicates that the repository is public. false indicates that the repository is private.

            +

            category

            +

            No

            +

            String

            +

            Repository type. The value can be app_server, linux, framework_app, database, lang, arm, or other.

            +

            description

            +

            No

            +

            String

            +

            Brief description of the image repository.

            +
            +
            +
            +

            Response Parameters

            None

            +
            +

            Example Request

            PATCH https://{endpoint}/v2/manage/namespaces/{namespace}/repos/{repository}
+
+{
+  "category" : "database",
+  "description" : "this is a busybox repository",
+  "is_public" : false
+}
            +
            +

            Example Response

            None

            Status Code

            -
            -

            Status Code

            +
            - - - - - - - - - - -

            Status Code

            Description

            +

            Description

            201

            +

            201

            The brief information about the image repository is successfully updated.

            +

            The brief information about the image repository is successfully updated.

            400

            +

            400

            Request error. Error information is returned.

            +

            Request error. Error information is returned.

            401

            +

            401

            Authentication failed.

            +

            Authentication failed.

            404

            +

            404

            The repository does not exist.

            +

            The repository does not exist.

            500

            +

            500

            Internal error. Error information is returned.

            +

            Internal error. Error information is returned.
            +

            Error Codes

            For details, see Error Codes.

            +
            -
            Parent topic: API
            +
            Parent topic: Image Repository Management
            diff --git a/docs/swr/api-ref/swr_02_0033.html b/docs/swr/api-ref/swr_02_0033.html index deef8754..1aef3f6a 100644 --- a/docs/swr/api-ref/swr_02_0033.html +++ b/docs/swr/api-ref/swr_02_0033.html @@ -76,7 +76,7 @@

            String

            Image repository type. The value can be app_server, linux, framework_app, database, lang, other, windows, or arm.

            +

            Image repository type. The value can be app_server, linux, framework_app, database, lang, arm, or other.

            description

            @@ -238,10 +238,12 @@
            +

            Error Codes

            For details, see Error Codes.

            +
            -
            Parent topic: API
            +
            Parent topic: Image Repository Management
            diff --git a/docs/swr/api-ref/swr_02_0034.html b/docs/swr/api-ref/swr_02_0034.html index d0d7e498..68320beb 100644 --- a/docs/swr/api-ref/swr_02_0034.html +++ b/docs/swr/api-ref/swr_02_0034.html @@ -3,95 +3,98 @@

            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 Table 1.

            -

            At least one filter parameter must be transferred.

            -
            +

            URI

            GET /v2/manage/repos

            -
            Table 1 Parameter description

            Parameter

            +
            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -99,7 +102,7 @@

            Request

            • Request parameters

              N/A

              -
            • Example request
              GET https://{Endpoint}/v2/manage/repos?filter=center::self|namespace::group|name::busybox
              +
            • Example request
              GET https://{Endpoint}/v2/manage/repos?center=self&namespace=group&name=busybox

            Response

            • Response parameters @@ -115,7 +118,7 @@
            - @@ -162,7 +165,7 @@ - -
            Table 1 Query parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            center

            +

            namespace

            No

            +

            No

            String

            +

            String

            The value can only be self, indicating that the image is a self-owned image.

            +

            Organization name. An organization name contains 1 to 64 characters. It must start with a lowercase letter and end with a lowercase letter or digit. Only lowercase letters, digits, periods (.), underscores (_), and hyphens (-) are allowed. Periods, underscores, and hyphens cannot be placed next to each other. A maximum of two consecutive underscores are allowed.

            namespace

            +

            name

            No

            +

            No

            String

            +

            String

            Organization name.

            +

            Image repository name.

            name

            +

            category

            No

            +

            No

            String

            +

            String

            Image repository name.

            +

            Repository type. The value can be app_server, linux, framework_app, database, lang, arm, or other.

            category

            +

            limit

            No

            +

            No

            String

            +

            String

            Image repository type. The value can be app_server, linux, framework_app, database, lang, other, windows, or arm.

            +

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

            offset

            +

            offset

            No

            +

            No

            String

            +

            String

            Start index.

            -

            Ensure that the offset and limit parameters are used together.

            +

            Start index. The value can be 0 or a positive integer multiple of the limit value. If this parameter is not specified, the start index is 0 by default.

            +

            Parameters offset and limit should always be used together.

            limit

            +

            order_column

            No

            +

            No

            String

            +

            String

            Number of returned records.

            -

            Ensure that the offset and limit parameters are used together.

            +

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

            order_column

            +

            order_type

            No

            +

            No

            String

            +

            String

            Sorting criteria. The value can be name, updated_time, or tag_count.

            -

            Ensure that the order_column and order_type parameters are used together.

            +

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

            order_type

            +

            filter

            No

            +

            No

            String

            +

            String

            Sorting type. You can set this parameter to desc (descending sort) and asc (ascending sort).

            -

            Ensure that the order_column and order_type parameters are used together.

            +

            Pass at least one of the following filter parameters:

            +

            namespace: organization name. It supports fuzzy match.

            +

            name: image repository name. It supports fuzzy match.

            +

            category: image repository type. The value can be app_server, linux, framework_app, database, lang, arm, or other.

            +

            limit: number of returned records.

            +

            offset: the start index.

            +

            Parameters offset and limit should always be used together.

            +

            order_column: sorting by column. It can be set to name, updated_time, or tag_count.

            +

            order_type: sorting type. It can be set to desc (descending order) or asc (ascending order).

            +

            Parameters order_column and order_type should always be used together.

            String

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

            +

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

            String

            Image repository type. The value can be app_server, linux, framework_app, database, lang, other, windows, or arm.

            +

            Image repository type. The value can be app_server, linux, framework_app, database, lang, arm, or other.

            description

            @@ -246,7 +249,7 @@

            String

            Account name.

            +

            Domain name.

            namespace

            @@ -338,10 +341,12 @@
            +

            Error Codes

            For details, see Error Codes.

            +
            -
            Parent topic: API
            +
            Parent topic: Image Repository Management
            diff --git a/docs/swr/api-ref/swr_02_0035.html b/docs/swr/api-ref/swr_02_0035.html index cbd2ff1a..719d6b1c 100644 --- a/docs/swr/api-ref/swr_02_0035.html +++ b/docs/swr/api-ref/swr_02_0035.html @@ -3,7 +3,7 @@

            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}

            +

            URI

            GET /v2/manage/namespaces/{namespace}/repos/{repository}/tags?offset={offset}&limit={limit}&order_column={order_column}&order_type={order_type}&tag={tag}

            For details about parameters, see Table 1.

            -
            Table 1 Parameter description

            Parameter

            @@ -34,199 +34,276 @@

            Image repository name.

            offset

            + +
            +
            + +
            + + + + + + - - - - - - - - - - - - - - - - - - - + + + + +
            Table 2 Query parameters

            Parameter

            +

            Mandatory

            +

            Type

            +

            Description

            +

            limit

            No

            +

            No

            Integer

            +

            String

            Start index.

            +

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

            limit

            +

            offset

            No

            +

            No

            Integer

            +

            String

            Number of responses.

            +

            Start index. The value can be 0 or a positive integer multiple of the limit value. If this parameter is not specified, all records will be returned by default.

            +

            Parameters offset and limit should always be used together.

            order_column

            +

            order_column

            No

            +

            No

            String

            +

            String

            Sorting by column. You can set this parameter to updated_at (sorting by update time).

            +

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

            order_type

            +

            order_type

            No

            +

            No

            String

            +

            String

            Sorting type. You can set this parameter to desc (descending sort) and asc (ascending sort).

            +

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

            tag

            +

            tag

            No

            +

            No

            String

            +

            String

            Image tag name.

            +

            Image tag name.

            +

            filter

            +

            No

            +

            String

            +

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

            Request

            • Request parameters

              N/A

              -
            • Example request
              GET https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/tags
              -
            -
            -

            Response

            • Response parameters -
              Table 2 Response body parameter description

              Parameter

              +

              Request

              • Request parameters +
                - - + - - - + + + + + + + + +
                Table 3 Request header parameters

                Parameter

                Type

                +

                Mandatory

                Description.

                +

                Type

                +

                Description

                [Array element]

                +

                Content-Type

                Array of objects

                +

                Yes

                Image repository tag list.

                +

                String

                +

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

                +

                The default value is application/json.

                +

                X-Auth-Token

                +

                Yes

                +

                String

                +

                User token.

                +

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

                +
                +
                +
              • Example request
                GET https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/tags
                +
              +
              +

              Response

              • Response parameters

                Status code: 200

                + +
                + + + + + + +
                Table 4 Response header parameters

                Parameter

                +

                Type

                +

                Description

                +

                Content-Range

                +

                String

                +

                Offset (Start index) – Count (Number of records on the current page)/Total (Total number of records)
                -
                Table 3 [Array element] parameters description

                Parameter

                +
                - - - - - - +
                Table 5 Response body parameters

                Parameter

                Type

                +

                Type

                Description

                +

                Description

                id

                +

                [Array]

                Integer

                +

                Array of ShowReposTagResp objects

                ID

                +

                Image tags.

                repo_id

                +
                +
                + +
                + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + - - - - - - - - - - - - - - - - - - @@ -290,10 +367,12 @@
                Table 6 [Array element] parameters description

                Parameter

                +

                Type

                +

                Description

                +

                id

                Integer

                +

                Integer

                Repository ID.

                +

                ID

                Tag

                +

                repo_id

                String

                +

                Integer

                Image tag name.

                +

                Repository ID.

                image_id

                +

                Tag

                String

                +

                String

                Image ID.

                +

                Image tag name.

                manifest

                +

                image_id

                String

                +

                String

                Image manifest.

                +

                Image ID.

                digest

                +

                manifest

                String

                +

                String

                SHA value of an image.

                +

                Image manifest.

                schema

                +

                digest

                Integer

                +

                String

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

                +

                SHA value of an image.

                path

                +

                schema

                String

                +

                Integer

                External image pull address. The format is {Repository address}/{Namespace name}/{Repository name}:{Tag name}.

                +

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

                internal_path

                +

                path

                String

                +

                String

                Internal image pull address. The format is {Repository address}/{Namespace name}/{Repository name}:{Tag name}.

                +

                External image pull address. The format is {Repository address}/{Namespace name}/{Repository name}:{Tag name}.

                size

                +

                internal_path

                Integer

                +

                String

                Image size.

                +

                Internal image pull address. The format is {Repository address}/{Namespace name}/{Repository name}:{Tag name}.

                +

                size

                +

                Integer

                +

                Image size.

                Value range: 0 to 9223372036854775807

                Unit: byte

                is_trusted

                +

                is_trusted

                Boolean

                +

                Boolean

                By default, the value is false.

                +

                By default, the value is false.

                created

                +

                created

                String

                +

                String

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

                +

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

                updated

                +

                updated

                String

                +

                String

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

                +

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

                deleted

                +

                deleted

                String

                +

                String

                Time when an image was deleted.

                +

                Time when an image was deleted.

                domain_id

                +

                domain_id

                String

                +

                String

                Account ID.

                +

                Account ID.

                tag_type

                +

                tag_type

                Integer

                +

                Integer

                0: manifest. 1: manifest list.

                +

                0: manifest. 1: manifest list.
                +

                Error Codes

                For details, see Error Codes.

                +
                -
                Parent topic: API
                +
                Parent topic: Image Tag Management
                diff --git a/docs/swr/api-ref/swr_02_0036.html b/docs/swr/api-ref/swr_02_0036.html index 334834c2..6b2f86fe 100644 --- a/docs/swr/api-ref/swr_02_0036.html +++ b/docs/swr/api-ref/swr_02_0036.html @@ -47,7 +47,40 @@
              -

              Request

              • Request parameters

                N/A

                +

                Request

                • Request parameters +
                  + + + + + + + + + + + + + + + + +
                  Table 2 Request header parameters

                  Parameter

                  +

                  Mandatory

                  +

                  Type

                  +

                  Description

                  +

                  Content-Type

                  +

                  Yes

                  +

                  String

                  +

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

                  +

                  The default value is application/json.

                  +

                  X-Auth-Token

                  +

                  Yes

                  +

                  String

                  +

                  User token.

                  +

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

                  +
                  +
                • Example request
                  DELETE https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/tags/v1
                @@ -89,10 +122,12 @@
            +

            Error Codes

            For details, see Error Codes.

            +
            -
            Parent topic: API
            +
            Parent topic: Image Tag Management
            diff --git a/docs/swr/api-ref/swr_02_0042.html b/docs/swr/api-ref/swr_02_0042.html index 9ae3d3f0..cd240c68 100644 --- a/docs/swr/api-ref/swr_02_0042.html +++ b/docs/swr/api-ref/swr_02_0042.html @@ -3,26 +3,28 @@

            Creating Organization Permissions

            Function

            Grant permissions of an organization to certain users so that they can manage, edit, and read images from the organization.

            +

            Constraints

            None

            +

            URI

            POST /v2/manage/namespaces/{namespace}/access

            Table 1 describes the parameters.

            -
            Table 1 Parameter description

            Parameter

            +
            - - - - - - - @@ -30,130 +32,164 @@

            Request

            • Request parameters -
            Table 1 Parameter description

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            namespace

            +

            namespace

            Yes

            +

            Yes

            String

            +

            String

            Organization name.

            +

            Organization name.
            Table 2 Request body description

            Parameter

            +
            - - - - - - - + + + + +
            Table 2 Request header parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            [Array element]

            +

            Content-Type

            Yes

            +

            Yes

            Array of objects

            +

            String

            Information required for creating organization permissions.

            +

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

            +

            The default value is application/json.

            +

            X-Auth-Token

            +

            Yes

            +

            String

            +

            User token.

            +

            The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
            -
            Table 3 [Array element]

            Parameter

            +
            - - - - - - - - +
            Table 3 Request body parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            user_id

            +

            [Array element]

            Yes

            +

            Yes

            String

            +

            Array of objects

            User ID.

            +

            Information required for creating organization permissions.

            user_name

            +
            +
            + +
            + + + + + + - - - - - - - + + + + +
            Table 4 [Array element]

            Parameter

            +

            Mandatory

            +

            Type

            +

            Description

            +

            user_id

            Yes

            +

            Yes

            String

            +

            String

            Username.

            +

            User ID. Obtain it from IAM.

            auth

            +

            user_name

            Yes

            +

            Yes

            Integer

            +

            String

            User permission

            +

            Username. Obtain it from IAM.

            +

            auth

            +

            Yes

            +

            Integer

            +

            User permission

            • 7: Manage
            • 3: Write
            • 1: Read
            -
          • Example request
            POST https://{Endpoint}/v2/manage/namespaces/group/access
            -

            Body:

            -
            [
-    {
-        "user_id": "fb3f175c1fd146ab8cdae3272be6107b",
-        "user_name": "user01",
-        "auth": 1
-    }
-]
            +
          • Example request
            POST https://{endpoint}/v2/manage/namespaces/{namespace}/access
+
+[ {
+  "user_id" : "fb3f175c1fd146ab8cdae3272be6107b",
+  "user_name" : "user01",
+  "auth" : 1
+} ]

            • Response

            • Response parameters

              N/A

              -
            • Example response
              {}
              +
            • Example response
              None

            Status Code

            -

            Status Code

            +
            - - - - - - - - - - - - -

            Status Code

            Description

            +

            Description

            201

            +

            201

            Creation successful.

            +

            Creation successful.

            400

            +

            400

            Request error.

            +

            Request error.

            401

            +

            401

            Authentication failed.

            +

            Authentication failed.

            404

            +

            404

            The organization does not exist.

            +

            The organization does not exist.

            409

            +

            409

            The organization permission already exists.

            +

            The organization permission already exists.

            500

            +

            500

            Internal error.

            +

            Internal error.
            +

            Error Codes

            For details, see Error Codes.

            +
            -
            Parent topic: API
            +
            Parent topic: Organization Permission Management
            diff --git a/docs/swr/api-ref/swr_02_0043.html b/docs/swr/api-ref/swr_02_0043.html index a902068e..a4d443e7 100644 --- a/docs/swr/api-ref/swr_02_0043.html +++ b/docs/swr/api-ref/swr_02_0043.html @@ -30,31 +30,65 @@

            Request

            • Request parameters -
              Table 2 Request body parameter description

              Parameter

              +
              - - - - - - - + + + + +
              Table 2 Request header parameters

              Parameter

              Mandatory

              +

              Mandatory

              Type

              +

              Type

              Description

              +

              Description

              [Array element]

              +

              Content-Type

              Yes

              +

              Yes

              Array of strings

              +

              String

              ID array of users whose permissions need to be deleted.

              +

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

              +

              The default value is application/json.

              +

              X-Auth-Token

              +

              Yes

              +

              String

              +

              User token.

              +

              The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
              -
            • Example request
              DELETE https://{Endpoint}/v2/manage/namespaces/group/access
              -

              Body:

              -
              ["fb3f175c1fd146ab8cdae3272be6107b"]
              + +
              + + + + + + + + + + + +
              Table 3 Request body parameter description

              Parameter

              +

              Mandatory

              +

              Type

              +

              Description

              +

              [Array element]

              +

              Yes

              +

              Array of strings

              +

              ID list of users whose permissions need to be deleted. Obtain the list from IAM.

              +
              +
              +
            • Example request
              DELETE https://{Endpoint}/v2/manage/namespaces/group/access
+
+["fb3f175c1fd146ab8cdae3272be6107b"]

              • Response

              N/A

              @@ -95,10 +129,12 @@
            +

            Error Codes

            For details, see Error Codes.

            +
            -
            Parent topic: API
            +
            Parent topic: Organization Permission Management
            diff --git a/docs/swr/api-ref/swr_02_0044.html b/docs/swr/api-ref/swr_02_0044.html index 11b57537..1a5a8ba3 100644 --- a/docs/swr/api-ref/swr_02_0044.html +++ b/docs/swr/api-ref/swr_02_0044.html @@ -30,79 +30,111 @@

            Request

            • Request parameters -
              Table 2 Request body parameter description

              Parameter

              +
              - - - - - - - + + + + +
              Table 2 Request header parameters

              Parameter

              Mandatory

              +

              Mandatory

              Type

              +

              Type

              Description

              +

              Description

              [Array element]

              +

              Content-Type

              Yes

              +

              Yes

              Array of objects

              +

              String

              Information required for updating organization permissions

              +

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

              +

              The default value is application/json.

              +

              X-Auth-Token

              +

              Yes

              +

              String

              +

              User token.

              +

              The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
              -
              Table 3 [Array element]

              Parameter

              +
              - - - - - - - - +
              Table 3 Request body parameter description

              Parameter

              Mandatory

              +

              Mandatory

              Type

              +

              Type

              Description

              +

              Description

              user_id

              +

              [Array element]

              Yes

              +

              Yes

              String

              +

              Array of objects

              User ID.

              +

              Information required for updating organization permissions

              user_name

              +
              +
              + +
              + + + + + + - - - - - - - + + + + +
              Table 4 [Array element]

              Parameter

              +

              Mandatory

              +

              Type

              +

              Description

              +

              user_id

              Yes

              +

              Yes

              String

              +

              String

              Username.

              +

              User ID. Obtain it from IAM.

              auth

              +

              user_name

              Yes

              +

              Yes

              Integer

              +

              String

              User permission

              +

              Username. Obtain it from IAM.

              +

              auth

              +

              Yes

              +

              Integer

              +

              User permission

              • 7: Manage
              • 3: Write
              • 1: Read
              -
            • Example request
              PATCH https://{Endpoint}/v2/manage/namespaces/group/access
              -

              Body:

              -
              [
-    {
-        "user_id": "fb3f175c1fd146ab8cdae3272be6107b",
-        "user_name": "user01",
-        "auth": 7
-    }
-]
              +
            • Example request
              PATCH https://{endpoint}/v2/manage/namespaces/{namespace}/access
+
+[ {
+  "user_id" : "fb3f175c1fd146ab8cdae3272be6107b",
+  "user_name" : "user01",
+  "auth" : 7
+} ]

              • Response

              • Response parameters

                N/A

                @@ -145,10 +177,12 @@
              +

              Error Codes

              For details, see Error Codes.

              +
              -
              Parent topic: API
              +
              Parent topic: Organization Permission Management
              diff --git a/docs/swr/api-ref/swr_02_0045.html b/docs/swr/api-ref/swr_02_0045.html index c6e55a05..e1a9b4fe 100644 --- a/docs/swr/api-ref/swr_02_0045.html +++ b/docs/swr/api-ref/swr_02_0045.html @@ -29,124 +29,124 @@
            -

            Request

            • Request parameters

              N/A

              -
            • Example request
              GET https://{Endpoint}/v2/manage/namespaces/group/access
              -
            -
            -

            Response

            • Response parameters -
              Table 2 Response body parameters

              Parameter

              +

              Request

              • Request parameters +
                - - + - - - + - - - + - +
                Table 2 Request header parameters

                Parameter

                Type

                +

                Mandatory

                Description

                +

                Type

                +

                Description

                id

                +

                Content-Type

                Integer

                +

                Yes

                Permission ID.

                +

                String

                +

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

                +

                The default value is application/json.

                name

                +

                X-Auth-Token

                String

                +

                Yes

                Organization name.

                +

                String

                +

                User token.

                +

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

                creator_name

                +
                +
                +
              • Example request
                GET https://{Endpoint}/v2/manage/namespaces/group/access
                +
              +
              +

              Response

              • Response parameters
                Status code: 200 +
                + + + + + - - - - - - - - + + + + + + + +
                Table 3 Response body parameters

                Parameter

                +

                Type

                +

                Description

                +

                id

                String

                +

                Integer

                Organization creator.

                +

                Permission ID.

                self_auth

                +

                name

                Object

                +

                String

                Permissions of the current user.

                +

                Organization name.

                others_auths

                +

                creator_name

                Array of objects

                +

                String

                Permissions of other users.

                +

                Organization creator.

                +

                self_auth

                +

                Object

                +

                Permissions of the current user.

                +

                others_auths

                +

                Array of objects

                +

                Permissions of other users.
                -
                Table 3 self_auth parameter description

                Parameter

                +
                - - - - - - - - - - -
                Table 4 self_auth parameter description

                Parameter

                Type

                +

                Type

                Description

                +

                Description

                user_id

                +

                user_id

                String

                +

                String

                User ID.

                +

                User ID.

                user_name

                +

                user_name

                String

                +

                String

                Username.

                +

                Username.

                auth

                +

                auth

                Integer

                +

                Integer

                User permission

                +

                User permission

                • 7: Manage
                • 3: Write
                • 1: Read
                - -
                - - - - - - - - - - - - - - - - - -
                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
                {
     "id": 1334795,
@@ -208,10 +208,12 @@
                • +

                Error Codes

                For details, see Error Codes.

                +
              -
              Parent topic: API
              +
              Parent topic: Organization Permission Management
              diff --git a/docs/swr/api-ref/swr_02_0046.html b/docs/swr/api-ref/swr_02_0046.html index ef6c5a3a..ed0a7f92 100644 --- a/docs/swr/api-ref/swr_02_0046.html +++ b/docs/swr/api-ref/swr_02_0046.html @@ -39,83 +39,115 @@

              Request

              • Request parameters -
                Table 2 Request body parameter description

                Parameter

                +
                - - - - - - - + + + + +
                Table 2 Request header parameters

                Parameter

                Mandatory

                +

                Mandatory

                Type

                +

                Type

                Description.

                +

                Description

                [Array element]

                +

                Content-Type

                Yes

                +

                Yes

                Array of objects

                +

                String

                User list

                +

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

                +

                The default value is application/json.

                +

                X-Auth-Token

                +

                Yes

                +

                String

                +

                User token.

                +

                The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
                -
                Table 3 [Array element] parameters decription

                Parameter

                +
                - - - - - - - - +
                Table 3 Request body parameter description

                Parameter

                Mandatory

                +

                Mandatory

                Type

                +

                Type

                Description

                +

                Description.

                user_id

                +

                [Array element]

                Yes

                +

                Yes

                String

                +

                Array of objects

                User ID.

                +

                User list

                user_name

                +
                +
                + +
                + + + + + + - - - - - - - + + + + +
                Table 4 [Array element] parameters decription

                Parameter

                +

                Mandatory

                +

                Type

                +

                Description

                +

                user_id

                Yes

                +

                Yes

                String

                +

                String

                Username.

                +

                User ID.

                auth

                +

                user_name

                Yes

                +

                Yes

                Integer

                +

                String

                User permission that is configured.

                +

                Username.

                +

                auth

                +

                Yes

                +

                Integer

                +

                User permission that is configured.

                • 7: Manage
                • 3: Write
                • 1: Read
                -
              • Example request
                POST https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/access
                -

                Body:

                -
                [
-    {
-        "user_id": "fb3f175c1fd146ab8cdae3272be6107b",
-        "user_name": "user01",
-        "auth": 1
-    }
-]
                +
              • Example request
                POST https://{endpoint}/v2/manage/namespaces/{namespace}/repos/{repository}/access
+
+[ {
+  "user_id" : "fb3f175c1fd146ab8cdae3272be6107b",
+  "user_name" : "user01",
+  "auth" : 1
+} ]

                • Response

                • Response parameters

                  N/A

                  -
                • Example response
                  {}
                  +
                • Example response

                  None

                Status Code

                @@ -154,10 +186,12 @@
                +

                Error Codes

                For details, see Error Codes.

                +
                -
                Parent topic: API
                +
                Parent topic: Image Permission Management
                diff --git a/docs/swr/api-ref/swr_02_0047.html b/docs/swr/api-ref/swr_02_0047.html index 35f3caf9..d5284f17 100644 --- a/docs/swr/api-ref/swr_02_0047.html +++ b/docs/swr/api-ref/swr_02_0047.html @@ -3,35 +3,37 @@

                Deleting Image Permissions

                Function

                Delete the image operation permissions of certain users.

                +

                Constraints

                None

                +

                URI

                DELETE /v2/manage/namespaces/{namespace}/repos/{repository}/access

                For details about parameters, see Table 1.

                -
                Table 1 Parameter description

                Parameter

                +
                - - - - - - - - - - - @@ -39,75 +41,111 @@

                Request

                • Request parameters -
                Table 1 Parameter description

                Parameter

                Mandatory

                +

                Mandatory

                Type

                +

                Type

                Description

                +

                Description

                namespace

                +

                namespace

                Yes

                +

                Yes

                String

                +

                String

                Organization name.

                +

                Organization name.

                repository

                +

                repository

                Yes

                +

                Yes

                String

                +

                String

                Image name.

                +

                Image name.
                Table 2 Request body parameter description

                Parameter

                +
                - - - - - - - + + + + +
                Table 2 Request header parameters

                Parameter

                Mandatory

                +

                Mandatory

                Type

                +

                Type

                Description

                +

                Description

                [Array element]

                +

                Content-Type

                Yes

                +

                Yes

                Array of strings

                +

                String

                ID array of users whose permissions need to be deleted.

                +

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

                +

                The default value is application/json.

                +

                X-Auth-Token

                +

                Yes

                +

                String

                +

                User token.

                +

                The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
                -
              • Example request
                DELETE https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/access
                -

                Body:

                -
                ["fb3f175c1fd146ab8cdae3272be6107b"]
                + +
                + + + + + + + + + + + +
                Table 3 Request body parameter description

                Parameter

                +

                Mandatory

                +

                Type

                +

                Description

                +

                [Array element]

                +

                Yes

                +

                Array of strings

                +

                ID array of users whose permissions need to be deleted.

                +
                +
                +
              • Example request
                DELETE https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/access
+
+[ "fb3f175c1fd146ab8cdae3272be6107b" ]

                • Response

                N/A

                Status Code

                -

                Status Code

                +
                - - - - - - - - - - -

                Status Code

                Description

                +

                Description

                204

                +

                204

                Deleted successfully.

                +

                Deletion succeeded.

                400

                +

                400

                Request error.

                +

                Request error.

                401

                +

                401

                Authentication failed.

                +

                Authentication failed.

                404

                +

                404

                The image does not exist.

                +

                The image does not exist.

                500

                +

                500

                Internal error.

                +

                Internal error.
                +

                Error Codes

                For details, see Error Codes.

                +
                -
                Parent topic: API
                +
                Parent topic: Image Permission Management
                diff --git a/docs/swr/api-ref/swr_02_0048.html b/docs/swr/api-ref/swr_02_0048.html index 6fdfd7dd..7b03e173 100644 --- a/docs/swr/api-ref/swr_02_0048.html +++ b/docs/swr/api-ref/swr_02_0048.html @@ -3,35 +3,37 @@

                Updating Image Permissions

                Function

                Update the image operation permissions for certain users.

                +

                Constraints

                None

                +

                URI

                PATCH /v2/manage/namespaces/{namespace}/repos/{repository}/access

                For details about parameters, see Table 1.

                -
                Table 1 Parameter description

                Parameter

                +
                - - - - - - - - - - - @@ -39,102 +41,159 @@

                Request

                • Request parameters -
                Table 1 Parameter description

                Parameter

                Mandatory

                +

                Mandatory

                Type

                +

                Type

                Description

                +

                Description

                namespace

                +

                namespace

                Yes

                +

                Yes

                String

                +

                String

                Organization name

                +

                Organization name

                repository

                +

                repository

                Yes

                +

                Yes

                String

                +

                String

                Image name

                +

                Image name
                Table 2 Request body parameter description

                Parameter

                +
                - - - - - - - - - - - - +
                Table 2 Request header parameters

                Parameter

                Mandatory

                +

                Mandatory

                Type

                +

                Type

                Description

                +

                Description

                user_id

                +

                Content-Type

                Yes

                +

                Yes

                String

                +

                String

                User ID.

                +

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

                +

                The default value is application/json.

                user_name

                +

                X-Auth-Token

                Yes

                +

                Yes

                String

                +

                String

                Username.

                +

                User token.

                +

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

                auth

                +
                +
                + +
                + + + + + + - - - + + +
                Table 3 Request body parameter description

                Parameter

                +

                Mandatory

                +

                Type

                +

                Description

                +

                [Array element]

                Yes

                +

                Yes

                Integer

                +

                Array of objects

                User permission that is configured.

                +

                Information about the image permission to be updated.

                +
                +
                + +
                + + + + + + + + + + + + + + + + + + +
                Table 4 [Array element] parameter description

                Parameter

                +

                Mandatory

                +

                Type

                +

                Description

                +

                user_id

                +

                Yes

                +

                String

                +

                User ID. Obtain it from IAM.

                +

                user_name

                +

                Yes

                +

                String

                +

                Username. Obtain it from IAM.

                +

                auth

                +

                Yes

                +

                Integer

                +

                User permission that is configured.

                • 7: Manage
                • 3: Write
                • 1: Read
                -
              • Example request
                PATCH https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/access
                -

                Body:

                -
                [
-    {
-        "user_id": "fb3f175c1fd146ab8cdae3272be6107b",
-        "user_name": "user01",
-        "auth": 7
-    }
-]
                +
              • Example request
                PATCH https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/access
+
+[ {
+  "user_id" : "fb3f175c1fd146ab8cdae3272be6107b",
+  "user_name" : "user01",
+  "auth" : 7
+} ]

                • Response

                • Response parameters

                  N/A

                  -
                • Example response
                  {}
                  +
                • Example response

                  None

                Status Code

                -

                Status Code

                +
                - - - - - - - - - - -

                Status Code

                Description

                +

                Description

                201

                +

                201

                Updated successfully.

                +

                Updated successfully.

                400

                +

                400

                Request error.

                +

                Request error.

                401

                +

                401

                Authentication failed.

                +

                Authentication failed.

                404

                +

                404

                The image or the image permission does not exist.

                +

                The image or the image permission does not exist.

                500

                +

                500

                Internal error.

                +

                Internal error.
                +

                Error Codes

                For details, see Error Codes.

                +
                -
                Parent topic: API
                +
                Parent topic: Image Permission Management
                diff --git a/docs/swr/api-ref/swr_02_0049.html b/docs/swr/api-ref/swr_02_0049.html index 9b86ccc9..b53ac7e3 100644 --- a/docs/swr/api-ref/swr_02_0049.html +++ b/docs/swr/api-ref/swr_02_0049.html @@ -3,113 +3,148 @@

                Querying Image Permissions

                Function

                Query image permissions.

                +

                Constraints

                None

                +

                URI

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

                For details about parameters, see Table 1.

                -
                Table 1 Parameter description

                Parameter

                +
                - - - - - - - - - - -
                Table 1 Parameter description

                Parameter

                Mandatory

                +

                Mandatory

                Type

                +

                Type

                Description

                +

                Description

                namespace

                +

                namespace

                Yes

                +

                Yes

                String

                +

                String

                Organization name

                +

                Organization name

                repository

                +

                repository

                Yes

                +

                Yes

                String

                +

                String

                Image name

                +

                Image name
                -

                Request

                • Request parameters

                  N/A

                  +

                  Request

                  • Request parameters +
                    + + + + + + + + + + + + + + + + +
                    Table 2 Request header parameters

                    Parameter

                    +

                    Mandatory

                    +

                    Type

                    +

                    Description

                    +

                    Content-Type

                    +

                    Yes

                    +

                    String

                    +

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

                    +

                    The default value is application/json.

                    +

                    X-Auth-Token

                    +

                    Yes

                    +

                    String

                    +

                    User token.

                    +

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

                    +
                    +
                  • Example request
                    GET https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/access

                  Response

                  • Response parameters -
                    Table 2 Response body parameter description

                    Parameter

                    +
                    - - - - - - - - - - - - - -
                    Table 3 Response body parameter description

                    Parameter

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    id

                    +

                    id

                    Integer

                    +

                    Integer

                    Permission ID.

                    +

                    Permission ID.

                    name

                    +

                    name

                    String

                    +

                    String

                    Image name.

                    +

                    Image name.

                    self_auth

                    +

                    self_auth

                    Object

                    +

                    Object

                    Permissions of the current user.

                    +

                    Permissions of the current user.

                    others_auths

                    +

                    others_auths

                    Array of objects

                    +

                    Array of objects

                    Permissions of other users.

                    +

                    Permissions of other users.
                    -
                    Table 3 self_auth parameter description

                    Parameter

                    +
                    - - - - - - - - - - - @@ -117,33 +152,33 @@
                    Table 4 self_auth parameter description

                    Parameter

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    user_id

                    +

                    user_id

                    String

                    +

                    String

                    User ID

                    +

                    User ID

                    user_name

                    +

                    user_name

                    String

                    +

                    String

                    Username

                    +

                    Username

                    auth

                    +

                    auth

                    Integer

                    +

                    Integer

                    User permission

                    +

                    User permission

                    • 7: Manage
                    • 3: Write
                    • 1: Read
                    -
                    Table 4 others_auths parameter description

                    Parameter

                    +
                    - - - - - - - - - - - @@ -169,45 +204,47 @@

                    Status Code

                    -
                    Table 5 others_auths parameter description

                    Parameter

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    user_id

                    +

                    user_id

                    String

                    +

                    String

                    User ID

                    +

                    User ID

                    user_name

                    +

                    user_name

                    String

                    +

                    String

                    Username

                    +

                    Username

                    auth

                    +

                    auth

                    Integer

                    +

                    Integer

                    User permission

                    +

                    User permission

                    • 7: Manage
                    • 3: Write
                    • 1: Read
                    - + + + diff --git a/docs/swr/api-ref/swr_02_0070.html b/docs/swr/api-ref/swr_02_0070.html index 936b8652..8fdf6a16 100644 --- a/docs/swr/api-ref/swr_02_0070.html +++ b/docs/swr/api-ref/swr_02_0070.html @@ -1,7 +1,7 @@

                    Creating an Account Used for Image Sharing

                    -

                    Function

                    Create an account used for image sharing. You can share your private images with other users, granting them permissions to pull the images.

                    +

                    Function

                    Create an account used for image sharing. You can share your private images with other users, granting them permissions to pull the images.

                    URI

                    POST /v2/manage/namespaces/{namespace}/repositories/{repository}/access-domains

                    For details about parameters, see Table 1.

                    @@ -22,7 +22,7 @@
                    -

                    Status Code

                    +
                    - - - - - - - - - - -

                    Status Code

                    Description

                    +

                    Description

                    200

                    +

                    200

                    Query succeeded.

                    +

                    Query succeeded.

                    400

                    +

                    400

                    Request error.

                    +

                    Request error.

                    401

                    +

                    401

                    Authentication failed.

                    +

                    Authentication failed.

                    404

                    +

                    404

                    The image or the image permission does not exist.

                    +

                    The image or the image permission does not exist.

                    500

                    +

                    500

                    Internal error.

                    +

                    Internal error.
                    +

                    Error Codes

                    For details, see Error Codes.

                    +
                    -
                    Parent topic: API
                    +
                    Parent topic: Image Permission Management
                    diff --git a/docs/swr/api-ref/swr_02_0064.html b/docs/swr/api-ref/swr_02_0064.html index 708286e3..e842c5f1 100644 --- a/docs/swr/api-ref/swr_02_0064.html +++ b/docs/swr/api-ref/swr_02_0064.html @@ -8,7 +8,12 @@

                    2021-08-30

                    +

                    2024-10-12

                    +
                    • Updated URIs, example requests, parameter descriptions, and other information.
                    • Classified APIs based on their functions.
                    +

                    2021-08-30

                    Optimized the whole document, including optimizing the function introduction, adding request examples, and improving parameter descriptions.

                    String

                    Organization name

                    +

                    Organization name. An organization name contains 1 to 64 characters. It must start with a lowercase letter and end with a lowercase letter or digit. Only lowercase letters, digits, periods (.), underscores (_), and hyphens (-) are allowed. Periods, underscores, and hyphens cannot be placed next to each other. A maximum of two consecutive underscores are allowed.

                    repository

                    @@ -39,50 +39,84 @@

                    Request

                    • Request parameters -
                      -
                      Table 2 Request body parameter description

                      Parameter

                      +
                      - - - - - - - - - - - - +
                      Table 2 Request header parameters

                      Parameter

                      Mandatory

                      +

                      Mandatory

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      access_domain

                      +

                      Content-Type

                      Yes

                      +

                      Yes

                      String

                      +

                      String

                      Name of the account used for image sharing.

                      +

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

                      +

                      The default value is application/json.

                      permit

                      +

                      X-Auth-Token

                      Yes

                      +

                      Yes

                      String

                      +

                      String

                      Currently, only the read permission is supported.

                      +

                      User token.

                      +

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

                      deadline

                      +
                      +
                      + +
                      + + + + + + - - - - - - - + + + + + + + + + + @@ -99,7 +133,7 @@

                      Response

                      • Response parameters

                        N/A

                        -
                      • Example response
                        {}
                        +
                      • Example response

                        None

                      Status Code

                      @@ -138,10 +172,12 @@
                      Table 3 Request body parameter description

                      Parameter

                      +

                      Mandatory

                      +

                      Type

                      +

                      Description

                      +

                      access_domain

                      Yes

                      +

                      Yes

                      String

                      +

                      String

                      Valid until (UTC). If the sharing is permanent, the value is forever. Otherwise, the sharing is valid until 00:00:00 of the next day.

                      +

                      Name of the account used for image sharing.

                      description

                      +

                      permit

                      No

                      +

                      Yes

                      String

                      +

                      String

                      Description.

                      +

                      Currently, only the read permission is supported.

                      +

                      deadline

                      +

                      Yes

                      +

                      String

                      +

                      Valid until (UTC). If the sharing is permanent, the value is forever. Otherwise, the sharing is valid until 00:00:00 of the next day.

                      +

                      description

                      +

                      No

                      +

                      String

                      +

                      Description.
                      +

                      Error Codes

                      For details, see Error Codes.

                      +
                      -
                      Parent topic: API
                      +
                      Parent topic: Shared Account Management
                      diff --git a/docs/swr/api-ref/swr_02_0071.html b/docs/swr/api-ref/swr_02_0071.html index b67128f3..66bbedce 100644 --- a/docs/swr/api-ref/swr_02_0071.html +++ b/docs/swr/api-ref/swr_02_0071.html @@ -22,7 +22,7 @@

                      String

                      Organization name.

                      +

                      Organization name. An organization name contains 1 to 64 characters. It must start with a lowercase letter and end with a lowercase letter or digit. Only lowercase letters, digits, periods (.), underscores (_), and hyphens (-) are allowed. Periods, underscores, and hyphens cannot be placed next to each other. A maximum of two consecutive underscores are allowed.

                      repository

                      @@ -47,7 +47,40 @@
                    -

                    Request

                    • Request parameters

                      N/A

                      +

                      Request

                      • Request parameters +
                        + + + + + + + + + + + + + + + + +
                        Table 2 Request header parameters

                        Parameter

                        +

                        Mandatory

                        +

                        Type

                        +

                        Description

                        +

                        Content-Type

                        +

                        Yes

                        +

                        String

                        +

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

                        +

                        The default value is application/json.

                        +

                        X-Auth-Token

                        +

                        Yes

                        +

                        String

                        +

                        User token.

                        +

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

                        +
                        +
                      • Example request
                        DELETE https://{Endpoint}/v2/manage/namespaces/group/repositories/busybox/access-domains/domain_name
                      @@ -84,10 +117,12 @@
                    +

                    Error Codes

                    For details, see Error Codes.

                    +
                    -
                    Parent topic: API
                    +
                    Parent topic: Shared Account Management
                    diff --git a/docs/swr/api-ref/swr_02_0072.html b/docs/swr/api-ref/swr_02_0072.html index d57860ec..ff7209ba 100644 --- a/docs/swr/api-ref/swr_02_0072.html +++ b/docs/swr/api-ref/swr_02_0072.html @@ -48,41 +48,75 @@

                    Request

                    • Request parameters -
                      -
                      Table 2 Request body parameter description

                      Parameter

                      +
                      - - - - - - - - - - - - +
                      Table 2 Request header parameters

                      Parameter

                      Mandatory

                      +

                      Mandatory

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      permit

                      +

                      Content-Type

                      Yes

                      +

                      Yes

                      String

                      +

                      String

                      Currently, only the read permission is supported.

                      +

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

                      +

                      The default value is application/json.

                      deadline

                      +

                      X-Auth-Token

                      Yes

                      +

                      Yes

                      String

                      +

                      String

                      Valid until (UTC). If the sharing is permanent, the value is forever. Otherwise, the sharing is valid until 00:00:00 of the next day.

                      +

                      User token.

                      +

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

                      description

                      +
                      +
                      + +
                      + + + + + + - - - + + + + + + + + + + @@ -133,7 +167,7 @@
                      -
                      Parent topic: API
                      +
                      Parent topic: Shared Account Management
                      diff --git a/docs/swr/api-ref/swr_02_0073.html b/docs/swr/api-ref/swr_02_0073.html index a2b5b970..1192fb34 100644 --- a/docs/swr/api-ref/swr_02_0073.html +++ b/docs/swr/api-ref/swr_02_0073.html @@ -47,107 +47,141 @@
                      Table 3 Request body parameter description

                      Parameter

                      +

                      Mandatory

                      +

                      Type

                      +

                      Description

                      +

                      permit

                      No

                      +

                      Yes

                      String

                      +

                      String

                      Description. This parameter is left blank by default.

                      +

                      Currently, only the read permission is supported.

                      +

                      deadline

                      +

                      Yes

                      +

                      String

                      +

                      Valid until (UTC). If the sharing is permanent, the value is forever. Otherwise, the sharing is valid until 00:00:00 of the next day.

                      +

                      description

                      +

                      No

                      +

                      String

                      +

                      Description. This parameter is left blank by default.
                      -

                      Request

                      • Request parameters

                        N/A

                        -
                      • Example request
                        GET https://{Endpoint}/v2/manage/namespaces/group/repositories/busybox/access-domains/domain_name
                        -
                      -
                      -

                      Response

                      • Response parameters -
                        Table 2 Response body parameter description

                        Parameter

                        +

                        Request

                        • Request parameters +
                          - - + - - - + - - - + - +
                          Table 2 Request header parameters

                          Parameter

                          Type

                          +

                          Mandatory

                          Description

                          +

                          Type

                          +

                          Description

                          exist

                          +

                          Content-Type

                          Boolean

                          +

                          Yes

                          true: Exist. false: Not exist.

                          +

                          String

                          +

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

                          +

                          The default value is application/json.

                          namespace

                          +

                          X-Auth-Token

                          String

                          +

                          Yes

                          Organization name.

                          +

                          String

                          +

                          User token.

                          +

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

                          repository

                          +
                          +
                          +
                        • Example request
                          GET https://{Endpoint}/v2/manage/namespaces/group/repositories/busybox/access-domains/domain_name
                          +
                        +
                        +

                        Response

                        • Response parameters
                          Status code: 200 +
                          + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + +
                          Table 3 Response body parameter description

                          Parameter

                          +

                          Type

                          +

                          Description

                          +

                          exist

                          String

                          +

                          Boolean

                          Image repository name.

                          +

                          true: Exist. false: Not exist.

                          access_domain

                          +

                          namespace

                          String

                          +

                          String

                          Name of the account used for image sharing.

                          +

                          Organization name.

                          permit

                          +

                          repository

                          String

                          +

                          String

                          Permission.

                          +

                          Image repository name.

                          deadline

                          +

                          access_domain

                          String

                          +

                          String

                          Expiration time.

                          +

                          Name of the account used for image sharing.

                          description

                          +

                          permit

                          String

                          +

                          String

                          Description.

                          +

                          Permission.

                          creator_id

                          +

                          deadline

                          String

                          +

                          String

                          Creator ID.

                          +

                          Expiration time.

                          creator_name

                          +

                          description

                          String

                          +

                          String

                          Name of the creator.

                          +

                          Description.

                          created

                          +

                          creator_id

                          String

                          +

                          String

                          Time when an image is created. It is the UTC standard time.

                          +

                          Creator ID.

                          updated

                          +

                          creator_name

                          String

                          +

                          String

                          Time when an image is updated. It is the UTC standard time.

                          +

                          Name of the creator.

                          status

                          +

                          created

                          Boolean

                          +

                          String

                          Status.

                          +

                          Time when an image is created. It is the UTC standard time.

                          +

                          updated

                          +

                          String

                          +

                          Time when an image is updated. It is the UTC standard time.

                          +

                          status

                          +

                          Boolean

                          +

                          Status.

                          true: valid. false: expired.
                          +
                        • Example response
                          {
     "exist": true,
     "namespace": "group",
@@ -195,10 +229,12 @@
                      +

                      Error Codes

                      For details, see Error Codes.

                      +
                      -
                      Parent topic: API
                      +
                      Parent topic: Shared Account Management
                      diff --git a/docs/swr/api-ref/swr_02_0074.html b/docs/swr/api-ref/swr_02_0074.html index d5daf355..db1bd45a 100644 --- a/docs/swr/api-ref/swr_02_0074.html +++ b/docs/swr/api-ref/swr_02_0074.html @@ -22,7 +22,7 @@

                      String

                      Organization name

                      +

                      Organization name. An organization name contains 1 to 64 characters. It must start with a lowercase letter and end with a lowercase letter or digit. Only lowercase letters, digits, periods (.), underscores (_), and hyphens (-) are allowed. Periods, underscores, and hyphens cannot be placed next to each other. A maximum of two consecutive underscores are allowed.

                      repository

                      @@ -38,95 +38,148 @@
                    -

                    Request

                    • Request parameters

                      N/A

                      -
                    • Example request
                      GET https://{Endpoint}/v2/manage/namespaces/group/repositories/busybox/access-domains
                      -
                    -
                    -

                    Response

                    • Response parameters -
                      Table 2 Response body parameter description

                      Parameter

                      +

                      Request

                      • Request parameters +
                        - - + - - - + - - - + - +
                        Table 2 Request header parameters

                        Parameter

                        Type

                        +

                        Mandatory

                        Description

                        +

                        Type

                        +

                        Description

                        namespace

                        +

                        Content-Type

                        String

                        +

                        Yes

                        Organization name.

                        +

                        String

                        +

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

                        +

                        The default value is application/json.

                        repository

                        +

                        X-Auth-Token

                        String

                        +

                        Yes

                        Image repository name.

                        +

                        String

                        +

                        User token.

                        +

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

                        access_domain

                        +
                        +
                        +
                      • Example request
                        GET https://{Endpoint}/v2/manage/namespaces/group/repositories/busybox/access-domains
                        +
                      +
                      +

                      By default, 100 records will be returned.

                      +
                      +

                      Response

                      • Response parameters +
                        + + + + + - - - +
                        Table 3 Response body parameter description

                        Parameter

                        +

                        Type

                        +

                        Description

                        +

                        [Array element]

                        String

                        +

                        Array of objects

                        Name of the account used for image sharing.

                        +

                        Shared accounts.

                        permit

                        +
                        +
                        + +
                        + + + + + - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + @@ -150,40 +203,42 @@

                        Status Code

                        -
                        Table 4 [Array element] parameter description

                        Parameter

                        +

                        Type

                        +

                        Description

                        +

                        namespace

                        String

                        +

                        String

                        Permission.

                        +

                        Organization name.

                        deadline

                        +

                        repository

                        String

                        +

                        String

                        Expiration time.

                        +

                        Image repository name.

                        description

                        +

                        access_domain

                        String

                        +

                        String

                        Description.

                        +

                        Name of the account used for image sharing.

                        creator_id

                        +

                        permit

                        String

                        +

                        String

                        Creator ID.

                        +

                        Permission.

                        creator_name

                        +

                        deadline

                        String

                        +

                        String

                        Name of the creator.

                        +

                        Expiration time.

                        created

                        +

                        description

                        String

                        +

                        String

                        Time when an image is created. It is the UTC standard time.

                        +

                        Description.

                        updated

                        +

                        creator_id

                        String

                        +

                        String

                        Time when an image is updated. It is the UTC standard time.

                        +

                        Creator ID.

                        status

                        +

                        creator_name

                        Boolean

                        +

                        String

                        Status.

                        -

                        true: valid. false: expired.

                        +

                        Name of the creator.

                        +

                        created

                        +

                        String

                        +

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

                        +

                        updated

                        +

                        String

                        +

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

                        +

                        status

                        +

                        Boolean

                        +

                        Status. true: valid; false: expired

                        Status Code

                        +
                        - - - - - - - - -

                        Status Code

                        Description

                        +

                        Description

                        200

                        +

                        200

                        The list of image sharing account is queried successfully.

                        +

                        The list of image sharing accounts is returned successfully.

                        400

                        +

                        400

                        Request error. Error information is returned.

                        +

                        Request error. Error information is returned.

                        401

                        +

                        401

                        Authentication failed.

                        +

                        Authentication failed.

                        500

                        +

                        500

                        Internal error. Error information is returned.

                        +

                        Internal error. Error information is returned.
                        +

                        Error Codes

                        For details, see Error Codes.

                        +
                        -
                        Parent topic: API
                        +
                        Parent topic: Shared Account Management
                        diff --git a/docs/swr/api-ref/swr_02_0075.html b/docs/swr/api-ref/swr_02_0075.html index eb46a09c..10732252 100644 --- a/docs/swr/api-ref/swr_02_0075.html +++ b/docs/swr/api-ref/swr_02_0075.html @@ -3,53 +3,89 @@

                        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 Table 1.

                        +

                        URI

                        GET /v2/manage/shared-repositories

                        -
                        Table 1 Parameter description

                        Parameter

                        +
                        - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + @@ -57,182 +93,195 @@

                        Request

                        • Request parameters

                          N/A

                          -
                        • Example request
                          GET https://{Endpoint}/v2/manage/shared-repositories?filter=center::self|name::busybox
                          +
                        • Example request
                          GET https://{Endpoint}/v2/manage/shared-repositories?center=self&name=busybox

                        Response

                        • Response parameters -
                        Table 1 Query parameters

                        Parameter

                        Mandatory

                        +

                        Mandatory

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        center

                        +

                        namespace

                        Yes

                        +

                        No

                        String

                        +

                        String

                        • self: images shared by you.
                        • thirdparty: images shared with you by others.
                        +

                        Organization name. An organization name contains 1 to 64 characters. It must start with a lowercase letter and end with a lowercase letter or digit. Only lowercase letters, digits, periods (.), underscores (_), and hyphens (-) are allowed. Periods, underscores, and hyphens cannot be placed next to each other. A maximum of two consecutive underscores are allowed.

                        name

                        +

                        name

                        No

                        +

                        No

                        String

                        +

                        String

                        Image repository name.

                        +

                        Image repository name.

                        limit

                        +

                        center

                        No

                        +

                        No

                        String

                        +

                        String

                        Number of returned records. Ensure that the offset and limit parameters are used together.

                        +

                        self: images shared by you thirdparty: images shared with you by others.

                        offset

                        +

                        limit

                        No

                        +

                        No

                        String

                        +

                        String

                        Start index. Ensure that the offset and limit parameters are used together.

                        +

                        Number of returned records. Ensure that the offset and limit parameters are used together. If this parameter is not specified, all records will be returned by default.

                        +

                        offset

                        +

                        No

                        +

                        String

                        +

                        Start index. The value can be 0 or a positive integer multiple of the limit value. If this parameter is not specified, all records will be returned by default.

                        +

                        Parameters offset and limit should always be used together.

                        +

                        order_column

                        +

                        No

                        +

                        String

                        +

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

                        +

                        order_type

                        +

                        No

                        +

                        String

                        +

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

                        +

                        filter

                        +

                        No

                        +

                        String

                        +

                        Set this parameter to center::{center}|name::{name}|limit::{limit}|offset::{offset}|namespace::{namespace}|order_column::{order_column}|order_type::{order_type}. center can be set to self (images shared by you). thirdparty indicates images shared by others. namespace indicates the organization name. name indicates the image repository name. limit indicates the number of returned records. offset indicates the start index. order_column indicates sorting by column, which can be name, updated_time, or tag_count. order_type indicates the sorting type, which can be desc (descending order) or asc (ascending order).
                        Table 2 Response header parameter description

                        Parameter

                        +
                        - - + - - - + - -
                        Table 2 Request header parameters

                        Parameter

                        Type

                        +

                        Mandatory

                        Description

                        +

                        Type

                        +

                        Description

                        Content-Range

                        +

                        Content-Type

                        String

                        +

                        Yes

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

                        +

                        String

                        +

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

                        +

                        The default value is application/json.
                        -
                        -

                        If the offset and limit parameters are transferred in the request, Content-Range will be added to the response header.

                        -
                        - -
                        - - - - - - - +
                        Table 3 Response body parameter description

                        Parameter

                        -

                        Type

                        -

                        Description

                        -

                        [Array element]

                        +

                        X-Auth-Token

                        Array of objects

                        +

                        Yes

                        Viewing the list of shared images.

                        +

                        String

                        +

                        User token.

                        +

                        The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
                        -
                        Table 4 [Array element] parameters description

                        Parameter

                        +
                        - - - - - - +
                        Table 3 Response body parameter description

                        Parameter

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        name

                        +

                        [Array element]

                        String

                        +

                        Array of objects

                        Image repository name.

                        +

                        Viewing the list of shared images.

                        category

                        +
                        +
                        + +
                        + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + @@ -296,10 +345,12 @@
                        Table 4 [Array element] parameters description

                        Parameter

                        +

                        Type

                        +

                        Description

                        +

                        name

                        String

                        +

                        String

                        Image repository type. The value can be app_server, linux, framework_app, database, lang, other, windows, or arm.

                        +

                        Image repository name.

                        description

                        +

                        category

                        String

                        +

                        String

                        Image repository description.

                        +

                        Image repository type. The value can be app_server, linux, framework_app, database, lang, arm, or other.

                        size

                        +

                        description

                        Integer

                        +

                        String

                        Total size of the images in an image repository.

                        +

                        Image repository description.

                        is_public

                        +

                        size

                        Boolean

                        +

                        Integer

                        Whether the image is a public image. The value can be true or false.

                        +

                        Total size of the images in an image repository.

                        num_images

                        +

                        is_public

                        Integer

                        +

                        Boolean

                        Number of image tags in an image repository.

                        +

                        Whether the image is a public image. The value can be true or false.

                        num_download

                        +

                        num_images

                        Integer

                        +

                        Integer

                        Download times.

                        +

                        Number of image tags in an image repository.

                        created_at

                        +

                        num_download

                        String

                        +

                        Integer

                        Time when an image repository is created. It is the UTC standard time.

                        +

                        Download times.

                        updated_at

                        +

                        created_at

                        String

                        +

                        String

                        Time when an image repository is updated. It is the UTC standard time.

                        +

                        Time when an image repository is created. It is the UTC standard time.

                        logo

                        +

                        updated_at

                        String

                        +

                        String

                        (Reserved field) Image repository logo address.

                        +

                        Time when an image repository is updated. It is the UTC standard time.

                        url

                        +

                        logo

                        String

                        +

                        String

                        (Reserved field) URL of the image repository logo.

                        +

                        (Reserved field) Image repository logo address.

                        path

                        +

                        url

                        String

                        +

                        String

                        External Docker pull address. The format is {Repository address}/{Namespace name}/{Repository name}.

                        +

                        (Reserved field) URL of the image repository logo.

                        internal_path

                        +

                        path

                        String

                        +

                        String

                        Internal Docker pull address. The format is {Repository address}/{Namespace name}/{Repository name}.

                        +

                        External Docker pull address. The format is {Repository address}/{Namespace name}/{Repository name}.

                        domain_name

                        +

                        internal_path

                        String

                        +

                        String

                        Account name.

                        +

                        Internal Docker pull address. The format is {Repository address}/{Namespace name}/{Repository name}.

                        namespace

                        +

                        domain_name

                        String

                        +

                        String

                        Organization name.

                        +

                        Domain name.

                        tags

                        +

                        namespace

                        Array of strings

                        +

                        String

                        Image tag list.

                        +

                        Organization name.

                        status

                        +

                        tags

                        Boolean

                        +

                        Array of strings

                        • Query the images shared by a third party: Check whether the sharing is expired.
                        • Query the images shared by me: The default value is false, indicating that no images are shared.
                        +

                        Image tag list.

                        total_range

                        +

                        status

                        Integer

                        +

                        Boolean

                        Total number of records.

                        +
                        • Query the images shared by a third party: Check whether the sharing is expired.
                        • Query the images shared by me: The default value is false, indicating that no images are shared.
                        +

                        total_range

                        +

                        Integer

                        +

                        Total number of records.
                        +

                        Error Codes

                        For details, see Error Codes.

                        +
                        -
                        Parent topic: API
                        +
                        Parent topic: Image Repository Management
                        diff --git a/docs/swr/api-ref/swr_02_0080.html b/docs/swr/api-ref/swr_02_0080.html index 73c653fc..4edbd66f 100644 --- a/docs/swr/api-ref/swr_02_0080.html +++ b/docs/swr/api-ref/swr_02_0080.html @@ -5,108 +5,142 @@

                        URI

                        GET /

                        -

                        Request

                        N/A

                        -
                        -

                        Response

                        • Response parameters -
                          Table 1 Response body parameter description

                          Parameter

                          +

                          Request Parameters

                          +
                          - - + - - - + + + + + + + + +
                          Table 1 Request header parameters

                          Parameter

                          Type

                          +

                          Mandatory

                          Description

                          +

                          Type

                          +

                          Description

                          versions

                          +

                          Content-Type

                          Array of objects

                          +

                          Yes

                          A list of objects related to the version.

                          +

                          String

                          +

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

                          +

                          The default value is application/json.

                          +

                          X-Auth-Token

                          +

                          Yes

                          +

                          String

                          +

                          User token.

                          +

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

                          +
                          +
                          +
                          +

                          Response

                          • Response parameters
                            Status code: 200 +
                            + + + + + + +
                            Table 2 Response body parameter description

                            Parameter

                            +

                            Type

                            +

                            Description

                            +

                            versions

                            +

                            Array of objects

                            +

                            A list of objects related to the version.
                            -
                            Table 2 versions parameter description

                            Parameter

                            +
                            - - - - - - - - - - - - - - - - - - - -
                            Table 3 versions parameter description

                            Parameter

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            id

                            +

                            id

                            String

                            +

                            String

                            Version ID (version number), for example, v2.

                            +

                            Version ID (version number), for example, v2.

                            links

                            +

                            links

                            Object

                            +

                            Object

                            API URL.

                            +

                            API URL.

                            version

                            +

                            version

                            String

                            +

                            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.

                            +

                            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

                            +

                            status

                            String

                            +

                            String

                            Version status. The options are as follows:

                            +

                            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

                            +

                            updated

                            String

                            +

                            String

                            Version release time, which must be the UTC time. For example, the release time of v2 is 2014-06-28T12:20:21Z.

                            +

                            Version release time, which must be the UTC time. For example, the release time of v2 is 2014-06-28T12:20:21Z.

                            min_version

                            +

                            min_version

                            String

                            +

                            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.

                            +

                            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.
                            -
                            Table 3 links parameter description

                            Parameter

                            +
                            - - - - - - - -
                            Table 4 links parameter description

                            Parameter

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            href

                            +

                            href

                            String

                            +

                            String

                            Link

                            +

                            Link

                            rel

                            +

                            rel

                            String

                            +

                            String

                            Description

                            +

                            Description
                            +
                          • Example response
                            { 
    "versions": [
         {
@@ -146,10 +180,12 @@
                            • +

                            Error Codes

                            For details, see Error Codes.

                            +
                            -
                            Parent topic: API
                            +
                            Parent topic: API Versions
                            diff --git a/docs/swr/api-ref/swr_02_0081.html b/docs/swr/api-ref/swr_02_0081.html index 4683a9cf..750d8cb6 100644 --- a/docs/swr/api-ref/swr_02_0081.html +++ b/docs/swr/api-ref/swr_02_0081.html @@ -29,12 +29,45 @@
                            -

                            Request

                            • Request parameters

                              N/A

                              +

                              Request

                              • Request parameters +
                                + + + + + + + + + + + + + + + + +
                                Table 2 Request header parameters

                                Parameter

                                +

                                Mandatory

                                +

                                Type

                                +

                                Description

                                +

                                Content-Type

                                +

                                Yes

                                +

                                String

                                +

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

                                +

                                The default value is application/json.

                                +

                                X-Auth-Token

                                +

                                Yes

                                +

                                String

                                +

                                User token.

                                +

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

                                +
                                +
                              • Example request
                                GET https://{Endpoint}/v2

                              Response

                              • Response parameters -
                                Table 2 Response body parameter description

                                Parameter

                                +
                                @@ -53,7 +86,7 @@
                                Table 3 Response body parameter description

                                Parameter

                                Type

                                -
                                Table 3 version parameter description

                                Parameter

                                +
                                @@ -108,7 +141,7 @@
                                Table 4 version parameter description

                                Parameter

                                Type

                                -
                                Table 4 links parameter description

                                Parameter

                                +
                                @@ -170,10 +203,12 @@
                                Table 5 links parameter description

                                Parameter

                                Type

                                +

                                Error Codes

                                For details, see Error Codes.

                                +
                                -
                                Parent topic: API
                                +
                                Parent topic: API Versions