Files
doc-exports/docs/swr/api-ref/CLASS.TXT.json
qiujiandong1 73ffc816f4 SWR API 20250521 version
Reviewed-by: Eotvos, Oliver <oliver.eotvos@t-systems.com>
Co-authored-by: qiujiandong1 <qiujiandong1@huawei.com>
Co-committed-by: qiujiandong1 <qiujiandong1@huawei.com>
2025-10-29 10:18:41 +00:00

497 lines
19 KiB
JSON

[
{
"desc":"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 ",
"product_code":"swr",
"title":"API Usage Guidelines",
"uri":"swr_02_0078.html",
"doc_type":"api",
"p_code":"",
"code":"1"
},
{
"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":"APIs",
"uri":"swr_02_0011.html",
"doc_type":"api",
"p_code":"",
"code":"2"
},
{
"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 Management",
"uri":"swr_02_0025.html",
"doc_type":"api",
"p_code":"2",
"code":"3"
},
{
"desc":"Create an organization.NonePOST /v2/manage/namespacesNoneNoneFor details, see Error Codes.",
"product_code":"swr",
"title":"Creating an Organization",
"uri":"swr_02_0026.html",
"doc_type":"api",
"p_code":"3",
"code":"4"
},
{
"desc":"Query organizations.NoneGET /v2/manage/namespacesBy default, all organizations will be returned.Status code: 200Status code: 200The list of organizations has been obtaine",
"product_code":"swr",
"title":"Querying Organizations",
"uri":"swr_02_0028.html",
"doc_type":"api",
"p_code":"3",
"code":"5"
},
{
"desc":"Delete an organization.NoneDELETE /v2/manage/namespaces/{namespace}NoneNoneFor details, see Error Codes.",
"product_code":"swr",
"title":"Deleting an Organization",
"uri":"swr_02_0027.html",
"doc_type":"api",
"p_code":"3",
"code":"6"
},
{
"desc":"Query the details about an organization.NoneGET /v2/manage/namespaces/{namespace}Status code: 200Status code: 200Query succeeded.For details, see Error Codes.",
"product_code":"swr",
"title":"Querying Details About an Organization",
"uri":"swr_02_0029.html",
"doc_type":"api",
"p_code":"3",
"code":"7"
},
{
"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":"swr_02_0076.html",
"doc_type":"api",
"p_code":"2",
"code":"8"
},
{
"desc":"Create an image repository in an organization.NonePOST /v2/manage/namespaces/{namespace}/reposNoneNoneFor details, see Error Codes.",
"product_code":"swr",
"title":"Creating an Image Repository in an Organization",
"uri":"swr_02_0030.html",
"doc_type":"api",
"p_code":"8",
"code":"9"
},
{
"desc":"Delete an image repository in an organization.NoneDELETE /v2/manage/namespaces/{namespace}/repos/{repository}NoneNoneFor details, see Error Codes.",
"product_code":"swr",
"title":"Deleting an Image Repository from an Organization",
"uri":"swr_02_0031.html",
"doc_type":"api",
"p_code":"8",
"code":"10"
},
{
"desc":"Update the brief information on an image in an organization of a tenant, including the category, is_public, and description.NonePATCH /v2/manage/namespaces/{namespace}/re",
"product_code":"swr",
"title":"Updating the Brief Information on an Image Repository",
"uri":"swr_02_0032.html",
"doc_type":"api",
"p_code":"8",
"code":"11"
},
{
"desc":"Query the brief information on an image repository.NoneGET /v2/manage/namespaces/{namespace}/repos/{repository}Status code: 200Status code: 200Request succeeded.For detai",
"product_code":"swr",
"title":"Querying the Brief Information on an Image Repository",
"uri":"swr_02_0033.html",
"doc_type":"api",
"p_code":"8",
"code":"12"
},
{
"desc":"Query image repositories.NoneGET /v2/manage/reposStatus code: 200Status code: 200Request succeeded.For details, see Error Codes.",
"product_code":"swr",
"title":"Querying Image Repositories",
"uri":"swr_02_0034.html",
"doc_type":"api",
"p_code":"8",
"code":"13"
},
{
"desc":"Query shared images.NoneGET /v2/manage/shared-repositoriesStatus code: 200Status code: 200Request succeeded.For details, see Error Codes.",
"product_code":"swr",
"title":"Querying 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":"swr_02_0077.html",
"doc_type":"api",
"p_code":"2",
"code":"15"
},
{
"desc":"Query image tags.NoneGET /v2/manage/namespaces/{namespace}/repos/{repository}/tagsStatus code: 200Status code: 200The list of image tags is queried successfully.For detai",
"product_code":"swr",
"title":"Querying Image Tags",
"uri":"swr_02_0035.html",
"doc_type":"api",
"p_code":"15",
"code":"16"
},
{
"desc":"Delete an image with a specified tag.NoneDELETE /v2/manage/namespaces/{namespace}/repos/{repository}/tags/{tag}NoneNoneFor details, see Error Codes.",
"product_code":"swr",
"title":"Deleting an 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":"swr_02_0088.html",
"doc_type":"api",
"p_code":"2",
"code":"18"
},
{
"desc":"Share an image with an account. After pushing a private image, you can share it with other users and grant them permissions to pull the image.NonePOST /v2/manage/namespac",
"product_code":"swr",
"title":"Sharing an Image with an Account",
"uri":"swr_02_0070.html",
"doc_type":"api",
"p_code":"18",
"code":"19"
},
{
"desc":"Delete an account from the sharing list.NoneDELETE /v2/manage/namespaces/{namespace}/repositories/{repository}/access-domains/{access_domain}NoneNoneFor details, see Erro",
"product_code":"swr",
"title":"Deleting an Account from the Sharing List",
"uri":"swr_02_0071.html",
"doc_type":"api",
"p_code":"18",
"code":"20"
},
{
"desc":"Update an account an image is shared with.NonePATCH /v2/manage/namespaces/{namespace}/repositories/{repository}/access-domains/{access_domain}NoneNoneFor details, see Err",
"product_code":"swr",
"title":"Updating an Account An Image Is Shared With",
"uri":"swr_02_0072.html",
"doc_type":"api",
"p_code":"18",
"code":"21"
},
{
"desc":"Check whether an account exists for receiving a shared image.NoneGET /v2/manage/namespaces/{namespace}/repositories/{repository}/access-domains/{access_domain}Status code",
"product_code":"swr",
"title":"Checking Whether an Account Exists for Receiving a Shared Image",
"uri":"swr_02_0073.html",
"doc_type":"api",
"p_code":"18",
"code":"22"
},
{
"desc":"Query accounts an image is shared with.NoneGET /v2/manage/namespaces/{namespace}/repositories/{repository}/access-domainsBy default, 100 records will be returned.Status c",
"product_code":"swr",
"title":"Querying Accounts an Image Is Shared With",
"uri":"swr_02_0074.html",
"doc_type":"api",
"p_code":"18",
"code":"23"
},
{
"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":"API Versions",
"uri":"swr_02_0089.html",
"doc_type":"api",
"p_code":"2",
"code":"24"
},
{
"desc":"Query all API versions.NoneGET /Status code: 200Status code: 200Query succeeded.For details, see Error Codes.",
"product_code":"swr",
"title":"Querying All API Versions",
"uri":"swr_02_0080.html",
"doc_type":"api",
"p_code":"24",
"code":"25"
},
{
"desc":"Query a specified API version.NoneGET /{api_version}Status code: 200Status code: 200Query succeeded.For details, see Error Codes.",
"product_code":"swr",
"title":"Querying a Specified API Version",
"uri":"swr_02_0081.html",
"doc_type":"api",
"p_code":"24",
"code":"26"
},
{
"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":"swr_02_0090.html",
"doc_type":"api",
"p_code":"2",
"code":"27"
},
{
"desc":"Create organization permissions.NonePOST /v2/manage/namespaces/{namespace}/accessNoneNoneFor details, see Error Codes.",
"product_code":"swr",
"title":"Creating Organization Permissions",
"uri":"swr_02_0042.html",
"doc_type":"api",
"p_code":"27",
"code":"28"
},
{
"desc":"Cancel the organization operation permissions of certain users.NoneDELETE /v2/manage/namespaces/{namespace}/accessNoneNoneFor details, see Error Codes.",
"product_code":"swr",
"title":"Canceling Organization Permissions",
"uri":"swr_02_0043.html",
"doc_type":"api",
"p_code":"27",
"code":"29"
},
{
"desc":"Update the organization operation permissions of certain users.NonePATCH /v2/manage/namespaces/{namespace}/accessNoneNoneFor details, see Error Codes.",
"product_code":"swr",
"title":"Updating Organization Permissions",
"uri":"swr_02_0044.html",
"doc_type":"api",
"p_code":"27",
"code":"30"
},
{
"desc":"Query organization permissions.NoneGET /v2/manage/namespaces/{namespace}/accessStatus code: 200Status code: 200Query succeeded.For details, see Error Codes.",
"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":"swr_02_0091.html",
"doc_type":"api",
"p_code":"2",
"code":"32"
},
{
"desc":"Grant permissions of an image to certain users so that they can manage, edit, and read the image.You can grant permissions to other users (excluding yourself) only when t",
"product_code":"swr",
"title":"Granting Image Permissions",
"uri":"swr_02_0046.html",
"doc_type":"api",
"p_code":"32",
"code":"33"
},
{
"desc":"Cancel the image operation permissions of certain users.NoneDELETE /v2/manage/namespaces/{namespace}/repos/{repository}/accessNoneNoneFor details, see Error Codes.",
"product_code":"swr",
"title":"Canceling Image Permissions",
"uri":"swr_02_0047.html",
"doc_type":"api",
"p_code":"32",
"code":"34"
},
{
"desc":"Update image permissions.NonePATCH /v2/manage/namespaces/{namespace}/repos/{repository}/accessNoneNoneFor details, see Error Codes.",
"product_code":"swr",
"title":"Updating Image Permissions",
"uri":"swr_02_0048.html",
"doc_type":"api",
"p_code":"32",
"code":"35"
},
{
"desc":"Query image permissions.NoneGET /v2/manage/namespaces/{namespace}/repos/{repository}/accessStatus code: 200Status code: 200Query succeeded.For details, see Error Codes.",
"product_code":"swr",
"title":"Querying Image Permissions",
"uri":"swr_02_0049.html",
"doc_type":"api",
"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.",
"product_code":"swr",
"title":"Image Retention Policy Management",
"uri":"swr_02_0094.html",
"doc_type":"api",
"p_code":"2",
"code":"37"
},
{
"desc":"Create an image retention policy.NonePOST /v2/manage/namespaces/{namespace}/repos/{repository}/retentionsStatus code: 201Status code: 201Creation succeeded.For details, s",
"product_code":"swr",
"title":"Creating an Image Retention Policy",
"uri":"swr_02_0118.html",
"doc_type":"api",
"p_code":"37",
"code":"38"
},
{
"desc":"Query image retention policies.NoneGET /v2/manage/namespaces/{namespace}/repos/{repository}/retentionsBy default, 100 records will be returned.Status code: 200Status code",
"product_code":"swr",
"title":"Querying Image Retention Policies",
"uri":"swr_02_0053.html",
"doc_type":"api",
"p_code":"37",
"code":"39"
},
{
"desc":"Delete an image retention policy.NoneDELETE /v2/manage/namespaces/{namespace}/repos/{repository}/retentions/{retention_id}NoneNoneFor details, see Error Codes.",
"product_code":"swr",
"title":"Deleting an Image Retention Policy",
"uri":"swr_02_0054.html",
"doc_type":"api",
"p_code":"37",
"code":"40"
},
{
"desc":"Query details about an image retention policy.NoneGET /v2/manage/namespaces/{namespace}/repos/{repository}/retentions/{retention_id}Status code: 200Status code: 200Query ",
"product_code":"swr",
"title":"Querying Details About an Image Retention Policy",
"uri":"swr_02_0055.html",
"doc_type":"api",
"p_code":"37",
"code":"41"
},
{
"desc":"Modify an image retention policy.NonePATCH /v2/manage/namespaces/{namespace}/repos/{repository}/retentions/{retention_id}NoneNoneFor details, see Error Codes.",
"product_code":"swr",
"title":"Modifying an Image Retention Policy",
"uri":"swr_02_0056.html",
"doc_type":"api",
"p_code":"37",
"code":"42"
},
{
"desc":"Query image retention records.NoneGET /v2/manage/namespaces/{namespace}/repos/{repository}/retentions/historiesStatus code: 200Status code: 200Request succeeded.For detai",
"product_code":"swr",
"title":"Querying Image Retention Records",
"uri":"swr_02_0057.html",
"doc_type":"api",
"p_code":"37",
"code":"43"
},
{
"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":"Temporary Login Command",
"uri":"swr_02_0095.html",
"doc_type":"api",
"p_code":"2",
"code":"44"
},
{
"desc":"Generate a temporary login command using the value of X-Swr-Dockerlogin in the response header and the value of host in the response body.NonePOST /v2/manage/utils/secret",
"product_code":"swr",
"title":"Generating a Temporary Login Command",
"uri":"swr_02_0052.html",
"doc_type":"api",
"p_code":"44",
"code":"45"
},
{
"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":"Quota Management",
"uri":"swr_02_0096.html",
"doc_type":"api",
"p_code":"2",
"code":"46"
},
{
"desc":"Query quota information.NoneGET /v2/manage/projects/{project_id}/quotasStatus code: 200Status code: 200The quota information is returned successfully.",
"product_code":"swr",
"title":"Querying Quotas",
"uri":"swr_02_0037.html",
"doc_type":"api",
"p_code":"46",
"code":"47"
},
{
"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":"Other",
"uri":"swr_02_0119.html",
"doc_type":"api",
"p_code":"2",
"code":"48"
},
{
"desc":"Query the tenant resource overview.NoneGET /v2/manage/overviewStatus code: 200Status code: 200Query the tenant resource overview.For details, see Error Codes.",
"product_code":"swr",
"title":"Querying the Tenant Resource Overview",
"uri":"swr_02_0120.html",
"doc_type":"api",
"p_code":"48",
"code":"49"
},
{
"desc":"Query tenant resource statistics.NoneGET /v2/manage/reports/{resource_type}/{frequency}Status code: 200Status code: 200Query tenant resource statistics.For details, see E",
"product_code":"swr",
"title":"Querying Tenant Resource Statistics",
"uri":"swr_02_0121.html",
"doc_type":"api",
"p_code":"48",
"code":"50"
},
{
"desc":"Query service feature status.NoneGET /v2/manage/projects/{project_id}/feature-gatesStatus code: 200Status code: 200Query service feature status.For details, see Error Cod",
"product_code":"swr",
"title":"Querying Service Feature Status",
"uri":"swr_02_0122.html",
"doc_type":"api",
"p_code":"48",
"code":"51"
},
{
"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":"Appendixes",
"uri":"swr_02_0008.html",
"doc_type":"api",
"p_code":"",
"code":"52"
},
{
"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.",
"product_code":"swr",
"title":"Status Codes",
"uri":"swr_02_0023.html",
"doc_type":"api",
"p_code":"52",
"code":"53"
},
{
"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 Codes",
"uri":"ErrorCode.html",
"doc_type":"api",
"p_code":"52",
"code":"54"
},
{
"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":"Change History",
"uri":"swr_02_0064-1.html",
"doc_type":"api",
"p_code":"",
"code":"55"
}
]