diff --git a/docs/swr/api-ref/ALL_META.TXT.json b/docs/swr/api-ref/ALL_META.TXT.json index 2e2982ec0..3129c96b1 100644 --- a/docs/swr/api-ref/ALL_META.TXT.json +++ b/docs/swr/api-ref/ALL_META.TXT.json @@ -15,7 +15,8 @@ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], "title":"API Usage Guidelines", @@ -28,21 +29,22 @@ "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", + "kw":"APIs", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], - "title":"API", + "title":"APIs", "githuburl":"" }, { - "uri":"en-us_topic_0000001420846090.html", - "node_id":"en-us_topic_0000001420846090.xml", + "uri":"swr_02_0025.html", + "node_id":"swr_02_0025.xml", "product_code":"swr", "code":"3", "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.", @@ -53,7 +55,8 @@ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], "title":"Organization Management", @@ -64,7 +67,7 @@ "node_id":"swr_02_0026.xml", "product_code":"swr", "code":"4", - "des":"Create an organization.POST /v2/manage/namespacesN/AN/A", + "des":"Create an organization.NonePOST /v2/manage/namespacesNoneNoneFor details, see Error Codes.", "doc_type":"api", "kw":"Creating an Organization,Organization Management,API Reference", "search_title":"", @@ -72,18 +75,39 @@ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], "title":"Creating an Organization", "githuburl":"" }, + { + "uri":"swr_02_0028.html", + "node_id":"swr_02_0028.xml", + "product_code":"swr", + "code":"5", + "des":"Query organizations.NoneGET /v2/manage/namespacesBy default, all organizations will be returned.Status code: 200Status code: 200The list of organizations has been obtaine", + "doc_type":"api", + "kw":"Querying Organizations,Organization Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" + } + ], + "title":"Querying Organizations", + "githuburl":"" + }, { "uri":"swr_02_0027.html", "node_id":"swr_02_0027.xml", "product_code":"swr", - "code":"5", - "des":"Delete an organization.DELETE /v2/manage/namespaces/{namespace}For details about parameters, see Table 1.N/A", + "code":"6", + "des":"Delete an organization.NoneDELETE /v2/manage/namespaces/{namespace}NoneNoneFor details, see Error Codes.", "doc_type":"api", "kw":"Deleting an Organization,Organization Management,API Reference", "search_title":"", @@ -91,53 +115,36 @@ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], "title":"Deleting an Organization", "githuburl":"" }, - { - "uri":"swr_02_0028.html", - "node_id":"swr_02_0028.xml", - "product_code":"swr", - "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,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":"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", + "des":"Query the details about an organization.NoneGET /v2/manage/namespaces/{namespace}Status code: 200Status code: 200Query succeeded.For details, see Error Codes.", "doc_type":"api", - "kw":"Querying the Details of an Organization,Organization Management,API Reference", + "kw":"Querying Details About an Organization,Organization Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], - "title":"Querying the Details of an Organization", + "title":"Querying Details About an Organization", "githuburl":"" }, { - "uri":"en-us_topic_0000001420528490.html", - "node_id":"en-us_topic_0000001420528490.xml", + "uri":"swr_02_0076.html", + "node_id":"swr_02_0076.xml", "product_code":"swr", "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.", @@ -148,7 +155,8 @@ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], "title":"Image Repository Management", @@ -159,18 +167,19 @@ "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.", + "des":"Create an image repository in an organization.NonePOST /v2/manage/namespaces/{namespace}/reposNoneNoneFor details, see Error Codes.", "doc_type":"api", - "kw":"Creating an Image Repository,Image Repository Management,API Reference", + "kw":"Creating an Image Repository in an Organization,Image Repository Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], - "title":"Creating an Image Repository", + "title":"Creating an Image Repository in an Organization", "githuburl":"" }, { @@ -178,18 +187,19 @@ "node_id":"swr_02_0031.xml", "product_code":"swr", "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", + "des":"Delete an image repository in an organization.NoneDELETE /v2/manage/namespaces/{namespace}/repos/{repository}NoneNoneFor details, see Error Codes.", "doc_type":"api", - "kw":"Deleting an Image Repository,Image Repository Management,API Reference", + "kw":"Deleting an Image Repository from an Organization,Image Repository Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], - "title":"Deleting an Image Repository", + "title":"Deleting an Image Repository from an Organization", "githuburl":"" }, { @@ -197,7 +207,7 @@ "node_id":"swr_02_0032.xml", "product_code":"swr", "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/{", + "des":"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", "doc_type":"api", "kw":"Updating the Brief Information on an Image Repository,Image Repository Management,API Reference", "search_title":"", @@ -205,7 +215,8 @@ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], "title":"Updating the Brief Information on an Image Repository", @@ -216,7 +227,7 @@ "node_id":"swr_02_0033.xml", "product_code":"swr", "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", + "des":"Query the brief information on an image repository.NoneGET /v2/manage/namespaces/{namespace}/repos/{repository}Status code: 200Status code: 200Request succeeded.For detai", "doc_type":"api", "kw":"Querying the Brief Information on an Image Repository,Image Repository Management,API Reference", "search_title":"", @@ -224,7 +235,8 @@ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], "title":"Querying the Brief Information on an Image Repository", @@ -235,18 +247,19 @@ "node_id":"swr_02_0034.xml", "product_code":"swr", "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", + "des":"Query image repositories.NoneGET /v2/manage/reposStatus code: 200Status code: 200Request succeeded.For details, see Error Codes.", "doc_type":"api", - "kw":"Querying the Image Repository List,Image Repository Management,API Reference", + "kw":"Querying Image Repositories,Image Repository Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], - "title":"Querying the Image Repository List", + "title":"Querying Image Repositories", "githuburl":"" }, { @@ -254,23 +267,24 @@ "node_id":"swr_02_0075.xml", "product_code":"swr", "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", + "des":"Query shared images.NoneGET /v2/manage/shared-repositoriesStatus code: 200Status code: 200Request succeeded.For details, see Error Codes.", "doc_type":"api", - "kw":"Viewing the List of Shared Images,Image Repository Management,API Reference", + "kw":"Querying Shared Images,Image Repository Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], - "title":"Viewing the List of Shared Images", + "title":"Querying Shared Images", "githuburl":"" }, { - "uri":"en-us_topic_0000001420688458.html", - "node_id":"en-us_topic_0000001420688458.xml", + "uri":"swr_02_0077.html", + "node_id":"swr_02_0077.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.", @@ -281,7 +295,8 @@ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], "title":"Image Tag Management", @@ -292,18 +307,19 @@ "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_", + "des":"Query image tags.NoneGET /v2/manage/namespaces/{namespace}/repos/{repository}/tagsStatus code: 200Status code: 200The list of image tags is queried successfully.For detai", "doc_type":"api", - "kw":"Querying the List of Image Repository Tags,Image Tag Management,API Reference", + "kw":"Querying Image Tags,Image Tag Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], - "title":"Querying the List of Image Repository Tags", + "title":"Querying Image Tags", "githuburl":"" }, { @@ -311,23 +327,24 @@ "node_id":"swr_02_0036.xml", "product_code":"swr", "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", + "des":"Delete an image with a specified tag.NoneDELETE /v2/manage/namespaces/{namespace}/repos/{repository}/tags/{tag}NoneNoneFor details, see Error Codes.", "doc_type":"api", - "kw":"Deleting the Image with a Specified Tag,Image Tag Management,API Reference", + "kw":"Deleting an Image with a Specified Tag,Image Tag Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], - "title":"Deleting the Image with a Specified Tag", + "title":"Deleting an Image with a Specified Tag", "githuburl":"" }, { - "uri":"en-us_topic_0000001470804877.html", - "node_id":"en-us_topic_0000001470804877.xml", + "uri":"swr_02_0088.html", + "node_id":"swr_02_0088.xml", "product_code":"swr", "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.", @@ -338,7 +355,8 @@ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], "title":"Shared Account Management", @@ -349,18 +367,19 @@ "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", + "des":"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", "doc_type":"api", - "kw":"private images,Creating an Account Used for Image Sharing,Shared Account Management,API Reference", + "kw":"Sharing an Image with an Account,Shared Account Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], - "title":"Creating an Account Used for Image Sharing", + "title":"Sharing an Image with an Account", "githuburl":"" }, { @@ -368,18 +387,19 @@ "node_id":"swr_02_0071.xml", "product_code":"swr", "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", + "des":"Delete an account from the sharing list.NoneDELETE /v2/manage/namespaces/{namespace}/repositories/{repository}/access-domains/{access_domain}NoneNoneFor details, see Erro", "doc_type":"api", - "kw":"Deleting an Account Used for Image Sharing,Shared Account Management,API Reference", + "kw":"Deleting an Account from the Sharing List,Shared Account Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], - "title":"Deleting an Account Used for Image Sharing", + "title":"Deleting an Account from the Sharing List", "githuburl":"" }, { @@ -387,18 +407,19 @@ "node_id":"swr_02_0072.xml", "product_code":"swr", "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", + "des":"Update an account an image is shared with.NonePATCH /v2/manage/namespaces/{namespace}/repositories/{repository}/access-domains/{access_domain}NoneNoneFor details, see Err", "doc_type":"api", - "kw":"Updating an Account Used for Image Sharing,Shared Account Management,API Reference", + "kw":"Updating an Account An Image Is Shared With,Shared Account Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], - "title":"Updating an Account Used for Image Sharing", + "title":"Updating an Account An Image Is Shared With", "githuburl":"" }, { @@ -406,18 +427,19 @@ "node_id":"swr_02_0073.xml", "product_code":"swr", "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", + "des":"Check whether an account exists for receiving a shared image.NoneGET /v2/manage/namespaces/{namespace}/repositories/{repository}/access-domains/{access_domain}Status code", "doc_type":"api", - "kw":"Checking the Existence of an Account Used for Image Sharing,Shared Account Management,API Reference", + "kw":"Checking Whether an Account Exists for Receiving a Shared Image,Shared Account Management,API Refere", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], - "title":"Checking the Existence of an Account Used for Image Sharing", + "title":"Checking Whether an Account Exists for Receiving a Shared Image", "githuburl":"" }, { @@ -425,23 +447,24 @@ "node_id":"swr_02_0074.xml", "product_code":"swr", "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", + "des":"Query accounts an image is shared with.NoneGET /v2/manage/namespaces/{namespace}/repositories/{repository}/access-domainsBy default, 100 records will be returned.Status c", "doc_type":"api", - "kw":"Obtaining the List of Accounts Used for Image Sharing,Shared Account Management,API Reference", + "kw":"Querying Accounts an Image Is Shared With,Shared Account Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], - "title":"Obtaining the List of Accounts Used for Image Sharing", + "title":"Querying Accounts an Image Is Shared With", "githuburl":"" }, { - "uri":"en-us_topic_0000001471005441.html", - "node_id":"en-us_topic_0000001471005441.xml", + "uri":"swr_02_0089.html", + "node_id":"swr_02_0089.xml", "product_code":"swr", "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.", @@ -452,7 +475,8 @@ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], "title":"API Versions", @@ -463,7 +487,7 @@ "node_id":"swr_02_0080.xml", "product_code":"swr", "code":"25", - "des":"Query all available API versions of SWR.GET /Response parametersStatus code: 200Response body parameter descriptionParameterTypeDescriptionversionsArray of objectsA list ", + "des":"Query all API versions.NoneGET /Status code: 200Status code: 200Query succeeded.For details, see Error Codes.", "doc_type":"api", "kw":"Querying All API Versions,API Versions,API Reference", "search_title":"", @@ -471,7 +495,8 @@ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], "title":"Querying All API Versions", @@ -482,23 +507,24 @@ "node_id":"swr_02_0081.xml", "product_code":"swr", "code":"26", - "des":"Query a specific API version of SWR.GET /{api_version}For details about parameters, see Table 1.Request parametersRequest header parametersParameterMandatoryTypeDescripti", + "des":"Query a specified API version.NoneGET /{api_version}Status code: 200Status code: 200Query succeeded.For details, see Error Codes.", "doc_type":"api", - "kw":"Querying a Specific API Version,API Versions,API Reference", + "kw":"Querying a Specified API Version,API Versions,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], - "title":"Querying a Specific API Version", + "title":"Querying a Specified API Version", "githuburl":"" }, { - "uri":"en-us_topic_0000001421005366.html", - "node_id":"en-us_topic_0000001421005366.xml", + "uri":"swr_02_0090.html", + "node_id":"swr_02_0090.xml", "product_code":"swr", "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.", @@ -509,7 +535,8 @@ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], "title":"Organization Permission Management", @@ -520,7 +547,7 @@ "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", + "des":"Create organization permissions.NonePOST /v2/manage/namespaces/{namespace}/accessNoneNoneFor details, see Error Codes.", "doc_type":"api", "kw":"Creating Organization Permissions,Organization Permission Management,API Reference", "search_title":"", @@ -528,7 +555,8 @@ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], "title":"Creating Organization Permissions", @@ -539,18 +567,19 @@ "node_id":"swr_02_0043.xml", "product_code":"swr", "code":"29", - "des":"Delete the organization operation permissions of certain users.DELETE /v2/manage/namespaces/{namespace}/accessTable 1 describes the parameters.Request parametersRequest h", + "des":"Cancel the organization operation permissions of certain users.NoneDELETE /v2/manage/namespaces/{namespace}/accessNoneNoneFor details, see Error Codes.", "doc_type":"api", - "kw":"Deleting Organization Permissions,Organization Permission Management,API Reference", + "kw":"Canceling Organization Permissions,Organization Permission Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], - "title":"Deleting Organization Permissions", + "title":"Canceling Organization Permissions", "githuburl":"" }, { @@ -558,7 +587,7 @@ "node_id":"swr_02_0044.xml", "product_code":"swr", "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", + "des":"Update the organization operation permissions of certain users.NonePATCH /v2/manage/namespaces/{namespace}/accessNoneNoneFor details, see Error Codes.", "doc_type":"api", "kw":"Updating Organization Permissions,Organization Permission Management,API Reference", "search_title":"", @@ -566,7 +595,8 @@ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], "title":"Updating Organization Permissions", @@ -577,7 +607,7 @@ "node_id":"swr_02_0045.xml", "product_code":"swr", "code":"31", - "des":"Query organization permissions.GET /v2/manage/namespaces/{namespace}/accessFor details about parameters, see Table 1.Request parametersRequest header parametersParameterM", + "des":"Query organization permissions.NoneGET /v2/manage/namespaces/{namespace}/accessStatus code: 200Status code: 200Query succeeded.For details, see Error Codes.", "doc_type":"api", "kw":"Querying Organization Permissions,Organization Permission Management,API Reference", "search_title":"", @@ -585,15 +615,16 @@ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], "title":"Querying Organization Permissions", "githuburl":"" }, { - "uri":"en-us_topic_0000001470924909.html", - "node_id":"en-us_topic_0000001470924909.xml", + "uri":"swr_02_0091.html", + "node_id":"swr_02_0091.xml", "product_code":"swr", "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.", @@ -604,7 +635,8 @@ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], "title":"Image Permission Management", @@ -615,18 +647,19 @@ "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", + "des":"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", "doc_type":"api", - "kw":"Creating Image Permissions,Image Permission Management,API Reference", + "kw":"Granting Image Permissions,Image Permission Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], - "title":"Creating Image Permissions", + "title":"Granting Image Permissions", "githuburl":"" }, { @@ -634,18 +667,19 @@ "node_id":"swr_02_0047.xml", "product_code":"swr", "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", + "des":"Cancel the image operation permissions of certain users.NoneDELETE /v2/manage/namespaces/{namespace}/repos/{repository}/accessNoneNoneFor details, see Error Codes.", "doc_type":"api", - "kw":"Deleting Image Permissions,Image Permission Management,API Reference", + "kw":"Canceling Image Permissions,Image Permission Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], - "title":"Deleting Image Permissions", + "title":"Canceling Image Permissions", "githuburl":"" }, { @@ -653,7 +687,7 @@ "node_id":"swr_02_0048.xml", "product_code":"swr", "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", + "des":"Update image permissions.NonePATCH /v2/manage/namespaces/{namespace}/repos/{repository}/accessNoneNoneFor details, see Error Codes.", "doc_type":"api", "kw":"Updating Image Permissions,Image Permission Management,API Reference", "search_title":"", @@ -661,7 +695,8 @@ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], "title":"Updating Image Permissions", @@ -672,7 +707,7 @@ "node_id":"swr_02_0049.xml", "product_code":"swr", "code":"36", - "des":"Query image permissions.NoneGET /v2/manage/namespaces/{namespace}/repos/{repository}/accessFor details about parameters, see Table 1.Request parametersRequest header para", + "des":"Query image permissions.NoneGET /v2/manage/namespaces/{namespace}/repos/{repository}/accessStatus code: 200Status code: 200Query succeeded.For details, see Error Codes.", "doc_type":"api", "kw":"Querying Image Permissions,Image Permission Management,API Reference", "search_title":"", @@ -680,17 +715,318 @@ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], "title":"Querying Image Permissions", "githuburl":"" }, + { + "uri":"swr_02_0094.html", + "node_id":"swr_02_0094.xml", + "product_code":"swr", + "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":"Image Retention Policy Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" + } + ], + "title":"Image Retention Policy Management", + "githuburl":"" + }, + { + "uri":"swr_02_0118.html", + "node_id":"swr_02_0118.xml", + "product_code":"swr", + "code":"38", + "des":"Create an image retention policy.NonePOST /v2/manage/namespaces/{namespace}/repos/{repository}/retentionsStatus code: 201Status code: 201Creation succeeded.For details, s", + "doc_type":"api", + "kw":"Creating an Image Retention Policy,Image Retention Policy Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" + } + ], + "title":"Creating an Image Retention Policy", + "githuburl":"" + }, + { + "uri":"swr_02_0053.html", + "node_id":"swr_02_0053.xml", + "product_code":"swr", + "code":"39", + "des":"Query image retention policies.NoneGET /v2/manage/namespaces/{namespace}/repos/{repository}/retentionsBy default, 100 records will be returned.Status code: 200Status code", + "doc_type":"api", + "kw":"Querying Image Retention Policies,Image Retention Policy Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" + } + ], + "title":"Querying Image Retention Policies", + "githuburl":"" + }, + { + "uri":"swr_02_0054.html", + "node_id":"swr_02_0054.xml", + "product_code":"swr", + "code":"40", + "des":"Delete an image retention policy.NoneDELETE /v2/manage/namespaces/{namespace}/repos/{repository}/retentions/{retention_id}NoneNoneFor details, see Error Codes.", + "doc_type":"api", + "kw":"Deleting an Image Retention Policy,Image Retention Policy Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" + } + ], + "title":"Deleting an Image Retention Policy", + "githuburl":"" + }, + { + "uri":"swr_02_0055.html", + "node_id":"swr_02_0055.xml", + "product_code":"swr", + "code":"41", + "des":"Query details about an image retention policy.NoneGET /v2/manage/namespaces/{namespace}/repos/{repository}/retentions/{retention_id}Status code: 200Status code: 200Query ", + "doc_type":"api", + "kw":"Querying Details About an Image Retention Policy,Image Retention Policy Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" + } + ], + "title":"Querying Details About an Image Retention Policy", + "githuburl":"" + }, + { + "uri":"swr_02_0056.html", + "node_id":"swr_02_0056.xml", + "product_code":"swr", + "code":"42", + "des":"Modify an image retention policy.NonePATCH /v2/manage/namespaces/{namespace}/repos/{repository}/retentions/{retention_id}NoneNoneFor details, see Error Codes.", + "doc_type":"api", + "kw":"Modifying an Image Retention Policy,Image Retention Policy Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" + } + ], + "title":"Modifying an Image Retention Policy", + "githuburl":"" + }, + { + "uri":"swr_02_0057.html", + "node_id":"swr_02_0057.xml", + "product_code":"swr", + "code":"43", + "des":"Query image retention records.NoneGET /v2/manage/namespaces/{namespace}/repos/{repository}/retentions/historiesStatus code: 200Status code: 200Request succeeded.For detai", + "doc_type":"api", + "kw":"Querying Image Retention Records,Image Retention Policy Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" + } + ], + "title":"Querying Image Retention Records", + "githuburl":"" + }, + { + "uri":"swr_02_0095.html", + "node_id":"swr_02_0095.xml", + "product_code":"swr", + "code":"44", + "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":"Temporary Login Command", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" + } + ], + "title":"Temporary Login Command", + "githuburl":"" + }, + { + "uri":"swr_02_0052.html", + "node_id":"swr_02_0052.xml", + "product_code":"swr", + "code":"45", + "des":"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", + "doc_type":"api", + "kw":"Generating a Temporary Login Command,Temporary Login Command,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" + } + ], + "title":"Generating a Temporary Login Command", + "githuburl":"" + }, + { + "uri":"swr_02_0096.html", + "node_id":"swr_02_0096.xml", + "product_code":"swr", + "code":"46", + "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":"Quota Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" + } + ], + "title":"Quota Management", + "githuburl":"" + }, + { + "uri":"swr_02_0037.html", + "node_id":"swr_02_0037.xml", + "product_code":"swr", + "code":"47", + "des":"Query quota information.NoneGET /v2/manage/projects/{project_id}/quotasStatus code: 200Status code: 200The quota information is returned successfully.", + "doc_type":"api", + "kw":"Querying Quotas,Quota Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" + } + ], + "title":"Querying Quotas", + "githuburl":"" + }, + { + "uri":"swr_02_0119.html", + "node_id":"swr_02_0119.xml", + "product_code":"swr", + "code":"48", + "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":"Other", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" + } + ], + "title":"Other", + "githuburl":"" + }, + { + "uri":"swr_02_0120.html", + "node_id":"swr_02_0120.xml", + "product_code":"swr", + "code":"49", + "des":"Query the tenant resource overview.NoneGET /v2/manage/overviewStatus code: 200Status code: 200Query the tenant resource overview.For details, see Error Codes.", + "doc_type":"api", + "kw":"Querying the Tenant Resource Overview,Other,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" + } + ], + "title":"Querying the Tenant Resource Overview", + "githuburl":"" + }, + { + "uri":"swr_02_0121.html", + "node_id":"swr_02_0121.xml", + "product_code":"swr", + "code":"50", + "des":"Query tenant resource statistics.NoneGET /v2/manage/reports/{resource_type}/{frequency}Status code: 200Status code: 200Query tenant resource statistics.For details, see E", + "doc_type":"api", + "kw":"Querying Tenant Resource Statistics,Other,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" + } + ], + "title":"Querying Tenant Resource Statistics", + "githuburl":"" + }, + { + "uri":"swr_02_0122.html", + "node_id":"swr_02_0122.xml", + "product_code":"swr", + "code":"51", + "des":"Query service feature status.NoneGET /v2/manage/projects/{project_id}/feature-gatesStatus code: 200Status code: 200Query service feature status.For details, see Error Cod", + "doc_type":"api", + "kw":"Querying Service Feature Status,Other,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"swr", + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" + } + ], + "title":"Querying Service Feature Status", + "githuburl":"" + }, { "uri":"swr_02_0008.html", "node_id":"swr_02_0008.xml", "product_code":"swr", - "code":"37", + "code":"52", "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", @@ -699,7 +1035,8 @@ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], "title":"Appendixes", @@ -709,7 +1046,7 @@ "uri":"swr_02_0023.html", "node_id":"swr_02_0023.xml", "product_code":"swr", - "code":"38", + "code":"53", "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", @@ -718,17 +1055,18 @@ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], "title":"Status Codes", "githuburl":"" }, { - "uri":"swr_02_0024.html", - "node_id":"swr_02_0024.xml", + "uri":"ErrorCode.html", + "node_id":"errorcode.xml", "product_code":"swr", - "code":"39", + "code":"54", "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 Codes,Appendixes,API Reference", @@ -737,17 +1075,18 @@ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], "title":"Error Codes", "githuburl":"" }, { - "uri":"swr_02_0064.html", - "node_id":"swr_02_0064.xml", + "uri":"swr_02_0064-1.html", + "node_id":"swr_02_0064-1.xml", "product_code":"swr", - "code":"40", + "code":"55", "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", @@ -756,7 +1095,8 @@ { "documenttype":"api", "prodname":"swr", - "opensource":"true" + "opensource":"true", + "operation_id":"CreateNamespace;ListNamespaces;DeleteNamespaces;ShowNamespace;CreateRepo;DeleteRepo;UpdateRepo;ShowRepository;ListReposDetails;ListSharedReposDetails;ListRepositoryTags;DeleteRepoTag;CreateRepoDomains;DeleteRepoDomains;UpdateRepoDomains;ShowAccessDomain;ListRepoDomains;ListApiVersions;ShowApiVersion;CreateNamespaceAuth;DeleteNamespaceAuth;UpdateNamespaceAuth;ShowNamespaceAuth;CreateUserRepositoryAuth;DeleteUserRepositoryAuth;UpdateUserRepositoryAuth;ShowUserRepositoryAuth;ShowSyncJob;ListImageAutoSyncReposDetails;CreateImageSyncRepo;DeleteImageSyncRepo;CreateManualImageSyncRepo;CreateTrigger;ListTriggersDetails;DeleteTrigger;ShowTrigger;UpdateTrigger;CreateRetention;ListRetentions;DeleteRetention;ShowRetention;UpdateRetention;ListRetentionHistories;CreateSecret;CreateRepoTag;ListQuotas;CreateRepoShare;ListRepoShares;DeleteRepoShare;UpdateRepoShare;ShowRepoShare;CreateAgency;GetAgency" } ], "title":"Change History", diff --git a/docs/swr/api-ref/CLASS.TXT.json b/docs/swr/api-ref/CLASS.TXT.json index 108153081..020a094f7 100644 --- a/docs/swr/api-ref/CLASS.TXT.json +++ b/docs/swr/api-ref/CLASS.TXT.json @@ -11,7 +11,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":"API", + "title":"APIs", "uri":"swr_02_0011.html", "doc_type":"api", "p_code":"", @@ -21,13 +21,13 @@ "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":"en-us_topic_0000001420846090.html", + "uri":"swr_02_0025.html", "doc_type":"api", "p_code":"2", "code":"3" }, { - "desc":"Create an organization.POST /v2/manage/namespacesN/AN/A", + "desc":"Create an organization.NonePOST /v2/manage/namespacesNoneNoneFor details, see Error Codes.", "product_code":"swr", "title":"Creating an Organization", "uri":"swr_02_0026.html", @@ -36,27 +36,27 @@ "code":"4" }, { - "desc":"Delete an organization.DELETE /v2/manage/namespaces/{namespace}For details about parameters, see Table 1.N/A", + "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":"Deleting an Organization", - "uri":"swr_02_0027.html", + "title":"Querying Organizations", + "uri":"swr_02_0028.html", "doc_type":"api", "p_code":"3", "code":"5" }, { - "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", + "desc":"Delete an organization.NoneDELETE /v2/manage/namespaces/{namespace}NoneNoneFor details, see Error Codes.", "product_code":"swr", - "title":"Querying the List of Organizations", - "uri":"swr_02_0028.html", + "title":"Deleting an Organization", + "uri":"swr_02_0027.html", "doc_type":"api", "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.Status code: 200Response body parameter de", + "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 the Details of an Organization", + "title":"Querying Details About an Organization", "uri":"swr_02_0029.html", "doc_type":"api", "p_code":"3", @@ -66,31 +66,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 Repository Management", - "uri":"en-us_topic_0000001420528490.html", + "uri":"swr_02_0076.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.", + "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", + "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.DELETE /v2/manage/namespaces/{namespace}/repos/{repository}For details about parameters, see Table 1.NoneNoneFor details, se", + "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", + "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 repository in an organization, including the category, is_public, and description.PATCH /v2/manage/namespaces/{namespace}/repos/{", + "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", @@ -99,7 +99,7 @@ "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", + "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", @@ -108,18 +108,18 @@ "code":"12" }, { - "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", + "desc":"Query image repositories.NoneGET /v2/manage/reposStatus code: 200Status code: 200Request succeeded.For details, see Error Codes.", "product_code":"swr", - "title":"Querying the Image Repository List", + "title":"Querying Image Repositories", "uri":"swr_02_0034.html", "doc_type":"api", "p_code":"8", "code":"13" }, { - "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", + "desc":"Query shared images.NoneGET /v2/manage/shared-repositoriesStatus code: 200Status code: 200Request succeeded.For details, see Error Codes.", "product_code":"swr", - "title":"Viewing the List of Shared Images", + "title":"Querying Shared Images", "uri":"swr_02_0075.html", "doc_type":"api", "p_code":"8", @@ -129,24 +129,24 @@ "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", + "uri":"swr_02_0077.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_", + "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 the List of Image Repository Tags", + "title":"Querying Image Tags", "uri":"swr_02_0035.html", "doc_type":"api", "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", + "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 the Image with a Specified Tag", + "title":"Deleting an Image with a Specified Tag", "uri":"swr_02_0036.html", "doc_type":"api", "p_code":"15", @@ -156,51 +156,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":"Shared Account Management", - "uri":"en-us_topic_0000001470804877.html", + "uri":"swr_02_0088.html", "doc_type":"api", "p_code":"2", "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", + "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":"Creating an Account Used for Image Sharing", + "title":"Sharing an Image with an Account", "uri":"swr_02_0070.html", "doc_type":"api", "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", + "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 Used for Image Sharing", + "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 used for image sharing.PATCH /v2/manage/namespaces/{namespace}/repositories/{repository}/access-domains/{access_domain}For details about parameters, see", + "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 Used for Image Sharing", + "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 used for image sharing exists.GET /v2/manage/namespaces/{namespace}/repositories/{repository}/access-domains/{access_domain}For details about par", + "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 the Existence of an Account Used for Image Sharing", + "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":"Obtain the list of accounts used for image sharing.GET /v2/manage/namespaces/{namespace}/repositories/{repository}/access-domainsFor details about parameters, see Table 1", + "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":"Obtaining the List of Accounts Used for Image Sharing", + "title":"Querying Accounts an Image Is Shared With", "uri":"swr_02_0074.html", "doc_type":"api", "p_code":"18", @@ -210,13 +210,13 @@ "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":"en-us_topic_0000001471005441.html", + "uri":"swr_02_0089.html", "doc_type":"api", "p_code":"2", "code":"24" }, { - "desc":"Query all available API versions of SWR.GET /Response parametersStatus code: 200Response body parameter descriptionParameterTypeDescriptionversionsArray of objectsA list ", + "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", @@ -225,9 +225,9 @@ "code":"25" }, { - "desc":"Query a specific API version of SWR.GET /{api_version}For details about parameters, see Table 1.Request parametersRequest header parametersParameterMandatoryTypeDescripti", + "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 Specific API Version", + "title":"Querying a Specified API Version", "uri":"swr_02_0081.html", "doc_type":"api", "p_code":"24", @@ -237,13 +237,13 @@ "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", + "uri":"swr_02_0090.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", + "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", @@ -252,16 +252,16 @@ "code":"28" }, { - "desc":"Delete the organization operation permissions of certain users.DELETE /v2/manage/namespaces/{namespace}/accessTable 1 describes the parameters.Request parametersRequest h", + "desc":"Cancel the organization operation permissions of certain users.NoneDELETE /v2/manage/namespaces/{namespace}/accessNoneNoneFor details, see Error Codes.", "product_code":"swr", - "title":"Deleting Organization Permissions", + "title":"Canceling Organization Permissions", "uri":"swr_02_0043.html", "doc_type":"api", "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", + "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", @@ -270,7 +270,7 @@ "code":"30" }, { - "desc":"Query organization permissions.GET /v2/manage/namespaces/{namespace}/accessFor details about parameters, see Table 1.Request parametersRequest header parametersParameterM", + "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", @@ -282,31 +282,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", + "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.POST /v2/manage/namespaces/{namespace}/repos/{repository}/accessFor detai", + "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":"Creating Image Permissions", + "title":"Granting Image Permissions", "uri":"swr_02_0046.html", "doc_type":"api", "p_code":"32", "code":"33" }, { - "desc":"Delete the image operation permissions of certain users.NoneDELETE /v2/manage/namespaces/{namespace}/repos/{repository}/accessFor details about parameters, see Table 1.Re", + "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":"Deleting Image Permissions", + "title":"Canceling Image Permissions", "uri":"swr_02_0047.html", "doc_type":"api", "p_code":"32", "code":"34" }, { - "desc":"Update the image operation permissions for certain users.NonePATCH /v2/manage/namespaces/{namespace}/repos/{repository}/accessFor details about parameters, see Table 1.Re", + "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", @@ -315,7 +315,7 @@ "code":"35" }, { - "desc":"Query image permissions.NoneGET /v2/manage/namespaces/{namespace}/repos/{repository}/accessFor details about parameters, see Table 1.Request parametersRequest header para", + "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", @@ -323,6 +323,141 @@ "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", @@ -330,7 +465,7 @@ "uri":"swr_02_0008.html", "doc_type":"api", "p_code":"", - "code":"37" + "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.", @@ -338,25 +473,25 @@ "title":"Status Codes", "uri":"swr_02_0023.html", "doc_type":"api", - "p_code":"37", - "code":"38" + "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":"swr_02_0024.html", + "uri":"ErrorCode.html", "doc_type":"api", - "p_code":"37", - "code":"39" + "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.html", + "uri":"swr_02_0064-1.html", "doc_type":"api", "p_code":"", - "code":"40" + "code":"55" } ] \ No newline at end of file diff --git a/docs/swr/api-ref/ErrorCode.html b/docs/swr/api-ref/ErrorCode.html new file mode 100644 index 000000000..b83a9d9d1 --- /dev/null +++ b/docs/swr/api-ref/ErrorCode.html @@ -0,0 +1,1746 @@ + + +

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.

+
[
+    {
+        "errorCode": "SVCSTG.SWR.4001048",
+        "errorMessage": "Failed to get Token from Context",
+        "detail": ""
+    }
+]
+

In the preceding information, errorCode indicates error code, errorMessage indicates error description, and detail provides error details.

+
+

Error Code Description

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

Status Code

+

Error Code

+

Description

+

Solution

+

401

+

SVCSTG.SWR.4010000

+

Authentication failed. The possible cause is that the token has expired.

+

Obtain a new token and try again later.

+

500

+

SVCSTG.SWR.5000001

+

Internal server error: Failed to obtain the application description.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000002

+

Internal server error: Failed to obtain the image information.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000003

+

Internal server error: Failed to obtain the image list.

+

Rectify the issue based on the error message or contact technical support.

+

404

+

SVCSTG.SWR.4040004

+

The software package was not found.

+

Check whether the package exists. If not, obtain it.

+

500

+

SVCSTG.SWR.5000005

+

Internal server error: Deletion failed.

+

Rectify the issue based on the error message or contact technical support.

+

409

+

SVCSTG.SWR.4090006

+

The image already exists.

+

Check whether the image already exists.

+

500

+

SVCSTG.SWR.5000007

+

Internal server error: Obtain failed.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000008

+

Internal server error: Failed to obtain the list.

+

Rectify the issue based on the error message or contact technical support.

+

404

+

SVCSTG.SWR.4040009

+

The image list was not found.

+

Rectify the issue based on the error message or contact technical support.

+

404

+

SVCSTG.SWR.4040010

+

The image was not found.

+

Check whether the image exists.

+

500

+

SVCSTG.SWR.5000011

+

Internal server error: Update failed.

+

Rectify the issue based on the error message or contact technical support.

+

406

+

SVCSTG.SWR.4060074

+

The organization cannot be deleted because there are images in it.

+

Delete images from the organization first.

+

400

+

SVCSTG.SWR.4000013

+

Invalid digest.

+

Use an invalid digest.

+

400

+

SVCSTG.SWR.4000014

+

Invalid API parameters.

+

Modify the request body based on the error message and the SWR API documentation, or contact technical support.

+

400

+

SVCSTG.SWR.4000015

+

Invalid package name.

+

Modify the request body based on the error message and the SWR API documentation, or contact technical support.

+

400

+

SVCSTG.SWR.4000016

+

Invalid version number.

+

Modify the request body based on the error message and the SWR API documentation, or contact technical support.

+

500

+

SVCSTG.SWR.5000017

+

Internal server error: Application signing is disabled.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000018

+

Internal server error: Failed to read public keys.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000019

+

Internal server error: Failed to find local files.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000020

+

Internal server error: Failed to obtain session locks.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000021

+

Internal server error: Failed to synchronize files.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000022

+

Internal server error: Failed to synchronize meta files.

+

Rectify the issue based on the error message or contact technical support.

+

406

+

SVCSTG.SWR.4060012

+

Failed to delete the image repository because there are images in it.

+

Delete images from the repository first.

+

409

+

SVCSTG.SWR.4090023

+

The system is busy.

+

Try again later.

+

500

+

SVCSTG.SWR.5000024

+

Internal server error: Failed to generate an SHA value.

+

Rectify the issue based on the error message or contact technical support.

+

413

+

SVCSTG.SWR.4130025

+

The file is too large.

+

Upload a smaller file.

+

500

+

SVCSTG.SWR.5000027

+

Internal server error: Failed to decompress the package.

+

Rectify the issue based on the error message or contact technical support.

+

400

+

SVCSTG.SWR.4000028

+

Invalid image format.

+

Use a valid format.

+

400

+

SVCSTG.SWR.4000029

+

Inconsistent image names.

+

Use a valid image name.

+

500

+

SVCSTG.SWR.5000030

+

Internal server error: Failed to locate the file pointer.

+

Rectify the issue based on the error message or contact technical support.

+

400

+

SVCSTG.SWR.4000031

+

Invalid AK/SK.

+

Use valid AK/SK.

+

500

+

SVCSTG.SWR.5000032

+

Internal server error: JSON conversion failed.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000033

+

Internal server error: Failed to save the application file.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000034

+

Internal server error: Failed to delete the application.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000035

+

Internal server error: Failed to save the application to the database.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000036

+

Internal server error: Failed to update the application database.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000037

+

Internal server error: Failed to create the signature.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000038

+

Internal server error: Failed to delete the signature.

+

Rectify the issue based on the error message or contact technical support.

+

400

+

SVCSTG.SWR.4000039

+

Invalid session ID.

+

Check whether the session ID is valid.

+

500

+

SVCSTG.SWR.5000040

+

Failed to update status.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000041

+

Internal server error: Failed to read the session.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000042

+

Internal server error: Failed to reclaim the session.

+

Rectify the issue based on the error message or contact technical support.

+

404

+

SVCSTG.SWR.4040043

+

The session was not found.

+

Check whether the session ID exists.

+

500

+

SVCSTG.SWR.5000044

+

Internal server error: Failed to generate the session.

+

Rectify the issue based on the error message or contact technical support.

+

400

+

SVCSTG.SWR.4000045

+

Internal server error: Failed to bind the session.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000046

+

Internal server error: Create failed.

+

Rectify the issue based on the error message or contact technical support.

+

400

+

SVCSTG.SWR.4000047

+

This version is not supported.

+

Use a supported version.

+

404

+

SVCSTG.SWR.4040048

+

The image tag was not found.

+

Check whether the image tag exists.

+

500

+

SVCSTG.SWR.5000049

+

Internal server error: Failed to delete the image.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000050

+

Internal server error: Failed to generate the digest.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000051

+

Internal server error: Failed to obtain the SHA list.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000052

+

Internal server error: Failed to reduce image references.

+

Rectify the issue based on the error message or contact technical support.

+

406

+

SVCSTG.SWR.4060053

+

Delete failed.

+

Delete the software package first.

+

500

+

SVCSTG.SWR.5000054

+

Internal server error: Save failed.

+

Rectify the issue based on the error message or contact technical support.

+

400

+

SVCSTG.SWR.4000055

+

No search criteria.

+

Enter search criteria.

+

400

+

SVCSTG.SWR.4000056

+

Invalid page size.

+

Change the page size.

+

500

+

SVCSTG.SWR.5000057

+

Internal server error: Failed to obtain the organization.

+

Rectify the issue based on the error message or contact technical support.

+

404

+

SVCSTG.SWR.4040058

+

The organization was not found.

+

Check whether the organization exists.

+

500

+

SVCSTG.SWR.5000059

+

Internal server error: Failed to create the organization.

+

Rectify the issue based on the error message or contact technical support.

+

409

+

SVCSTG.SWR.4090060

+

The organization already exists.

+

Check whether the organization already exists.

+

500

+

SVCSTG.SWR.5000061

+

Failed to obtain the IP address of the software instance.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000062

+

Failed to obtain the local IP address of the software.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000063

+

Failed to obtain the tag list.

+

Rectify the issue based on the error message or contact technical support.

+

400

+

SVCSTG.SWR.4000064

+

Invalid image: The manifest file contains empty RepoTags.

+

Modify the request body based on the error message and the SWR API documentation, or contact technical support.

+

400

+

SVCSTG.SWR.4000065

+

Invalid image: The manifest file does not have layer information.

+

Modify the request body based on the error message and the SWR API documentation, or contact technical support.

+

400

+

SVCSTG.SWR.4000066

+

Invalid image: The manifest file does not have configuration information.

+

Modify the request body based on the error message and the SWR API documentation, or contact technical support.

+

400

+

SVCSTG.SWR.4000067

+

Invalid image package: The image package does not have a manifest file.

+

Check whether the image package format is correct.

+

400

+

SVCSTG.SWR.4000068

+

Invalid image: Failed to parse the manifest file.

+

Modify the request body based on the error message and the SWR API documentation, or contact technical support.

+

400

+

SVCSTG.SWR.4000069

+

Invalid image: The image format is incorrect or not supported.

+

Modify the request body based on the error message and the SWR API documentation, or contact technical support.

+

507

+

SVCSTG.SWR.5070070

+

Your OBS service is disabled or an error occurred.

+

Check whether your OBS service is available.

+

500

+

SVCSTG.SWR.5000071

+

Internal server error: Failed to obtain the user list.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000073

+

Internal server error: Restore failed.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000075

+

Internal server error: Failed to update the organization.

+

Rectify the issue based on the error message or contact technical support.

+

409

+

SVCSTG.SWR.4090076

+

The organization permission already exists.

+

Check whether the organization permission already exists.

+

500

+

SVCSTG.SWR.5000077

+

Internal server error: Failed to obtain the organization permission.

+

Rectify the issue based on the error message or contact technical support.

+

404

+

SVCSTG.SWR.4040078

+

The organization permission was not found.

+

Check whether the organization permission exists.

+

500

+

SVCSTG.SWR.5000079

+

Internal server error: Failed to update the organization permission.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000080

+

Internal server error: Failed to create the organization permission.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000081

+

Internal server error: Failed to delete the organization permission.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000082

+

Internal server error: Failed to parse the JSON file.

+

Rectify the issue based on the error message or contact technical support.

+

404

+

SVCSTG.SWR.4040083

+

The requested URL was not found.

+

Check whether the URL is correct.

+

500

+

SVCSTG.SWR.5000084

+

Internal server error: Failed to obtain the service.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000085

+

Internal server error: Failed to create the tag.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000086

+

Internal server error: Failed to update the tag.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000087

+

Internal server error: Failed to obtain the image layer.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000088

+

Internal server error: Failed to delete the image layer from UDS.

+

Rectify the issue based on the error message or contact technical support.

+

409

+

SVCSTG.SWR.4090089

+

The permission already exists.

+

Check whether the permission already exists.

+

500

+

SVCSTG.SWR.5000090

+

Internal server error: Failed to obtain the permission.

+

Rectify the issue based on the error message or contact technical support.

+

404

+

SVCSTG.SWR.4040091

+

The permission was not found.

+

Check whether the permission exists.

+

500

+

SVCSTG.SWR.5000092

+

Internal server error: Failed to update the permission.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5000093

+

Internal server error: Failed to create the permission.

+

Rectify the issue based on the error message or contact technical support.

+

400

+

SVCSTG.SWR.4000097

+

The maximum number of organizations has been exceeded.

+

Submit a service ticket to increase the quota.

+

400

+

SVCSTG.SWR.4000098

+

The maximum number of images has been exceeded.

+

Change the number of images and try again.

+

400

+

SVCSTG.SWR.4000099

+

The maximum number of image tags has been exceeded.

+

Change the number of image tags and try again.

+

500

+

SVCSTG.SWR.5000112

+

Internal server error. Failed to obtain the image.

+

Rectify the issue based on the error message or contact technical support.

+

404

+

SVCSTG.SWR.4040113

+

The image was not found.

+

Check whether the image exists.

+

500

+

SVCSTG.SWR.5000114

+

Internal server error. Failed to obtain the image tag.

+

Rectify the issue based on the error message or contact technical support.

+

404

+

SVCSTG.SWR.4040115

+

The image tag was not found.

+

Check whether the image tag exists.

+

400

+

SVCSTG.SWR.4001000

+

Content-Type must be set to multipart/form-data.

+

Check whether the value of Content-Type is multipart/form-data.

+

413

+

SVCSTG.SWR.4131001

+

The request body is too large.

+

Change the body to a smaller size and try again.

+

500

+

SVCSTG.SWR.5001002

+

Internal server error: The external address is disabled.

+

Rectify the issue based on the error message or contact technical support.

+

400

+

SVCSTG.SWR.4001003

+

Failed to obtain the form file.

+

Rectify the issue based on the error message or contact technical support.

+

400

+

SVCSTG.SWR.4001004

+

type must be set to app.

+

Change the value of type to app.

+

400

+

SVCSTG.SWR.4001005

+

Failed to parse the form.

+

Rectify the issue based on the error message or contact technical support.

+

400

+

SVCSTG.SWR.4001006

+

Invalid meta file format.

+

Change the meta file format.

+

400

+

SVCSTG.SWR.4001008

+

Invalid organization or name.

+

Use a valid organization or name.

+

400

+

SVCSTG.SWR.4001009

+

is_public must be set to true or false.

+

Change the value of is_public to true or false.

+

400

+

SVCSTG.SWR.4001010

+

type must be set to app or image.

+

Change the value of type to app.

+

400

+

SVCSTG.SWR.4001011

+

type must be set to app or image, or left blank.

+

Change the value of type to app.

+

413

+

SVCSTG.SWR.4131012

+

The description exceeds the maximum length allowed.

+

Shorten the description.

+

400

+

SVCSTG.SWR.4001013

+

ak and sk cannot be left blank.

+

Enter an AK and SK.

+

400

+

SVCSTG.SWR.4001014

+

Mandatory parameters must be configured.

+

Configure all mandatory parameters.

+

400

+

SVCSTG.SWR.4001015

+

The form file was not found.

+

Check whether the form file is missing.

+

400

+

SVCSTG.SWR.4001016

+

is_public and manifests must be configured.

+

Check whether is_public and manifests are configured.

+

400

+

SVCSTG.SWR.4001018

+

Invalid request body type.

+

Use a valid body type.

+

400

+

SVCSTG.SWR.4001019

+

Failed to parse the form file.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5001020

+

Internal server error: Failed to read the form file.

+

Rectify the issue based on the error message or contact technical support.

+

400

+

SVCSTG.SWR.4001021

+

The version number cannot be left blank.

+

Check whether the version number is left blank.

+

400

+

SVCSTG.SWR.4001022

+

Invalid file type.

+

Use a valid file type.

+

400

+

SVCSTG.SWR.4001023

+

The file type is not supported.

+

Use a supported file type.

+

400

+

SVCSTG.SWR.4001024

+

Failed to query parameters.

+

Rectify the issue based on the error message or contact technical support.

+

400

+

SVCSTG.SWR.4001025

+

Invalid parameters.

+

Modify the query parameters based on the API documentation.

+

500

+

SVCSTG.SWR.5001026

+

Failed to obtain the manifest file.

+

Rectify the issue based on the error message or contact technical support.

+

400

+

SVCSTG.SWR.4001027

+

Status must be set to done or error.

+

Change the value of status to done or error.

+

400

+

SVCSTG.SWR.4001028

+

Invalid organization name.

+

Use a valid organization name.

+

400

+

SVCSTG.SWR.4001029

+

Invalid image name.

+

Use a valid image name.

+

400

+

SVCSTG.SWR.4001030

+

Invalid package.

+

Change the value of package.

+

403

+

SVCSTG.SWR.4031032

+

The number of requests exceeds the maximum number allowed.

+

Rectify the issue based on the error message or contact technical support.

+

403

+

SVCSTG.SWR.4031033

+

Unavailable request.

+

Rectify the issue based on the error message or contact technical support.

+

400

+

SVCSTG.SWR.4001035

+

Invalid filtering criteria.

+

Rectify the issue based on the error message or contact technical support.

+

400

+

SVCSTG.SWR.4001036

+

Parameters are lost.

+

Rectify the issue based on the error message or contact technical support.

+

400

+

SVCSTG.SWR.4001037

+

The registry type is not supported.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5001038

+

The registry is unavailable.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5001039

+

Search failed.

+

Rectify the issue based on the error message or contact technical support.

+

400

+

SVCSTG.SWR.4001041

+

The domain parameter is invalid.

+

Change the value of domain.

+

403

+

SVCSTG.SWR.4031042

+

There are too many requests.

+

Rectify the issue based on the error message or contact technical support.

+

403

+

SVCSTG.SWR.4031043

+

Invalid JWT token request.

+

Rectify the issue based on the error message or contact technical support.

+

401

+

SVCSTG.SWR.4011044

+

The image has been created by another user. You do not have permission to upload it.

+

Check whether you have permission to upload the image.

+

400

+

SVCSTG.SWR.4001045

+

The SWRServer parameter is missing.

+

Check whether the SWRServer parameter is missing.

+

500

+

SVCSTG.SWR.5001046

+

Internal server error: Failed to check the organization.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5001047

+

Internal server error: Failed to save the organization.

+

Rectify the issue based on the error message or contact technical support.

+

400

+

SVCSTG.SWR.4001048

+

Failed to obtain the token.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5001049

+

Internal server error: Failed to delete the organization.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5001050

+

Internal server error: Failed to obtain the image layer.

+

Rectify the issue based on the error message or contact technical support.

+

404

+

SVCSTG.SWR.4041051

+

The image layer was not found.

+

Check whether the image layer exists.

+

500

+

SVCSTG.SWR.5001052

+

Internal server error: Invalid image layer.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5001053

+

Internal server error: Invalid upload of an image layer.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5001054

+

Internal server error: Failed to create the image layer path.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5001055

+

Internal server error: Failed to save the image layer.

+

Rectify the issue based on the error message or contact technical support.

+

404

+

SVCSTG.SWR.4041056

+

The image tag was not found.

+

Check whether the image tag exists.

+

500

+

SVCSTG.SWR.5001056

+

Internal server error: Failed to obtain the tag list.

+

Rectify the issue based on the error message or contact technical support.

+

404

+

SVCSTG.SWR.4041057

+

The tag list was not found.

+

Check whether the tag list exists.

+

500

+

SVCSTG.SWR.5001058

+

Internal server error: Failed to save the image.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5001059

+

Internal server error: Failed to obtain the image.

+

Rectify the issue based on the error message or contact technical support.

+

404

+

SVCSTG.SWR.4041060

+

The manifest file was not found.

+

Check whether the manifest file exists.

+

404

+

SVCSTG.SWR.4041061

+

The organization was not found.

+

Check whether the organization exists.

+

500

+

SVCSTG.SWR.5001062

+

Internal server error: Failed to update the organization.

+

Rectify the issue based on the error message or contact technical support.

+

500

+

SVCSTG.SWR.5001063

+

Internal server error: Failed to delete the image layer.

+

Rectify the issue based on the error message or contact technical support.

+

401

+

SVCSTG.SWR.4011064

+

Cross-account error. For example, you do not have permission to access or operate resources of other accounts.

+

Check whether you have permission to upload the image.

+

400

+

SVCSTG.SWR.4001065

+

Invalid organization permissions.

+

Change organization permissions.

+

400

+

SVCSTG.SWR.4001066

+

Invalid permissions.

+

Change permissions.

+

400

+

SVCSTG.SWR.4001067

+

Invalid username.

+

Use a valid username.

+

500

+

SVCSTG.SWR.5001076

+

Failed to obtain the service token.

+

Rectify the issue based on the error message or contact technical support.

+

401

+

SVCSTG.S2I.4019000

+

Authentication error: No user token or user AK/SK information found.

+

Check whether you have permission to upload the image.

+

403

+

SVCSTG.SWR.4039001

+

You cannot apply for or operate the resources that do not belong to you.

+

Check whether you have permission to upload the image.

+

403

+

SVCSTG.SWR.4039002

+

You do not have the permission to perform this operation.

+

Check whether you have permission to upload the image.

+

400

+

SVCSTG.SWR.4009010

+

Invalid organization.

+

Use a valid organization.

+

400

+

SVCSTG.SWR.4009011

+

Invalid image name.

+

Use a valid image name.

+

400

+

SVCSTG.SWR.4009012

+

Invalid code source type.

+

Use a valid code source type.

+

400

+

SVCSTG.SWR.4009013

+

Invalid ID.

+

Use a valid ID.

+

400

+

SVCSTG.SWR.4009014

+

Invalid filtering criteria.

+

Use valid filtering criteria.

+

400

+

SVCSTG.SWR.4009015

+

Failed to parse the build task.

+

Rectify the issue based on the error message or contact technical support.

+

400

+

SVCSTG.SWR.4009016

+

Invalid file path.

+

Use a valid file path.

+

400

+

SVCSTG.SWR.4009017

+

Invalid source code owner.

+

Use a valid source code owner.

+

400

+

SVCSTG.SWR.4009018

+

Invalid source code repository.

+

Use a valid source code repository.

+

400

+

SVCSTG.SWR.4009019

+

Invalid source code repository ID.

+

Use a valid source code repository ID.

+

400

+

SVCSTG.SWR.4009020

+

Invalid source code branch.

+

Use a valid source code branch.

+

400

+

SVCSTG.SWR.4009021

+

Invalid image tag.

+

Use a valid image tag.

+

400

+

SVCSTG.SWR.4009022

+

Invalid source code username.

+

Use a valid source code username.

+

400

+

SVCSTG.SWR.4009023

+

Invalid commit ID.

+

Use a valid commit ID.

+

400

+

SVCSTG.SWR.4006030

+

Failed to execute the build task.

+

Rectify the issue based on the error message or contact technical support.

+

400

+

SVCSTG.SWR.4006031

+

The build record already exists.

+

Check whether the build record already exists.

+

404

+

SVCSTG.SWR.4046032

+

The build record was not found.

+

Check whether the build record exists.

+

500

+

SVCSTG.SWR.5006033

+

Failed to obtain the build record from the database.

+

Rectify the issue based on the error message or contact technical support.

+

403

+

SVCSTG.SWR.4037017

+

You do not have permission to modify or manage any organization.

+

Create an organization or obtain permission to modify and manage other organizations.

+

403

+

SVCSTG.SWR.4037018

+

You do not have permission to modify or manage any images.

+

Create an image or obtain permission to modify and manage other images.

+

500

+

SVCSTG.SWR.5007019

+

Failed to create the image. The maximum number of images have been reached.

+

Rectify the issue based on the error message or contact technical support.

+

403

+

SVCSTG.SWR.4037020

+

You do not have permission to operate resources in the repository.

+

Elevate your permissions in the organization.

+

400

+

SVCSTG.SWR.4001091

+

The permission parameter is incorrect.

+

Change the value of permission.

+
+
+
+
+
+ +
+ diff --git a/docs/swr/api-ref/en-us_topic_0000001470804877.html b/docs/swr/api-ref/en-us_topic_0000001470804877.html deleted file mode 100644 index d08d4d5f1..000000000 --- a/docs/swr/api-ref/en-us_topic_0000001470804877.html +++ /dev/null @@ -1,23 +0,0 @@ - - -

Shared Account Management

-
-
- - - -
- diff --git a/docs/swr/api-ref/swr_02_0008.html b/docs/swr/api-ref/swr_02_0008.html index dfa46be5d..311c13c5b 100644 --- a/docs/swr/api-ref/swr_02_0008.html +++ b/docs/swr/api-ref/swr_02_0008.html @@ -6,7 +6,7 @@ diff --git a/docs/swr/api-ref/swr_02_0011.html b/docs/swr/api-ref/swr_02_0011.html index 911f7635b..0b1adf29c 100644 --- a/docs/swr/api-ref/swr_02_0011.html +++ b/docs/swr/api-ref/swr_02_0011.html @@ -1,22 +1,30 @@ -

API

+

APIs

diff --git a/docs/swr/api-ref/swr_02_0024.html b/docs/swr/api-ref/swr_02_0024.html deleted file mode 100644 index fcd309aa4..000000000 --- a/docs/swr/api-ref/swr_02_0024.html +++ /dev/null @@ -1,1350 +0,0 @@ - - -

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.

-
[
-    {
-        "errorCode": "SVCSTG.SWR.4001048",
-        "errorMessage": "Failed to get Token from Context",
-        "detail": ""
-    }
-]
-

In the preceding information, errorCode indicates error code, errorMessage indicates error description, and detail provides error details.

-
-

Error Code Description

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Error Code

-

Description

-

401

-

SVCSTG.SWR.4010000

-

Authentication failed. Obtain a new token and try again.

-

500

-

SVCSTG.SWR.5000001

-

Internal server error: Failed to obtain the application description.

-

500

-

SVCSTG.SWR.5000002

-

Internal server error: Failed to obtain the image information.

-

500

-

SVCSTG.SWR.5000003

-

Internal server error: Failed to obtain the image list.

-

404

-

SVCSTG.SWR.4040004

-

The software package does not exist.

-

500

-

SVCSTG.SWR.5000005

-

Internal server error: Deletion fails.

-

409

-

SVCSTG.SWR.4090006

-

The image already exists.

-

500

-

SVCSTG.SWR.5000007

-

Internal server error: Operation fails.

-

500

-

SVCSTG.SWR.5000008

-

Internal server error: Failed to obtain the list.

-

404

-

SVCSTG.SWR.4040009

-

The image list cannot be found.

-

404

-

SVCSTG.SWR.4040010

-

The image does not exist.

-

500

-

SVCSTG.SWR.5000011

-

Internal server error: Update fails.

-

406

-

SVCSTG.SWR.4060012

-

Failed to delete the image repository because it contains images.

-

400

-

SVCSTG.SWR.4000013

-

Invalid digest.

-

400

-

SVCSTG.SWR.4000014

-

Invalid API parameter. Modify the request body based on the returned message and the SWR API documentation, or contact technical support.

-

400

-

SVCSTG.SWR.4000015

-

Invalid package name.

-

400

-

SVCSTG.SWR.4000016

-

Invalid version number.

-

500

-

SVCSTG.SWR.5000017

-

Internal server error: The application signature function is disabled.

-

500

-

SVCSTG.SWR.5000018

-

Internal server error: Failed to read public keys.

-

500

-

SVCSTG.SWR.5000019

-

Internal server error: Failed to find local files.

-

500

-

SVCSTG.SWR.5000020

-

Internal server error: Failed to obtain session locks.

-

500

-

SVCSTG.SWR.5000021

-

Internal server error: Failed to synchronize files.

-

500

-

SVCSTG.SWR.5000022

-

Internal server error: Failed to synchronize meta files.

-

409

-

SVCSTG.SWR.4090023

-

The system is busy.

-

500

-

SVCSTG.SWR.5000024

-

Internal server error: Failed to generate the SHA value.

-

413

-

SVCSTG.SWR.4130025

-

The file exceeds the maximum size allowed.

-

500

-

SVCSTG.SWR.5000027

-

Internal server error: Failed to decompress the package.

-

400

-

SVCSTG.SWR.4000028

-

Incorrect image format.

-

400

-

SVCSTG.SWR.4000029

-

Incorrect image format: The image name is inconsistent.

-

500

-

SVCSTG.SWR.5000030

-

Internal server error: Failed to locate the file pointer.

-

400

-

SVCSTG.SWR.4000031

-

Invalid AK/SK.

-

500

-

SVCSTG.SWR.5000032

-

Internal server error: JSON conversion fails.

-

500

-

SVCSTG.SWR.5000033

-

Internal server error: Failed to save the application file.

-

500

-

SVCSTG.SWR.5000034

-

Internal server error: Failed to delete the application.

-

500

-

SVCSTG.SWR.5000035

-

Internal server error: Failed to save the application to the database.

-

500

-

SVCSTG.SWR.5000036

-

Internal server error: Failed to update the application database.

-

500

-

SVCSTG.SWR.5000037

-

Internal server error: Failed to create the signature.

-

500

-

SVCSTG.SWR.5000038

-

Internal server error: Failed to delete the signature.

-

400

-

SVCSTG.SWR.4000039

-

Invalid session ID.

-

500

-

SVCSTG.SWR.5000040

-

Failed to update status.

-

500

-

SVCSTG.SWR.5000041

-

Internal server error: Failed to read the session.

-

500

-

SVCSTG.SWR.5000042

-

Internal server error: Failed to reclaim the session.

-

404

-

SVCSTG.SWR.4040043

-

The session does not exist.

-

500

-

SVCSTG.SWR.5000044

-

Internal server error: Failed to generate the session.

-

400

-

SVCSTG.SWR.4000045

-

Internal server error: Failed to bind the session.

-

500

-

SVCSTG.SWR.5000046

-

Internal server error: Creation fails.

-

400

-

SVCSTG.SWR.4000047

-

This version is not supported.

-

404

-

SVCSTG.SWR.4040048

-

The image tag does not exist.

-

500

-

SVCSTG.SWR.5000049

-

Internal server error: Failed to delete the image.

-

500

-

SVCSTG.SWR.5000050

-

Internal server error: Failed to generate the digest.

-

500

-

SVCSTG.SWR.5000051

-

Internal server error: Failed to obtain the SHA list.

-

500

-

SVCSTG.SWR.5000052

-

Internal server error: Failed to reduce image references.

-

406

-

SVCSTG.SWR.4060053

-

Deletion fails. Please first delete the software package.

-

500

-

SVCSTG.SWR.5000054

-

Internal server error: Saving fails.

-

400

-

SVCSTG.SWR.4000055

-

No search content.

-

400

-

SVCSTG.SWR.4000056

-

Invalid page size.

-

500

-

SVCSTG.SWR.5000057

-

Internal server error: Failed to obtain the organization.

-

404

-

SVCSTG.SWR.4040058

-

The organization does not exist.

-

500

-

SVCSTG.SWR.5000059

-

Internal server error: Failed to create the organization.

-

409

-

SVCSTG.SWR.4090060

-

The organization already exists.

-

500

-

SVCSTG.SWR.5000061

-

Failed to obtain the IP address of the software instance.

-

500

-

SVCSTG.SWR.5000062

-

Failed to obtain the local IP address of the software.

-

500

-

SVCSTG.SWR.5000063

-

Failed to obtain the tag list.

-

400

-

SVCSTG.SWR.4000064

-

Invalid image: The manifest file contains empty RepoTags.

-

400

-

SVCSTG.SWR.4000065

-

Invalid image: The manifest file does not have layer information.

-

400

-

SVCSTG.SWR.4000066

-

Invalid image: The manifest file does not have configuration information.

-

400

-

SVCSTG.SWR.4000067

-

Invalid image package: The image package does not have a manifest file.

-

400

-

SVCSTG.SWR.4000068

-

Invalid image: Failed to parse the manifest file.

-

400

-

SVCSTG.SWR.4000069

-

Invalid image: The image format is incorrect or not supported.

-

507

-

SVCSTG.SWR.5070070

-

Your OBS service is disabled or incorrect. Please first check your OBS service.

-

500

-

SVCSTG.SWR.5000071

-

Internal server error: Failed to obtain the user list.

-

500

-

SVCSTG.SWR.5000073

-

Internal server error: Restoration fails.

-

500

-

SVCSTG.SWR.5000075

-

Internal server error: Failed to update the organization.

-

409

-

SVCSTG.SWR.4090076

-

The organization permission already exists.

-

500

-

SVCSTG.SWR.5000077

-

Internal server error: Failed to obtain the organization permission.

-

404

-

SVCSTG.SWR.4040078

-

The organization permission does not exist.

-

500

-

SVCSTG.SWR.5000079

-

Internal server error: Failed to update the organization permission.

-

500

-

SVCSTG.SWR.5000080

-

Internal server error: Failed to create the organization permission.

-

500

-

SVCSTG.SWR.5000081

-

Internal server error: Failed to delete the organization permission.

-

500

-

SVCSTG.SWR.5000082

-

Internal server error: Failed to parse the JSON file.

-

404

-

SVCSTG.SWR.4040083

-

The requested URL cannot be found.

-

500

-

SVCSTG.SWR.5000084

-

Internal server error: Failed to obtain the service.

-

500

-

SVCSTG.SWR.5000085

-

Internal server error: Failed to create the tag.

-

500

-

SVCSTG.SWR.5000086

-

Internal server error: Failed to update the tag.

-

500

-

SVCSTG.SWR.5000087

-

Internal server error: Failed to obtain the image layer.

-

500

-

SVCSTG.SWR.5000088

-

Internal server error: Failed to delete the image layer from UDS.

-

409

-

SVCSTG.SWR.4090089

-

The permission already exists.

-

500

-

SVCSTG.SWR.5000090

-

Internal server error: Failed to obtain the permission.

-

404

-

SVCSTG.SWR.4040091

-

The permission does not exist.

-

500

-

SVCSTG.SWR.5000092

-

Internal server error: Failed to update the permission.

-

500

-

SVCSTG.SWR.5000093

-

Internal server error: Failed to create the permission.

-

400

-

SVCSTG.SWR.4000097

-

The maximum number of organizations has been exceeded.

-

400

-

SVCSTG.SWR.4000098

-

The maximum number of images has been exceeded.

-

400

-

SVCSTG.SWR.4000099

-

The maximum number of image tags has been exceeded.

-

500

-

SVCSTG.SWR.5000112

-

Internal server error. Failed to obtain the image.

-

404

-

SVCSTG.SWR.4040113

-

The image does not exist.

-

500

-

SVCSTG.SWR.5000114

-

Internal server error. Failed to obtain the image tag.

-

404

-

SVCSTG.SWR.4040115

-

The image tag does not exist.

-

400

-

SVCSTG.SWR.4001000

-

Content-Type must be set to multipart/form-data.

-

413

-

SVCSTG.SWR.4131001

-

The request exceeds the maximum size allowed.

-

500

-

SVCSTG.SWR.5001002

-

Internal server error: The external address is disabled.

-

400

-

SVCSTG.SWR.4001003

-

Failed to obtain the form file.

-

400

-

SVCSTG.SWR.4001004

-

Type must be set to app.

-

400

-

SVCSTG.SWR.4001005

-

Failed to parse the form.

-

400

-

SVCSTG.SWR.4001006

-

Invalid meta file format.

-

400

-

SVCSTG.SWR.4001008

-

Invalid organization or name.

-

400

-

SVCSTG.SWR.4001009

-

is_public must be set to true or false.

-

400

-

SVCSTG.SWR.4001010

-

Type must be set to app or image.

-

400

-

SVCSTG.SWR.4001011

-

Type must be set to app, image or left blank.

-

413

-

SVCSTG.SWR.4131012

-

The description exceeds the maximum length allowed.

-

400

-

SVCSTG.SWR.4001013

-

ak or sk cannot be left blank.

-

400

-

SVCSTG.SWR.4001014

-

Mandatory parameters must be set.

-

400

-

SVCSTG.SWR.4001015

-

The form file cannot be found.

-

400

-

SVCSTG.SWR.4001016

-

At least is_public and manifests must be set.

-

400

-

SVCSTG.SWR.4001018

-

Incorrect request body type.

-

400

-

SVCSTG.SWR.4001019

-

Failed to parse the form file.

-

500

-

SVCSTG.SWR.5001020

-

Internal server error: Failed to read the form file.

-

400

-

SVCSTG.SWR.4001021

-

The version number cannot be left blank.

-

400

-

SVCSTG.SWR.4001022

-

Incorrect file type.

-

400

-

SVCSTG.SWR.4001023

-

Unsupported file type.

-

400

-

SVCSTG.SWR.4001024

-

Failed to query parameters.

-

400

-

SVCSTG.SWR.4001025

-

Invalid parameter.

-

500

-

SVCSTG.SWR.5001026

-

Failed to obtain the manifest file.

-

400

-

SVCSTG.SWR.4001027

-

Status must be set to done or error.

-

400

-

SVCSTG.SWR.4001028

-

Invalid organization name.

-

400

-

SVCSTG.SWR.4001029

-

Invalid image name.

-

400

-

SVCSTG.SWR.4001030

-

Invalid package.

-

403

-

SVCSTG.SWR.4031032

-

The number of requests exceeds the maximum number allowed.

-

403

-

SVCSTG.SWR.4031033

-

Unavailable request.

-

400

-

SVCSTG.SWR.4001035

-

Invalid filtering criteria.

-

400

-

SVCSTG.SWR.4001036

-

Parameters are lost.

-

400

-

SVCSTG.SWR.4001037

-

The registration center type is not supported.

-

500

-

SVCSTG.SWR.5001038

-

The registration center is unavailable.

-

500

-

SVCSTG.SWR.5001039

-

Search fails.

-

400

-

SVCSTG.SWR.4001041

-

Invalid domain.

-

403

-

SVCSTG.SWR.4031042

-

There are too many requests.

-

403

-

SVCSTG.SWR.4031043

-

Invalid JWT token request.

-

401

-

SVCSTG.SWR.4011044

-

The image to be uploaded has been created by another user. You do not have the permission to upload the image.

-

400

-

SVCSTG.SWR.4001045

-

The SWRServer parameter is missing.

-

500

-

SVCSTG.SWR.5001046

-

Internal server error: Failed to check the organization.

-

500

-

SVCSTG.SWR.5001047

-

Internal server error: Failed to save the organization.

-

400

-

SVCSTG.SWR.4001048

-

Failed to obtain the token.

-

500

-

SVCSTG.SWR.5001049

-

Internal server error: Failed to delete the organization.

-

500

-

SVCSTG.SWR.5001050

-

Internal server error: Failed to obtain the image layer.

-

404

-

SVCSTG.SWR.4041051

-

The image layer does not exist.

-

500

-

SVCSTG.SWR.5001052

-

Internal server error: Invalid image layer.

-

500

-

SVCSTG.SWR.5001053

-

Internal server error: Invalid upload of an image layer.

-

500

-

SVCSTG.SWR.5001054

-

Internal server error: Failed to create the image layer path.

-

500

-

SVCSTG.SWR.5001055

-

Internal server error: Failed to save the image layer.

-

404

-

SVCSTG.SWR.4041056

-

The image tag does not exist.

-

500

-

SVCSTG.SWR.5001056

-

Internal server error: Failed to obtain the tag list.

-

404

-

SVCSTG.SWR.4041057

-

The tag list does not exist.

-

500

-

SVCSTG.SWR.5001058

-

Internal server error: Failed to save the image.

-

500

-

SVCSTG.SWR.5001059

-

Internal server error: Failed to obtain the image.

-

404

-

SVCSTG.SWR.4041060

-

The manifest file does not exist.

-

404

-

SVCSTG.SWR.4041061

-

The organization does not exist.

-

500

-

SVCSTG.SWR.5001062

-

Internal server error: Failed to update the organization.

-

500

-

SVCSTG.SWR.5001063

-

Internal server error: Failed to delete the image layer.

-

401

-

SVCSTG.SWR.4011064

-

Insufficient permissions.

-

400

-

SVCSTG.SWR.4001065

-

Invalid organization permissions.

-

400

-

SVCSTG.SWR.4001066

-

Invalid permissions.

-

400

-

SVCSTG.SWR.4001067

-

Invalid username.

-

500

-

SVCSTG.SWR.5001076

-

Failed to obtain the service token.

-

401

-

SVCSTG.S2I.4019000

-

Authentication error: No user token or user AK/SK information found.

-

403

-

SVCSTG.SWR.4039001

-

You cannot apply for or operate the resources that do not belong to you.

-

403

-

SVCSTG.SWR.4039002

-

You do not have the permission to perform this operation.

-

400

-

SVCSTG.SWR.4009010

-

Invalid organization.

-

400

-

SVCSTG.SWR.4009011

-

Invalid image name.

-

400

-

SVCSTG.SWR.4009012

-

Invalid code source type.

-

400

-

SVCSTG.SWR.4009013

-

Invalid ID.

-

400

-

SVCSTG.SWR.4009014

-

Invalid filtering criteria.

-

400

-

SVCSTG.SWR.4009015

-

Failed to parse the build task.

-

400

-

SVCSTG.SWR.4009016

-

Invalid file path.

-

400

-

SVCSTG.SWR.4009017

-

Invalid source code owner.

-

400

-

SVCSTG.SWR.4009018

-

Invalid source code repository.

-

400

-

SVCSTG.SWR.4009019

-

Invalid source code repository ID.

-

400

-

SVCSTG.SWR.4009020

-

Invalid source code branch.

-

400

-

SVCSTG.SWR.4009021

-

Invalid image label.

-

400

-

SVCSTG.SWR.4009022

-

Invalid source code username.

-

400

-

SVCSTG.SWR.4009023

-

Invalid commit ID.

-

400

-

SVCSTG.SWR.4006030

-

Failed to execute the build task.

-

400

-

SVCSTG.SWR.4006031

-

The build record already exists.

-

404

-

SVCSTG.SWR.4046032

-

The build record does not exist.

-

500

-

SVCSTG.SWR.5006033

-

Failed to obtain the build record from the database.

-

403

-

SVCSTG.SWR.4037017

-

You do not have the permission to edit or manage any organization. Please first create an organization or obtain the edit/management permission of the organization.

-

403

-

SVCSTG.SWR.4037018

-

You do not have the permission to edit or manage any image in the image repository. Please first create an image or obtain an editable/manageable image.

-

500

-

SVCSTG.SWR.5007019

-

Failed to create the image. The maximum number of images have been reached.

-

403

-

SVCSTG.SWR.4037020

-

You do not have the permission to operate the image repository resource. Please improve your organization permissions.

-
-
-
-
-
- -
- diff --git a/docs/swr/api-ref/en-us_topic_0000001420846090.html b/docs/swr/api-ref/swr_02_0025.html similarity index 72% rename from docs/swr/api-ref/en-us_topic_0000001420846090.html rename to docs/swr/api-ref/swr_02_0025.html index d54f15921..3a988ed2a 100644 --- a/docs/swr/api-ref/en-us_topic_0000001420846090.html +++ b/docs/swr/api-ref/swr_02_0025.html @@ -1,4 +1,4 @@ - +

Organization Management

@@ -6,16 +6,16 @@ diff --git a/docs/swr/api-ref/swr_02_0026.html b/docs/swr/api-ref/swr_02_0026.html index c68847a59..2a727d961 100644 --- a/docs/swr/api-ref/swr_02_0026.html +++ b/docs/swr/api-ref/swr_02_0026.html @@ -1,118 +1,122 @@

Creating an Organization

-

Function

Create an organization.

+

Description

Create an organization.

-

URI

POST /v2/manage/namespaces

+

Constraints

None

-

Request Parameters

-
Table 1 Request header parameters

Parameter

+

URI

POST /v2/manage/namespaces

+
+

Request Parameters

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

Content-Type

+

Content-Type

Yes

+

Yes

String

+

String

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

-

The default value is application/json.

+

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

+

Default value: application/json

X-Auth-Token

+

X-Auth-Token

Yes

+

Yes

String

+

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.

+

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.

-
Table 2 Request body parameter

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

namespace

+

namespace

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.

+

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.

-

Response Parameters

N/A

+

Response Parameters

None

-

Example Request

POST https://{endpoint}/v2/manage/namespaces
+

Example Request

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

Example Response

N/A

+

Example Response

None

-

Status Code

-

Status Code

+

Status Codes

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

Status Code

Description

+

Description

201

+

201

Creation successful.

+

Organization created.

400

+

400

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

+

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

401

+

401

Authentication failed.

+

Authentication failed.

409

+

409

The resource already exists.

+

The resource already exists.

500

+

500

Internal error.

+

Internal error.

+

Error Codes

For details, see Error Codes.

+
diff --git a/docs/swr/api-ref/swr_02_0027.html b/docs/swr/api-ref/swr_02_0027.html index e3604fa6c..989964bc8 100644 --- a/docs/swr/api-ref/swr_02_0027.html +++ b/docs/swr/api-ref/swr_02_0027.html @@ -1,111 +1,123 @@

Deleting an Organization

-

Function

Delete an organization.

+

Description

Delete an organization.

-

URI

DELETE /v2/manage/namespaces/{namespace}

-

For details about parameters, see Table 1.

+

Constraints

None

+
+

URI

DELETE /v2/manage/namespaces/{namespace}

-
Table 1 Parameter description

Parameter

+
- - - - - - -
Table 1 Path parameter

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

namespace

+

namespace

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.

+

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 Parameters

-
Table 2 Request header parameters

Parameter

+

Request Parameters

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

Content-Type

+

Content-Type

Yes

+

Yes

String

+

String

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

-

The default value is application/json.

+

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

+

Default value: application/json

X-Auth-Token

+

X-Auth-Token

Yes

+

Yes

String

+

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.

+

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

N/A

+

Response Parameters

None

-

Status Code

-

Status Code

+

Example Request

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

Example Response

None

+
+

Status Codes

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

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 organization does not exist.

+

Organization not found.

500

+

406

Internal error.

+

Failed to delete the organization because there are images in it.

+

500

+

Internal error.

+

Error Codes

For details, see Error Codes.

+
diff --git a/docs/swr/api-ref/swr_02_0028.html b/docs/swr/api-ref/swr_02_0028.html index 0e8aaa140..490d1aac4 100644 --- a/docs/swr/api-ref/swr_02_0028.html +++ b/docs/swr/api-ref/swr_02_0028.html @@ -1,197 +1,197 @@ -

Querying the List of Organizations

-

Function

Query the list of organizations.

+

Querying Organizations

+

Description

Query organizations.

-

URI

GET /v2/manage/namespaces

+

Constraints

None

+
+

URI

GET /v2/manage/namespaces

-
Table 1 Query parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

namespace

+

namespace

No

+

No

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.

+

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 and multiple consecutive hyphens are allowed.

filter

+

filter

No

+

No

String

+

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.)

+

Set this parameter to 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 Parameters

-
Table 2 Request header parameters

Parameter

+

Request Parameters

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

Content-Type

+

Content-Type

Yes

+

Yes

String

+

String

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

-

The default value is application/json.

+

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

+

Default value: application/json

X-Auth-Token

+

X-Auth-Token

Yes

+

Yes

String

+

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.

+

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.

-

By default, all organizations will be returned.

+

By default, all organizations will be returned.

-

Response Parameters

-
Table 3 Response body parameter description

Parameter

+

Response Parameters

Status code: 200

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

Parameter

Type

+

Type

Description

+

Description

namespaces

+

namespaces

Array of objects

+

Array of ShowNamespace objects

Organization list

+

Organization list.

-
Table 4 namespaces parameter description

Parameter

+
- - - - - - - - - - - - - -
Table 4 ShowNamespace

Parameter

Type

+

Type

Description

+

Description

ID

+

id

Integer

+

Integer

Organization ID

+

id

name

+

name

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.

creator_name

+

creator_name

String

+

String

IAM username

+

IAM username.

auth

+

auth

Integer

+

Integer

User permission

-
  • 7: Manage
  • 3: Write
  • 1: Read
+

User permissions. 7: manage. 3: edit. 1: read.

-

Example Request

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

Example Request

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

Example Response

Status code: 200

-

The list of organizations is returned successfully.

-
{
-    "namespaces": [
-        {
-            "id": 1343008,
-            "name": "group",
-            "creator_name": "username",
-            "auth": 7
-        }
-    ]
+

Example Response

Status code: 200

+

The list of organizations has been obtained.

+
{
+  "namespaces" : [ {
+    "id" : 1422,
+    "name" : "group",
+    "creator_name" : "username",
+    "auth" : 7
+  } ]
 }
-

Status Code

-

Status Code

+

Status Codes

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

Status Code

Description

+

Description

200

+

200

Query succeeded.

+

Organization list obtained.

400

+

400

Request error.

+

Request error.

401

+

401

Authentication failed.

+

Authentication failed.

404

+

404

The organization does not exist.

+

The organization was not found.

500

+

500

Internal error.

+

Internal error.

-

Error Codes

For details, see Error Codes.

+

Error Codes

For details, see Error Codes.

diff --git a/docs/swr/api-ref/swr_02_0029.html b/docs/swr/api-ref/swr_02_0029.html index 34430ca58..e99a4a96b 100644 --- a/docs/swr/api-ref/swr_02_0029.html +++ b/docs/swr/api-ref/swr_02_0029.html @@ -1,163 +1,165 @@ -

Querying the Details of an Organization

-

Function

Query the details of an organization by its name.

+

Querying Details About an Organization

+

Description

Query the details about an organization.

-

URI

GET /v2/manage/namespaces/{namespace}

-

For details about parameters, see Table 1.

+

Constraints

None

+
+

URI

GET /v2/manage/namespaces/{namespace}

-
Table 1 Parameter description

Parameter

+
- - - - - - -
Table 1 Path parameter

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.

-

Request Parameters

-
Table 2 Request header parameters

Parameter

+

Request Parameters

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

Content-Type

+

Content-Type

Yes

+

Yes

String

+

String

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

-

The default value is application/json.

+

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

+

Default value: application/json

X-Auth-Token

+

X-Auth-Token

Yes

+

Yes

String

+

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.

+

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

Status code: 200 -
Table 3 Response body parameter description

Parameter

+

Response Parameters

Status code: 200

+ +
- - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

Type

+

Type

Description

+

Description

id

+

id

Integer

+

Integer

Organization ID

+

id

name

+

name

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.

creator_name

+

creator_name

String

+

String

IAM username

+

IAM username.

auth

+

auth

Integer

+

Integer

User permission

-
  • 7: Manage
  • 3: Write
  • 1: Read
+

User permissions. 7: manage. 3: edit. 1: read.

+

Example Request

GET https://{endpoint}/v2/manage/namespaces/{namespace}
-

Example Request

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

Example Response

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

Example Response

Status code: 200

+

Query succeeded.

+
{
+  "id" : 1422,
+  "name" : "demo",
+  "creator_name" : "lgp",
+  "auth" : 7
 }
-

Status Code

-

Status Code

+

Status Codes

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

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.

+

Organization not found.

500

+

500

Internal error.

+

Internal error.

-

Error Codes

For details, see Error Codes.

+

Error Codes

For details, see Error Codes.

diff --git a/docs/swr/api-ref/swr_02_0030.html b/docs/swr/api-ref/swr_02_0030.html index e9e739653..7d70d751d 100644 --- a/docs/swr/api-ref/swr_02_0030.html +++ b/docs/swr/api-ref/swr_02_0030.html @@ -1,123 +1,123 @@ -

Creating an Image Repository

-

Function

Create an image repository in an organization.

+

Creating an Image Repository in an Organization

+

Description

Create an image repository in an organization.

-

URI

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

-

For details about parameters, see Table 1.

+

Constraints

None

+
+

URI

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

-
Table 1 Parameter description

Parameter

+
- - - - - - -
Table 1 Path parameter

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

namespace

+

namespace

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.

+

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. Regular expression: [a-z0-9]+(?:[._]|__|[-]*)

-

Request Parameters

-
Table 2 Request header parameters

Parameter

+

Request Parameters

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

Content-Type

+

Content-Type

Yes

+

Yes

String

+

String

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

-

The default value is application/json.

+

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

+

Default value: application/json

X-Auth-Token

+

X-Auth-Token

Yes

+

Yes

String

+

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.

+

User token.

+

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

-
Table 3 Request body parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

repository

+

repository

Yes

+

Yes

String

+

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.

+

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.

is_public

+

is_public

Yes

+

Yes

Boolean

+

Boolean

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

+

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.

category

+

category

No

+

No

String

+

String

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

+

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

description

+

description

No

+

No

String

+

String

Brief description of the image repository.

+

Brief description of the image repository.

-

Response Parameters

None

+

Response Parameters

None

-

Example Request

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

Example Request

POST https://{endpoint}/v2/manage/namespaces/{namespace}/repos
 
 {
   "repository" : "busybox",
@@ -126,50 +126,50 @@
   "is_public" : true
 }
-

Example Response

None

+

Example Response

None

-

Status Code

-

Status Code

+

Status Codes

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

Status Code

Description

+

Description

201

+

200

Creation successful.

+

Creation succeeded.

400

+

400

Request error. Error information is returned.

+

Request error.

401

+

401

Authentication failed.

+

Authentication failed.

409

+

409

The repository already exists.

+

The image repository exists.

500

+

500

Internal error. Error information is returned.

+

Internal error.

-

Error Codes

For details, see Error Codes.

+

Error Codes

For details, see Error Codes.

diff --git a/docs/swr/api-ref/swr_02_0031.html b/docs/swr/api-ref/swr_02_0031.html index a7214a17d..3c9f5b6a5 100644 --- a/docs/swr/api-ref/swr_02_0031.html +++ b/docs/swr/api-ref/swr_02_0031.html @@ -1,131 +1,127 @@ -

Deleting an Image Repository

-

Function

Delete an image repository in an organization.

+

Deleting an Image Repository from an Organization

+

Description

Delete an image repository in an organization.

-

URI

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

-

For details about parameters, see Table 1.

+

Constraints

None

+
+

URI

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

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

+

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 Parameters

-
Table 2 Request header parameters

Parameter

+

Request Parameters

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

Content-Type

+

Content-Type

Yes

+

Yes

String

+

String

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

-

The default value is application/json.

+

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

+

Default value: application/json

X-Auth-Token

+

X-Auth-Token

Yes

+

Yes

String

+

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.

+

User token.

+

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

-

Response Parameters

None

+

Response Parameters

None

-

Example Request

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

Example Request

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

Example Response

None

+

Example Response

None

-

Status Code

-

Status Code

+

Status Codes

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

Status Code

Description

+

Description

204

+

204

The brief information about the image repository is successfully deleted.

+

Image repository deleted.

400

+

400

Request error. Error information is returned.

+

Request error.

401

+

401

Authentication failed.

+

Authentication failed.

404

+

404

The repository does not exist.

+

The image repository was not found

406

+

500

The repository cannot be deleted because it contains images.

-

500

-

Internal error. Error information is returned.

+

Internal error.

-

Error Codes

For details, see Error Codes.

+

Error Codes

For details, see Error Codes.

diff --git a/docs/swr/api-ref/swr_02_0032.html b/docs/swr/api-ref/swr_02_0032.html index 85d717bf0..f9cb8d231 100644 --- a/docs/swr/api-ref/swr_02_0032.html +++ b/docs/swr/api-ref/swr_02_0032.html @@ -1,122 +1,123 @@

Updating the Brief Information on an Image Repository

-

Function

Update the brief information on an image repository in an organization, including the category, is_public, and description.

+

Description

Update the brief information on an image in an organization of a tenant, including the category, is_public, and description.

-

URI

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

-

For details about parameters, see Table 1.

+

Constraints

None

+
+

URI

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

-
Table 1 Path parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

namespace

+

namespace

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.

+

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

+

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 Parameters

-
Table 2 Request header parameters

Parameter

+

Request Parameters

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

Content-Type

+

Content-Type

Yes

+

Yes

String

+

String

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

-

The default value is application/json.

+

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

+

Default value: application/json

X-Auth-Token

+

X-Auth-Token

Yes

+

Yes

String

+

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.

+

User token.

+

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

-
Table 3 Request body parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

is_public

+

is_public

Yes

+

Yes

Boolean

+

Boolean

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

+

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.

category

+

category

No

+

No

String

+

String

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

+

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

description

+

description

No

+

No

String

+

String

Brief description of the image repository.

+

Brief description of the image repository.

-

Response Parameters

None

+

Response Parameters

None

-

Example Request

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

Example Request

PATCH https://{endpoint}/v2/manage/namespaces/{namespace}/repos/{repository}
 
 {
   "category" : "database",
@@ -124,50 +125,50 @@
   "is_public" : false
 }
-

Example Response

None

+

Example Response

None

-

Status Code

-

Status Code

+

Status Codes

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

Status Code

Description

+

Description

201

+

201

The brief information about the image repository is successfully updated.

+

Brief information about the image repository updated.

400

+

400

Request error. Error information is returned.

+

Request error.

401

+

401

Authentication failed.

+

Authentication failed.

404

+

404

The repository does not exist.

+

The image repository was not found

500

+

500

Internal error. Error information is returned.

+

Internal error.

-

Error Codes

For details, see Error Codes.

+

Error Codes

For details, see Error Codes.

diff --git a/docs/swr/api-ref/swr_02_0033.html b/docs/swr/api-ref/swr_02_0033.html index 1aef3f6ac..78282cdf1 100644 --- a/docs/swr/api-ref/swr_02_0033.html +++ b/docs/swr/api-ref/swr_02_0033.html @@ -1,249 +1,286 @@

Querying the Brief Information on an Image Repository

-

Function

Query the brief information on an image repository in an organization.

+

Description

Query the brief information on an image repository.

-

URI

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

-

For details about parameters, see Table 1.

+

Constraints

None

+
+

URI

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

-
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

+

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
    GET https://{Endpoint}/v2/manage/namespaces/group/repos/busybox
    -
-
-

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

    Image repository ID.

    +

    String

    +

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

    +

    Default value: application/json

    ns_id

    +

    X-Auth-Token

    Integer

    +

    Yes

    Organization ID.

    +

    String

    name

    -

    String

    -

    Image repository name.

    -

    category

    -

    String

    -

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

    -

    description

    -

    String

    -

    Brief description of the image repository.

    -

    creator_id

    -

    String

    -

    Image repository creator ID.

    -

    creator_name

    -

    String

    -

    Image repository creator.

    -

    size

    -

    Integer

    -

    Image repository size.

    -

    is_public

    -

    Boolean

    -

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

    -

    num_images

    -

    Integer

    -

    Number of images in an image repository.

    -

    num_download

    -

    Integer

    -

    Download times of an image repository.

    -

    url

    -

    String

    -

    URL of the image repository logo image. This field has been discarded and is left empty by default.

    -

    path

    -

    String

    -

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

    -

    internal_path

    -

    String

    -

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

    -

    created

    -

    String

    -

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

    -

    updated

    -

    String

    -

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

    -

    domain_id

    -

    String

    -

    Account ID.

    -

    priority

    -

    Integer

    -

    Image sorting priority.

    +

    User token.

    +

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

    -
  • Example response
    {
    -    "id": 865151,
    -    "ns_id": 1334795,
    -    "name": "busybox",
    -    "category": "other",
    -    "description": "containerops",
    -    "creator_id": "050b12577f00269a1fcfc01f65239697",
    -    "creator_name": "admin",
    -    "size": 2099575,
    -    "is_public": false,
    -    "num_images": 1,
    -    "num_download": 0,
    -    "url": "",
    -    "path": "{Repository address}/group/busybox",
    -    "internal_path": "{Repository address}/group/busybox",
    -    "created": "2021-06-02T09:59:25.51307Z",
    -    "updated": "2021-06-02T17:59:25.538056Z",
    -    "domain_id": "da44776c316c4a99b3683bb174f8821b", 
    -    "priority": 0
    +
  • +

    Response Parameters

    Status code: 200

    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 Response body parameters

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    Long

    +

    Repository ID.

    +

    ns_id

    +

    Long

    +

    Organization ID.

    +

    name

    +

    String

    +

    Repository name.

    +

    category

    +

    String

    +

    Repository type.

    +

    description

    +

    String

    +

    Repository description.

    +

    creator_id

    +

    String

    +

    Repository creator ID.

    +

    creator_name

    +

    String

    +

    Repository creator.

    +

    size

    +

    Long

    +

    Repository size.

    +

    is_public

    +

    Boolean

    +

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

    +

    num_images

    +

    Long

    +

    Number of images in a repository, ranging from 0 to 9,223,372,036,854,775,807.

    +

    num_download

    +

    Long

    +

    The number of downloads.

    +

    url

    +

    String

    +

    URL of the repository logo (not in use).

    +

    path

    +

    String

    +

    External image pull address, for example, swr.{region}.mycloud.com/namespace/repository.

    +

    internal_path

    +

    String

    +

    Internal image pull address, for example, 10.125.0.198:20202/namespace/repository.

    +

    created

    +

    String

    +

    Time when a repository was created. It is the UTC standard time. Users need to calculate the offset based on the local time, for example, UTC+8:00 for the East 8th Time Zone.

    +

    updated

    +

    String

    +

    Time when a repository was updated. It is the UTC standard time. Users need to calculate the offset based on the local time, for example, UTC+8:00 for the East 8th Time Zone.

    +

    domain_id

    +

    String

    +

    Account ID.

    +

    priority

    +

    Integer

    +

    Image sorting priority.

    +
    +
    +
    +

    Example Request

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

    Example Response

    Status code: 200

    +

    Request succeeded.

    +
    {
    +  "id" : 0,
    +  "ns_id" : 0,
    +  "name" : "busybox",
    +  "category" : "other",
    +  "description" : "containerops",
    +  "creator_id" : "1",
    +  "creator_name" : "admin",
    +  "size" : 2099575,
    +  "is_public" : false,
    +  "num_images" : 0,
    +  "num_download" : 0,
    +  "url" : "",
    +  "path" : "swr.***.mycloud.com/namespace/repository",
    +  "internal_path" : "10.125.0.198:20202/namespace/repository",
    +  "created" : "2017-08-17T12:00:03.915153267Z",
    +  "updated" : "2017-08-17T12:00:03.915153267Z",
    +  "domain_id" : "da44776c316c4a99b3683bb174f8821b",
    +  "priority" : 0
     }
    -
    -

    Status Code

    -

    Status Code

    +

    Status Codes

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

    Status Code

    Description

    +

    Description

    200

    +

    200

    Request successful.

    +

    Request succeeded.

    400

    +

    400

    Request error. Error information is returned.

    +

    Request error.

    401

    +

    401

    Authentication failed.

    +

    Authentication failed.

    404

    +

    404

    The repository does not exist.

    +

    The image repository was not found

    500

    +

    500

    Internal error. Error information is returned.

    +

    Internal error.

    -

    Error Codes

    For details, see Error Codes.

    +

    Error Codes

    For details, see Error Codes.

    diff --git a/docs/swr/api-ref/swr_02_0034.html b/docs/swr/api-ref/swr_02_0034.html index 68320beb2..cd8b3155c 100644 --- a/docs/swr/api-ref/swr_02_0034.html +++ b/docs/swr/api-ref/swr_02_0034.html @@ -1,352 +1,388 @@ -

    Querying the Image Repository List

    -

    Function

    Query the image repository list.

    +

    Querying Image Repositories

    +

    Description

    Query image repositories.

    -

    URI

    GET /v2/manage/repos

    +

    Constraints

    None

    +
    +

    URI

    GET /v2/manage/repos

    -
    Table 1 Query parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    namespace

    +

    namespace

    No

    +

    No

    String

    +

    String

    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.

    +

    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.

    name

    +

    name

    No

    +

    No

    String

    +

    String

    Image repository name.

    +

    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.

    category

    +

    category

    No

    +

    No

    String

    +

    String

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

    +

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

    limit

    +

    limit

    No

    +

    No

    String

    +

    String

    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.

    +

    Number of returned records. Parameters offset and limit should always be used together. If this parameter is not specified, 100 records are returned by default. The maximum number of records that can be returned is 1,000.

    offset

    +

    offset

    No

    +

    No

    String

    +

    String

    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.

    +

    Start index. The value must be 0 or a positive number. If this parameter is not specified, the start index is 0 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). Parameters order_column and order_type should always be used together.

    +

    Sorting by column. You can set this parameter to updated_time (update time), name, tag_count (number of tags), namespace (organization), or is_public (public or private). 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) or asc (ascending sort). Parameters order_column and order_type should always be used together.

    +

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

    filter

    +

    is_public

    No

    +

    No

    String

    +

    String

    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.

    +

    Whether a repository is public or private. true indicates public and false indicates private.

    +

    filter

    +

    No

    +

    String

    +

    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, windows, arm, or other.

    +

    is_public: whether images in the repository are public or private. true indicates public and false indicates private.

    +

    limit: number of returned records. offset: the start index. Parameters offset and limit should always be used together.

    +

    order_column: sorting by column. You can set this parameter to updated_time (update time), name, tag_count (number of tags), namespace (organization), or is_public (public or private).

    +

    order_type: sorting order. The value can be desc (descending order) or asc (ascending order). Parameters order_column and order_type should always be used together.

    -

    Request

    • Request parameters

      N/A

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

    Response

    • Response parameters -
      Table 2 Response header parameter description

      Parameter

      +

      Request Parameters

      +
      - - + - - - + + + + + +
      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.

      +

      Default value: application/json

      +

      X-Auth-Token

      +

      Yes

      +

      String

      +

      User token.

      +

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

      -

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

      -
      +
      +

      Response Parameters

      Status code: 200

      -
      Table 3 Response body parameter description

      Parameter

      +
      - - - - -
      Table 3 Response header parameter

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      [Array element]

      +

      Content-Range

      Array of objects

      +

      String

      Image repository list.

      +

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

      -
      Table 4 [Array element] parameters description

      Parameter

      +
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Table 4 Response body parameter

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      name

      +

      [items]

      String

      +

      Array of ShowReposResp objects

      Image repository name.

      -

      category

      -

      String

      -

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

      -

      description

      -

      String

      -

      Image repository description.

      -

      size

      -

      Integer

      -

      Total size of the images in an image repository.

      -

      is_public

      -

      Boolean

      -

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

      -

      num_images

      -

      Integer

      -

      Number of image tags in an image repository.

      -

      num_download

      -

      Integer

      -

      Download times.

      -

      created_at

      -

      String

      -

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

      -

      updated_at

      -

      String

      -

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

      -

      logo

      -

      String

      -

      (Reserved field) Image repository logo address.

      -

      url

      -

      String

      -

      (Reserved field) URL of the image repository logo.

      -

      path

      -

      String

      -

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

      -

      internal_path

      -

      String

      -

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

      -

      domain_name

      -

      String

      -

      Domain name.

      -

      namespace

      -

      String

      -

      Organization name.

      -

      tags

      -

      Array of strings

      -

      Image tag list.

      -

      status

      -

      Boolean

      -

      (Reserved field) Status.

      -

      total_range

      -

      Integer

      -

      Total number of records.

      +

      Request succeeded.

      -
    • Example response
      [
      -    {
      -        "name": "busybox",
      -        "category": "linux",
      -        "description": "this is a busybox repository",
      -        "size": 200977474,
      -        "is_public": false,
      -        "num_images": 2,
      -        "num_download": 0,
      -        "created_at": "2021-06-10T03:24:44.784402Z",
      -        "updated_at": "2021-06-10T03:40:59.199352Z",
      -        "logo": "",
      -        "url": "",
      -        "path": "{Repository address}/group/busybox",
      -        "internal_path": "{Repository address}/group/busybox",
      -        "domain_name": "root",
      -        "namespace": "group",
      -        "tags": [
      -            "latest",
      -            "log"
      -        ],
      -        "status": false,
      -        "total_range": 1
      -    }
      -]
      -
    • - -

      Status Code

      -

      Status Code

      + +
      - + - - + - - + - - + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Table 5 ShowReposResp

      Parameter

      Description

      +

      Type

      +

      Description

      200

      +

      name

      Request successful.

      +

      String

      +

      Repository name.

      400

      +

      category

      Request error. Error information is returned.

      +

      String

      +

      Repository type. (Each image has multiple labels.)

      401

      +

      description

      Authentication failed.

      +

      String

      +

      Repository description.

      500

      +

      size

      Internal error. Error information is returned.

      +

      Long

      +

      Repository size.

      +

      is_public

      +

      Boolean

      +

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

      +

      num_images

      +

      Long

      +

      Number of images in a repository, ranging from 0 to 9,223,372,036,854,775,807.

      +

      num_download

      +

      Long

      +

      The number of downloads.

      +

      created_at

      +

      String

      +

      Time when a repository was created. It is the UTC standard time. Users need to calculate the offset based on the local time, for example, UTC+8:00 for the East 8th Time Zone.

      +

      updated_at

      +

      String

      +

      Time when a repository was updated. It is the UTC standard time. Users need to calculate the offset based on the local time, for example, UTC+8:00 for the East 8th Time Zone.

      +

      logo

      +

      String

      +

      Repository logo address (not in use).

      +

      url

      +

      String

      +

      URL of the repository logo (not in use).

      +

      path

      +

      String

      +

      External image pull address, for example, swr.{region}.mycloud.com/namespace/repository.

      +

      internal_path

      +

      String

      +

      Internal image pull address, for example, 10.125.0.198:20202/namespace/repository.

      +

      domain_name

      +

      String

      +

      Tenant name.

      +

      namespace

      +

      String

      +

      Tenant organization.

      +

      tags

      +

      Array of strings

      +

      Image tag list.

      +

      status

      +

      Boolean

      +

      Query images shared by others: specifies whether the shared images have expired. Query images shared by yourself: The default value is false, which is meaningless.

      +

      total_range

      +

      Long

      +

      Total number of records.

      -

      Error Codes

      For details, see Error Codes.

      +

      Example Request

      GET https://{endpoint}/v2/manage/repos
      +
      +

      Example Response

      Status code: 200

      +

      Request succeeded.

      +
      [ {
      +  "name" : "nginx",
      +  "category" : "linux",
      +  "size" : 200977474,
      +  "is_public" : false,
      +  "num_images" : 2,
      +  "num_download" : 0,
      +  "created_at" : "2017-01-01T00:00:00Z",
      +  "updated_at" : "2017-09-11T03:00:02.542841141Z",
      +  "url" : "",
      +  "path" : "swr.***.mycloud.com/namespace/repository",
      +  "internal_path" : "10.125.0.198:20202/namespace/repository",
      +  "domain_name" : "root",
      +  "namespace" : "root",
      +  "tags" : [ "latest", "log" ],
      +  "status" : false,
      +  "total_range" : 4
      +} ]
      +
      +

      Status Codes

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

      Status Code

      +

      Description

      +

      200

      +

      Request succeeded.

      +

      400

      +

      Request error.

      +

      401

      +

      Authentication failed.

      +

      500

      +

      Internal error.

      +
      +
      +
      +

      Error Codes

      For details, see Error Codes.

      diff --git a/docs/swr/api-ref/swr_02_0035.html b/docs/swr/api-ref/swr_02_0035.html index 719d6b1c9..3a3bd373a 100644 --- a/docs/swr/api-ref/swr_02_0035.html +++ b/docs/swr/api-ref/swr_02_0035.html @@ -1,378 +1,386 @@ -

      Querying the List of Image Repository Tags

      -

      Function

      Query all image tags of an image repository.

      +

      Querying Image Tags

      +

      Description

      Query image tags.

      -

      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.

      +

      Constraints

      None

      +
      +

      URI

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

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

      +

      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.

      -
      Table 2 Query parameters

      Parameter

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

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      limit

      +

      limit

      No

      +

      No

      String

      +

      String

      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.

      +

      Number of returned records. Parameters offset and limit should always be used together. If this parameter is not specified, 100 records are returned by default. The maximum number of records that can be returned is 1,000.

      offset

      +

      offset

      No

      +

      No

      String

      +

      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.

      +

      Start index. The value must be 0 or a positive number. 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). Parameters order_column and order_type should always be used together.

      +

      Sorting by column. You can set this parameter to updated_at (sorting by update time) or tag (sorting by tag). 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) or asc (ascending sort). Parameters order_column and order_type should always be used together.

      +

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

      tag

      +

      tag

      No

      +

      No

      String

      +

      String

      Image tag name.

      +

      Image tag name.

      filter

      +

      filter

      No

      +

      No

      String

      +

      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.

      +

      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. The value can be updated_at (sorting by update time) or tag (sorting by tag). order_type indicates the sorting order. The value can be desc (descending order) or asc (ascending order). tag indicates the image tag name.

      -

      Request

      • Request parameters -
        Table 3 Request header parameters

        Parameter

        +

        Request Parameters

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

        Parameter

        Mandatory

        +

        Mandatory

        Type

        +

        Type

        Description

        +

        Description

        Content-Type

        +

        Content-Type

        Yes

        +

        Yes

        String

        +

        String

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

        -

        The default value is application/json.

        +

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

        +

        Default value: application/json

        X-Auth-Token

        +

        X-Auth-Token

        Yes

        +

        Yes

        String

        +

        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.

        +

        User token.

        +

        The token can be obtained through 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
        GET https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/tags
        -
      • -

        Response

        • Response parameters

          Status code: 200

          +

          Response Parameters

          Status code: 200

          -
          Table 4 Response header parameters

          Parameter

          +
          - - - - -
          Table 4 Response header parameter

          Parameter

          Type

          +

          Type

          Description

          +

          Description

          Content-Range

          +

          Content-Range

          String

          +

          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)

          -
          Table 5 Response body parameters

          Parameter

          +
          - - - - -
          Table 5 Response body parameter

          Parameter

          Type

          +

          Type

          Description

          +

          Description

          [Array]

          +

          [items]

          Array of ShowReposTagResp objects

          +

          Array of ShowReposTagResp objects

          Image tags.

          +

          Image tag list.

          -
          Table 6 [Array element] parameters description

          Parameter

          +
          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          Table 6 ShowReposTagResp

          Parameter

          Type

          +

          Type

          Description

          +

          Description

          id

          +

          id

          Integer

          +

          Long

          ID

          +

          Tag ID.

          repo_id

          +

          repo_id

          Integer

          +

          Long

          Repository ID.

          +

          Repository ID.

          Tag

          +

          Tag

          String

          +

          String

          Image tag name.

          +

          Image tag name.

          image_id

          +

          image_id

          String

          +

          String

          Image ID.

          +

          Image ID.

          manifest

          +

          manifest

          String

          +

          String

          Image manifest.

          +

          Image manifest.

          digest

          +

          digest

          String

          +

          String

          SHA value of an image.

          +

          Hash value of an image.

          schema

          +

          schema

          Integer

          +

          Long

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

          +

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

          path

          +

          path

          String

          +

          String

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

          +

          External image pull address, for example, swr.{region}.mycloud.com/namespace/repository:tag.

          internal_path

          +

          internal_path

          String

          +

          String

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

          +

          Internal image pull address, for example, 10.125.0.198:20202/namespace/repository:tag.

          size

          +

          size

          Integer

          +

          Long

          Image size.

          -

          Value range: 0 to 9223372036854775807

          -

          Unit: byte

          +

          Image size, ranging from 0 to 9,223,372,036,854,775,807.

          is_trusted

          +

          is_trusted

          Boolean

          +

          Boolean

          By default, the value is false.

          +

          By default, the value is false.

          +

          Default value: false

          created

          +

          created

          String

          +

          String

          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.

          +

          Time when the image was created. It is the UTC standard time. Users need to calculate the offset based on the local time, for example, UTC+8:00 for the East 8th Time Zone.

          updated

          +

          updated

          String

          +

          String

          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.

          +

          Time when an image was updated. It is the UTC standard time. Users need to calculate the offset based on the local time, for example, UTC+8:00 for the East 8th Time Zone.

          deleted

          +

          deleted

          String

          +

          String

          Time when an image was deleted.

          +

          Time when an image is deleted. It is the UTC standard time. Users need to calculate the offset based on the local time, for example, UTC+8:00 for the East 8th Time Zone.

          domain_id

          +

          domain_id

          String

          +

          String

          Account ID.

          +

          Account ID.

          tag_type

          +

          scanned

          Integer

          +

          Boolean

          0: manifest. 1: manifest list.

          +

          Whether the image has been scanned.

          -
          -
        • Example response
          [
          -    {
          -        "id": 0,
          -        "repo_id": 0,
          -        "Tag": "latest",
          -        "image_id": "741f24a795d6d93d7c6edd11780d63c13e16c39615dd9d223378a57a836f2ee6",
          -        "manifest": "{\"schemaVersion\":2,\"mediaType\":\"application/vnd.docker.distribution.manifest.v2+json\",\"config\":{\"mediaType\":\"application/vnd.docker.container.image.v1+json\",\"size\":1862,\"digest\":\"sha256:741f24a795d6d93d7c6edd11780d63c13e16c39615dd9d223378a57a836f2ee6\"},\"layers\":[{\"mediaType\":\"application/vnd.docker.image.rootfs.diff.tar.gzip\",\"size\":1292800,\"digest\":\"sha256:8ac8bfaff55af948c796026ee867448c5b5b5d9dd3549f4006d9759b25d4a893\"},{\"mediaType\":\"application/vnd.docker.image.rootfs.diff.tar.gzip\",\"size\":10240,\"digest\":\"sha256:77ddbf3a9fe11e81761a0f9df43a28e3e6f29bbb53c0c8cf71cd7efa69729aed\"}]}",
          -        "digest": "sha256:57b605845a6367c34bfb6ea6477f16852f59aa1861a2b51d10ab77ae0a1dc9c3",
          -        "schema": 2,
          -        "path": "{Repository address}/group/busybox:latest",
          -        "internal_path": "10.125.0.198:20202/namespace/busybox:latest",
          -        "size": 1304902,
          -        "is_trusted": false,
          -        "created": "2018-07-06T06:18:55Z",
          -        "updated": "2018-07-06T06:18:55Z",
          -        "deleted": null,
          -        "domain_id": "0503dda878000fed0f75c0096d70a960",
          -        "tag_type": 0
          -    }
          -]
          -
        • - -

          Status Code

          -
          - - - - - - - - - - - - - - - - -

          Status Code

          -

          Description

          -

          200

          +

          tag_type

          All tags in the image repository are successfully queried.

          +

          Long

          400

          -

          Request error. Error information is returned.

          -

          401

          -

          Authentication failed.

          -

          404

          -

          The repository does not exist.

          -

          500

          -

          Internal error. Error information is returned.

          +

          0: manifest; 1: manifest list.

          -

          Error Codes

          For details, see Error Codes.

          +

          Example Request

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

          Example Response

          Status code: 200

          +

          The list of image tags is queried successfully.

          +
          [ {
          +  "id" : 0,
          +  "repo_id" : 0,
          +  "Tag" : "latest",
          +  "image_id" : "741f24a795d6d93d7c6edd11780d63c13e16c39615dd9d223378a57a836f2ee6",
          +  "manifest" : "{\"schemaVersion\":2,\"mediaType\":\"application/vnd.docker.distribution.manifest.v2+json\",\"config\":{\"mediaType\":\"application/vnd.docker.container.image.v1+json\",\"size\":1862,\"digest\":\"sha256:741f24a795d6d93d7c6edd11780d63c13e16c39615dd9d223378a57a836f2ee6\"},\"layers\":[{\"mediaType\":\"application/vnd.docker.image.rootfs.diff.tar.gzip\",\"size\":1292800,\"digest\":\"sha256:8ac8bfaff55af948c796026ee867448c5b5b5d9dd3549f4006d9759b25d4a893\"},{\"mediaType\":\"application/vnd.docker.image.rootfs.diff.tar.gzip\",\"size\":10240,\"digest\":\"sha256:77ddbf3a9fe11e81761a0f9df43a28e3e6f29bbb53c0c8cf71cd7efa69729aed\"}]}",
          +  "digest" : "sha256:57b605845a6367c34bfb6ea6477f16852f59aa1861a2b51d10ab77ae0a1dc9c3",
          +  "schema" : 2,
          +  "path" : "swr.***.mycloud.com/namespace/busybox:latest",
          +  "internal_path" : "10.125.0.198:20202/namespace/busybox:latest",
          +  "size" : 1304902,
          +  "is_trusted" : false,
          +  "created" : "2018-07-06T06:18:55Z",
          +  "updated" : "2018-07-06T06:18:55Z",
          +  "deleted" : null,
          +  "domain_id" : "050*****************6d70a960",
          +  "scanned" : false,
          +  "tag_type" : 0
          +} ]
          +
          +

          Status Codes

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

          Status Code

          +

          Description

          +

          200

          +

          Image tag list queried.

          +

          400

          +

          Request error.

          +

          401

          +

          Authentication failed.

          +

          404

          +

          The image repository was not found.

          +

          500

          +

          Internal error.

          +
          +
          +
          +

          Error Codes

          For details, see Error Codes.

          diff --git a/docs/swr/api-ref/swr_02_0036.html b/docs/swr/api-ref/swr_02_0036.html index 6b2f86fe3..cc54ab81d 100644 --- a/docs/swr/api-ref/swr_02_0036.html +++ b/docs/swr/api-ref/swr_02_0036.html @@ -1,133 +1,136 @@ -

          Deleting the Image with a Specified Tag

          -

          Function

          Delete the image with a specified tag in an image repository.

          +

          Deleting an Image with a Specified Tag

          +

          Description

          Delete an image with a specified tag.

          -

          URI

          DELETE /v2/manage/namespaces/{namespace}/repos/{repository}/tags/{tag}

          -

          For details about parameters, see Table 1.

          +

          Constraints

          None

          +
          +

          URI

          DELETE /v2/manage/namespaces/{namespace}/repos/{repository}/tags/{tag}

          -
          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

          +

          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.

          tag

          +

          tag

          Yes

          +

          Yes

          String

          +

          String

          Image tag name

          +

          Image tag name.

          -

          Request

          • Request parameters -
            Table 2 Request header parameters

            Parameter

            +

            Request Parameters

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

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            Content-Type

            +

            Content-Type

            Yes

            +

            Yes

            String

            +

            String

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

            -

            The default value is application/json.

            +

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

            +

            Default value: application/json

            X-Auth-Token

            +

            X-Auth-Token

            Yes

            +

            Yes

            String

            +

            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
            -
          • -
            -

            Response

            N/A

            -
            -

            Status Code

            -
            - - - - - - - - - - - - - - - - -

            Status Code

            -

            Description

            -

            204

            -

            The image with a specified tag is deleted successfully.

            -

            400

            -

            Request error. Error information is returned.

            -

            401

            -

            Authentication failed.

            -

            404

            -

            The repository or the image with a specified tag does not exist.

            -

            500

            -

            Internal error. Error information is returned.

            +

            User token.

            +

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

            -

            Error Codes

            For details, see Error Codes.

            +

            Response Parameters

            None

            +
            +

            Example Request

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

            Example Response

            None

            +
            +

            Status Codes

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

            Status Code

            +

            Description

            +

            204

            +

            Image with a specified tag deleted.

            +

            400

            +

            Request error.

            +

            401

            +

            Authentication failed.

            +

            404

            +

            The image repository or the image of the specified tag was not found.

            +

            500

            +

            Internal error.

            +
            +
            +
            +

            Error Codes

            For details, see Error Codes.

            diff --git a/docs/swr/api-ref/swr_02_0037.html b/docs/swr/api-ref/swr_02_0037.html new file mode 100644 index 000000000..197cbeada --- /dev/null +++ b/docs/swr/api-ref/swr_02_0037.html @@ -0,0 +1,180 @@ + + +

            Querying Quotas

            +

            Description

            Query quota information.

            +
            +

            Constraints

            None

            +
            +

            URI

            GET /v2/manage/projects/{project_id}/quotas

            + +
            + + + + + + + + + + + +
            Table 1 Path parameter

            Parameter

            +

            Mandatory

            +

            Type

            +

            Description

            +

            project_id

            +

            Yes

            +

            String

            +

            Project ID.

            +
            +
            +
            +

            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.

            +

            Default value: 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 Parameters

            Status code: 200

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

            Parameter

            +

            Type

            +

            Description

            +

            quotas

            +

            Array of ShowQuota objects

            +

            List of quotas.

            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + + + +
            Table 4 ShowQuota

            Parameter

            +

            Type

            +

            Description

            +

            quota_limit

            +

            Integer

            +

            Quota limit.

            +

            quota_key

            +

            String

            +

            Quota type.

            +

            unit

            +

            String

            +

            Unit.

            +

            used

            +

            Integer

            +

            Used quota.

            +
            +
            +
            +

            Example Request

            GET https://{endpoint}/v2/manage/projects/{project_id}/quotas
            +
            +

            Example Response

            Status code: 200

            +

            The quota information is returned successfully.

            +
            {
            +  "quotas" : [ {
            +    "quota_limit" : 15,
            +    "quota_key" : "namespace",
            +    "unit" : "",
            +    "used" : 1
            +  }
            + ]
            +}
            +
            +

            Status Codes

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

            Status Codes

            +

            Description

            +

            200

            +

            Succeeded.

            +

            400

            +

            Request error.

            +

            401

            +

            Authentication failed.

            +

            500

            +

            Internal error.

            +
            +
            +
            +
            +
            + +
            + diff --git a/docs/swr/api-ref/swr_02_0042.html b/docs/swr/api-ref/swr_02_0042.html index cd240c68f..993acfd13 100644 --- a/docs/swr/api-ref/swr_02_0042.html +++ b/docs/swr/api-ref/swr_02_0042.html @@ -1,195 +1,193 @@

            Creating Organization Permissions

            -

            Function

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

            +

            Description

            Create organization permissions.

            -

            Constraints

            None

            +

            Constraints

            None

            -

            URI

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

            -

            Table 1 describes the parameters.

            +

            URI

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

            -
            Table 1 Parameter description

            Parameter

            +
            - - - - - - -
            Table 1 Path parameter

            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.

            -

            Request

            • Request parameters -
              Table 2 Request header parameters

              Parameter

              +

              Request Parameters

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

              Parameter

              Mandatory

              +

              Mandatory

              Type

              +

              Type

              Description

              +

              Description

              Content-Type

              +

              Content-Type

              Yes

              +

              Yes

              String

              +

              String

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

              -

              The default value is application/json.

              +

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

              +

              Default value: application/json

              X-Auth-Token

              +

              X-Auth-Token

              Yes

              +

              Yes

              String

              +

              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.

              +

              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.

              -
              Table 3 Request body parameters

              Parameter

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

              Parameter

              Mandatory

              +

              Mandatory

              Type

              +

              Type

              Description

              +

              Description

              [Array element]

              +

              [items]

              Yes

              +

              Yes

              Array of objects

              +

              Array of UserAuth objects

              Information required for creating organization permissions.

              +

              Information required for creating organization permissions.

              -
              Table 4 [Array element]

              Parameter

              +
              - - - - - - - - - - - - - - -
              Table 4 UserAuth

              Parameter

              Mandatory

              +

              Mandatory

              Type

              +

              Type

              Description

              +

              Description

              user_id

              +

              user_id

              Yes

              +

              Yes

              String

              +

              String

              User ID. Obtain it from IAM.

              +

              User ID, which needs to be obtained from IAM.

              user_name

              +

              user_name

              Yes

              +

              Yes

              String

              +

              String

              Username. Obtain it from IAM.

              +

              Username, which needs to be obtained from IAM.

              auth

              +

              auth

              Yes

              +

              Yes

              Integer

              +

              Long

              User permission

              -
              • 7: Manage
              • 3: Write
              • 1: Read
              +

              User permissions. 7: manage. 3: edit. 1: read.

              -
            • Example request
              POST https://{endpoint}/v2/manage/namespaces/{namespace}/access
              +
              +

              Response Parameters

              None

              +
              +

              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
                None
                -
              +

              Example Response

              None

              -

              Status Code

              -

              Status Code

              +

              Status Codes

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

              Status Code

              Description

              +

              Description

              201

              +

              200

              Creation successful.

              +

              Creation succeeded.

              400

              +

              400

              Request error.

              +

              Request error.

              401

              +

              401

              Authentication failed.

              +

              Authentication failed.

              404

              +

              404

              The organization does not exist.

              +

              The organization was not found.

              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.

              +

              Error Codes

              For details, see Error Codes.

              diff --git a/docs/swr/api-ref/swr_02_0043.html b/docs/swr/api-ref/swr_02_0043.html index a4d443e7b..1801d3d4c 100644 --- a/docs/swr/api-ref/swr_02_0043.html +++ b/docs/swr/api-ref/swr_02_0043.html @@ -1,140 +1,143 @@ -

              Deleting Organization Permissions

              -

              Function

              Delete the organization operation permissions of certain users.

              +

              Canceling Organization Permissions

              +

              Description

              Cancel the organization operation permissions of certain users.

              -

              URI

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

              -

              Table 1 describes the parameters.

              +

              Constraints

              None

              +
              +

              URI

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

              -
              Table 1 Parameter description

              Parameter

              +
              - - - - - - -
              Table 1 Path parameter

              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.

              -

              Request

              • Request parameters -
                Table 2 Request header parameters

                Parameter

                +

                Request Parameters

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

                Parameter

                Mandatory

                +

                Mandatory

                Type

                +

                Type

                Description

                +

                Description

                Content-Type

                +

                Content-Type

                Yes

                +

                Yes

                String

                +

                String

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

                -

                The default value is application/json.

                +

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

                +

                Default value: application/json

                X-Auth-Token

                +

                X-Auth-Token

                Yes

                +

                Yes

                String

                +

                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.

                +

                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.

                -
                Table 3 Request body parameter description

                Parameter

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

                Parameter

                Mandatory

                +

                Mandatory

                Type

                +

                Type

                Description

                +

                Description

                [Array element]

                +

                [items]

                Yes

                +

                Yes

                Array of strings

                +

                Array of strings

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

                +

                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
                +
                +

                Response Parameters

                None

                +
                +

                Example Request

                DELETE https://{endpoint}/v2/manage/namespaces/{namespace}/access
                 
                -["fb3f175c1fd146ab8cdae3272be6107b"]
                -
              • +[ "fb3f175c1fd146ab8cdae3272be6107b" ] -

                Response

                N/A

                +

                Example Response

                None

                -

                Status Code

                -

                Status Code

                +

                Status Codes

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

                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 organization does not exist.

                +

                The organization was not found.

                500

                +

                500

                Internal error.

                +

                Internal error.

                -

                Error Codes

                For details, see Error Codes.

                +

                Error Codes

                For details, see Error Codes.

                diff --git a/docs/swr/api-ref/swr_02_0044.html b/docs/swr/api-ref/swr_02_0044.html index 1a5a8ba32..73d54f0dd 100644 --- a/docs/swr/api-ref/swr_02_0044.html +++ b/docs/swr/api-ref/swr_02_0044.html @@ -1,188 +1,188 @@

                Updating Organization Permissions

                -

                Function

                Update the organization operation permissions for certain users.

                +

                Description

                Update the organization operation permissions of certain users.

                -

                URI

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

                -

                For details about parameters, see Table 1.

                +

                Constraints

                None

                +
                +

                URI

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

                -
                Table 1 Parameter description

                Parameter

                +
                - - - - - - -
                Table 1 Path parameter

                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.

                -

                Request

                • Request parameters -
                  Table 2 Request header parameters

                  Parameter

                  +

                  Request Parameters

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

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  Content-Type

                  +

                  Content-Type

                  Yes

                  +

                  Yes

                  String

                  +

                  String

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

                  -

                  The default value is application/json.

                  +

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

                  +

                  Default value: application/json

                  X-Auth-Token

                  +

                  X-Auth-Token

                  Yes

                  +

                  Yes

                  String

                  +

                  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.

                  +

                  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.

                  -
                  Table 3 Request body parameter description

                  Parameter

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

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  [Array element]

                  +

                  [items]

                  Yes

                  +

                  Yes

                  Array of objects

                  +

                  Array of UserAuth objects

                  Information required for updating organization permissions

                  +

                  Permissions required for updating organization permissions

                  -
                  Table 4 [Array element]

                  Parameter

                  +
                  - - - - - - - - - - - - - - -
                  Table 4 UserAuth

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  user_id

                  +

                  user_id

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  User ID. Obtain it from IAM.

                  +

                  User ID, which needs to be obtained from IAM.

                  user_name

                  +

                  user_name

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Username. Obtain it from IAM.

                  +

                  Username, which needs to be obtained from IAM.

                  auth

                  +

                  auth

                  Yes

                  +

                  Yes

                  Integer

                  +

                  Long

                  User permission

                  -
                  • 7: Manage
                  • 3: Write
                  • 1: Read
                  +

                  User permissions. 7: manage. 3: edit. 1: read.

                  -
                • Example request
                  PATCH https://{endpoint}/v2/manage/namespaces/{namespace}/access
                  +
                  +

                  Response Parameters

                  None

                  +
                  +

                  Example Request

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

                  Response

                  • Response parameters

                    N/A

                    -
                  • Example response
                    {}
                    -
                  +

                  Example Response

                  None

                  -

                  Status Code

                  -

                  Status Code

                  +

                  Status Codes

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

                  Status Code

                  Description

                  +

                  Description

                  201

                  +

                  201

                  Updated successfully.

                  +

                  Update succeeded.

                  400

                  +

                  400

                  Request error.

                  +

                  Request error.

                  401

                  +

                  401

                  Authentication failed.

                  +

                  Authentication failed.

                  404

                  +

                  404

                  The organization does not exist.

                  +

                  The organization was not found.

                  500

                  +

                  500

                  Internal error.

                  +

                  Internal error.

                  -

                  Error Codes

                  For details, see Error Codes.

                  +

                  Error Codes

                  For details, see Error Codes.

                  diff --git a/docs/swr/api-ref/swr_02_0045.html b/docs/swr/api-ref/swr_02_0045.html index e1a9b4fe3..a99fa2326 100644 --- a/docs/swr/api-ref/swr_02_0045.html +++ b/docs/swr/api-ref/swr_02_0045.html @@ -1,219 +1,214 @@

                  Querying Organization Permissions

                  -

                  Function

                  Query organization permissions.

                  +

                  Description

                  Query organization permissions.

                  -

                  URI

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

                  -

                  For details about parameters, see Table 1.

                  +

                  Constraints

                  None

                  +
                  +

                  URI

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

                  -
                  Table 1 Parameter description

                  Parameter

                  +
                  - - - - - - -
                  Table 1 Path parameter

                  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.

                  -

                  Request

                  • Request parameters -
                    Table 2 Request header parameters

                    Parameter

                    +

                    Request Parameters

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

                    Parameter

                    Mandatory

                    +

                    Mandatory

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    Content-Type

                    +

                    Content-Type

                    Yes

                    +

                    Yes

                    String

                    +

                    String

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

                    -

                    The default value is application/json.

                    +

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

                    +

                    Default value: application/json

                    X-Auth-Token

                    +

                    X-Auth-Token

                    Yes

                    +

                    Yes

                    String

                    +

                    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.

                    +

                    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/access
                    -
                  • -

                    Response

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

                      Parameter

                      +

                      Response Parameters

                      Status code: 200

                      + +
                      - - - - - - - - - - - - - - - - -
                      Table 3 Response body parameters

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      id

                      +

                      id

                      Integer

                      +

                      Integer

                      Permission ID.

                      +

                      Permission ID.

                      name

                      +

                      name

                      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.

                      creator_name

                      +

                      creator_name

                      String

                      +

                      String

                      Organization creator.

                      +

                      Organization creator.

                      self_auth

                      +

                      self_auth

                      Object

                      +

                      UserAuth object

                      Permissions of the current user.

                      +

                      Permissions of the current user.

                      others_auths

                      +

                      others_auths

                      Array of objects

                      +

                      Array of UserAuth objects

                      Permissions of other users.

                      +

                      Permissions of other users.

                      -
                      Table 4 self_auth parameter description

                      Parameter

                      +
                      - - - - - - - - - - -
                      Table 4 UserAuth

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      user_id

                      +

                      user_id

                      String

                      +

                      String

                      User ID.

                      +

                      User ID. Obtain it from IAM.

                      user_name

                      +

                      user_name

                      String

                      +

                      String

                      Username.

                      +

                      Username. Obtain it from IAM.

                      auth

                      +

                      auth

                      Integer

                      +

                      Long

                      User permission

                      -
                      • 7: Manage
                      • 3: Write
                      • 1: Read
                      +

                      User permissions. 7: manage. 3: edit. 1: read.

                      -
                    • Example response
                      {
                      -    "id": 1334795,
                      -    "name": "group",
                      -    "creator_name": "user",
                      -    "self_auth": {
                      -        "user_id": "050b12577f00269a1fcfc01f65239697",
                      -        "user_name": "user",
                      -        "auth": 7
                      -    },
                      -    "others_auths": [
                      -        {
                      -            "user_id": "06d89c3b6d800f2d1f28c01f0d882285",
                      -            "user_name": "user_01",
                      -            "auth": 1
                      -        },
                      -        {
                      -            "user_id": "050b12577f00269a1fcfc01f65239697",
                      -            "user_name": "user",
                      -            "auth": 7
                      -        }
                      -    ]
                      +

                      Example Request

                      GET https://{endpoint}/v2/manage/namespaces/{namespace}/access
                      +
                      +

                      Example Response

                      Status code: 200

                      +

                      Query succeeded.

                      +
                      {
                      +  "id" : 1422,
                      +  "name" : "test",
                      +  "creator_name" : "user01",
                      +  "self_auth" : {
                      +    "user_id" : "3059e6b5562241fda3fa441cca6f228b",
                      +    "user_name" : "user",
                      +    "auth" : 7
                      +  },
                      +  "others_auths" : [ {
                      +    "user_id" : "fb3f175c1fd146ab8cdae3272be6107b",
                      +    "user_name" : "user01",
                      +    "auth" : 7
                      +  } ]
                       }
                      -
                    • -

                      Status Code

                      -

                      Status Code

                      +

                      Status Codes

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

                      Status Code

                      Description

                      +

                      Description

                      200

                      +

                      200

                      Request successful.

                      +

                      Query succeeded.

                      400

                      +

                      400

                      Request error.

                      +

                      Request error.

                      401

                      +

                      401

                      Authentication failed.

                      +

                      Authentication failed.

                      404

                      +

                      404

                      The organization does not exist.

                      +

                      Organization not found.

                      500

                      +

                      500

                      Internal error.

                      +

                      Internal error.

                      -

                      Error Codes

                      For details, see Error Codes.

                      +

                      Error Codes

                      For details, see Error Codes.

                      diff --git a/docs/swr/api-ref/swr_02_0046.html b/docs/swr/api-ref/swr_02_0046.html index ed0a7f92b..7f6a41aa7 100644 --- a/docs/swr/api-ref/swr_02_0046.html +++ b/docs/swr/api-ref/swr_02_0046.html @@ -1,197 +1,197 @@ -

                      Creating Image Permissions

                      -

                      Function

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

                      +

                      Granting Image Permissions

                      +

                      Description

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

                      -

                      URI

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

                      -

                      For details about parameters, see Table 1.

                      +

                      Constraints

                      You can grant permissions to other users (excluding yourself) only when the organization permission is Edit or higher or the image repository permission is Manage.

                      +
                      +

                      URI

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

                      -
                      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 name.

                      +

                      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 -
                        Table 2 Request header parameters

                        Parameter

                        +

                        Request Parameters

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

                        Parameter

                        Mandatory

                        +

                        Mandatory

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        Content-Type

                        +

                        Content-Type

                        Yes

                        +

                        Yes

                        String

                        +

                        String

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

                        -

                        The default value is application/json.

                        +

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

                        +

                        Default value: application/json

                        X-Auth-Token

                        +

                        X-Auth-Token

                        Yes

                        +

                        Yes

                        String

                        +

                        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.

                        +

                        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.

                        -
                        Table 3 Request body parameter description

                        Parameter

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

                        Parameter

                        Mandatory

                        +

                        Mandatory

                        Type

                        +

                        Type

                        Description.

                        +

                        Description

                        [Array element]

                        +

                        [items]

                        Yes

                        +

                        Yes

                        Array of objects

                        +

                        Array of UserAuth objects

                        User list

                        +

                        Information required for creating image permissions.

                        -
                        Table 4 [Array element] parameters decription

                        Parameter

                        +
                        - - - - - - - - - - - - - - -
                        Table 4 UserAuth

                        Parameter

                        Mandatory

                        +

                        Mandatory

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        user_id

                        +

                        user_id

                        Yes

                        +

                        Yes

                        String

                        +

                        String

                        User ID.

                        +

                        User ID, which needs to be obtained from IAM.

                        user_name

                        +

                        user_name

                        Yes

                        +

                        Yes

                        String

                        +

                        String

                        Username.

                        +

                        Username, which needs to be obtained from IAM.

                        auth

                        +

                        auth

                        Yes

                        +

                        Yes

                        Integer

                        +

                        Long

                        User permission that is configured.

                        -
                        • 7: Manage
                        • 3: Write
                        • 1: Read
                        +

                        User permissions. 7: Manage. 3: Write. 1: Read.

                        -
                      • Example request
                        POST https://{endpoint}/v2/manage/namespaces/{namespace}/repos/{repository}/access
                        +
                        +

                        Response Parameters

                        None

                        +
                        +

                        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

                          None

                          -
                        +

                        Example Response

                        None

                        -

                        Status Code

                        -

                        Status Code

                        +

                        Status Codes

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

                        Status Code

                        Description

                        +

                        Description

                        201

                        +

                        201

                        Creation successful.

                        +

                        Request succeeded.

                        400

                        +

                        400

                        Request error.

                        +

                        Request error.

                        401

                        +

                        401

                        Authentication failed.

                        +

                        Authentication failed.

                        404

                        +

                        404

                        The image does not exist.

                        +

                        The image was not found.

                        500

                        +

                        500

                        Internal error.

                        +

                        Internal error.

                        -

                        Error Codes

                        For details, see Error Codes.

                        +

                        Error Codes

                        For details, see Error Codes.

                        diff --git a/docs/swr/api-ref/swr_02_0047.html b/docs/swr/api-ref/swr_02_0047.html index d5284f17d..ad9559075 100644 --- a/docs/swr/api-ref/swr_02_0047.html +++ b/docs/swr/api-ref/swr_02_0047.html @@ -1,151 +1,152 @@ -

                        Deleting Image Permissions

                        -

                        Function

                        Delete the image operation permissions of certain users.

                        +

                        Canceling Image Permissions

                        +

                        Description

                        Cancel the image operation permissions of certain users.

                        -

                        Constraints

                        None

                        +

                        Constraints

                        None

                        -

                        URI

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

                        -

                        For details about parameters, see Table 1.

                        +

                        URI

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

                        -
                        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 name.

                        +

                        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 -
                          Table 2 Request header parameters

                          Parameter

                          +

                          Request Parameters

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

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          +

                          Type

                          Description

                          +

                          Description

                          Content-Type

                          +

                          Content-Type

                          Yes

                          +

                          Yes

                          String

                          +

                          String

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

                          -

                          The default value is application/json.

                          +

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

                          +

                          Default value: application/json

                          X-Auth-Token

                          +

                          X-Auth-Token

                          Yes

                          +

                          Yes

                          String

                          +

                          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.

                          +

                          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.

                          -
                          Table 3 Request body parameter description

                          Parameter

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

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          +

                          Type

                          Description

                          +

                          Description

                          [Array element]

                          +

                          [items]

                          Yes

                          +

                          Yes

                          Array of strings

                          +

                          Array of strings

                          ID array of users whose permissions need to be deleted.

                          +

                          User ID, which needs to be obtained from IAM.

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

                          Response Parameters

                          None

                          +
                          +

                          Example Request

                          DELETE https://{endpoint}/v2/manage/namespaces/{namespace}/repos/{repository}/access
                           
                           [ "fb3f175c1fd146ab8cdae3272be6107b" ]
                          -
                        • -

                          Response

                          N/A

                          +

                          Example Response

                          None

                          -

                          Status Code

                          -

                          Status Code

                          +

                          Status Codes

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

                          Status Code

                          Description

                          +

                          Description

                          204

                          +

                          204

                          Deletion succeeded.

                          +

                          Request succeeded.

                          400

                          +

                          400

                          Request error.

                          +

                          Request error.

                          401

                          +

                          401

                          Authentication failed.

                          +

                          Authentication failed.

                          404

                          +

                          404

                          The image does not exist.

                          +

                          The image was not found.

                          500

                          +

                          500

                          Internal error.

                          +

                          Internal error.

                          -

                          Error Codes

                          For details, see Error Codes.

                          +

                          Error Codes

                          For details, see Error Codes.

                          diff --git a/docs/swr/api-ref/swr_02_0048.html b/docs/swr/api-ref/swr_02_0048.html index 7b03e1739..7cf8269e5 100644 --- a/docs/swr/api-ref/swr_02_0048.html +++ b/docs/swr/api-ref/swr_02_0048.html @@ -1,199 +1,197 @@

                          Updating Image Permissions

                          -

                          Function

                          Update the image operation permissions for certain users.

                          +

                          Description

                          Update image permissions.

                          -

                          Constraints

                          None

                          +

                          Constraints

                          None

                          -

                          URI

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

                          -

                          For details about parameters, see Table 1.

                          +

                          URI

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

                          -
                          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 name

                          +

                          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 -
                            Table 2 Request header parameters

                            Parameter

                            +

                            Request Parameters

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

                            Parameter

                            Mandatory

                            +

                            Mandatory

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            Content-Type

                            +

                            Content-Type

                            Yes

                            +

                            Yes

                            String

                            +

                            String

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

                            -

                            The default value is application/json.

                            +

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

                            +

                            Default value: application/json

                            X-Auth-Token

                            +

                            X-Auth-Token

                            Yes

                            +

                            Yes

                            String

                            +

                            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.

                            +

                            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.

                            -
                            Table 3 Request body parameter description

                            Parameter

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

                            Parameter

                            Mandatory

                            +

                            Mandatory

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            [Array element]

                            +

                            [items]

                            Yes

                            +

                            Yes

                            Array of objects

                            +

                            Array of UserAuth objects

                            Information about the image permission to be updated.

                            +

                            Information required for creating image permissions.

                            -
                            Table 4 [Array element] parameter description

                            Parameter

                            +
                            - - - - - - - - - - - - - - -
                            Table 4 UserAuth

                            Parameter

                            Mandatory

                            +

                            Mandatory

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            user_id

                            +

                            user_id

                            Yes

                            +

                            Yes

                            String

                            +

                            String

                            User ID. Obtain it from IAM.

                            +

                            User ID, which needs to be obtained from IAM.

                            user_name

                            +

                            user_name

                            Yes

                            +

                            Yes

                            String

                            +

                            String

                            Username. Obtain it from IAM.

                            +

                            Username, which needs to be obtained from IAM.

                            auth

                            +

                            auth

                            Yes

                            +

                            Yes

                            Integer

                            +

                            Long

                            User permission that is configured.

                            -
                            • 7: Manage
                            • 3: Write
                            • 1: Read
                            +

                            User permissions. 7: Manage. 3: Write. 1: Read.

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

                            Response Parameters

                            None

                            +
                            +

                            Example Request

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

                            Response

                            • Response parameters

                              N/A

                              -
                            • Example response

                              None

                              -
                            +

                            Example Response

                            None

                            -

                            Status Code

                            -

                            Status Code

                            +

                            Status Codes

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

                            Status Code

                            Description

                            +

                            Description

                            201

                            +

                            201

                            Updated successfully.

                            +

                            Update 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 was not found.

                            500

                            +

                            500

                            Internal error.

                            +

                            Internal error.

                            -

                            Error Codes

                            For details, see Error Codes.

                            +

                            Error Codes

                            For details, see Error Codes.

                            diff --git a/docs/swr/api-ref/swr_02_0049.html b/docs/swr/api-ref/swr_02_0049.html index b53ac7e30..e65339c16 100644 --- a/docs/swr/api-ref/swr_02_0049.html +++ b/docs/swr/api-ref/swr_02_0049.html @@ -1,250 +1,215 @@

                            Querying Image Permissions

                            -

                            Function

                            Query image permissions.

                            +

                            Description

                            Query image permissions.

                            -

                            Constraints

                            None

                            +

                            Constraints

                            None

                            -

                            URI

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

                            -

                            For details about parameters, see Table 1.

                            +

                            URI

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

                            -
                            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 name

                            +

                            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 -
                              Table 2 Request header parameters

                              Parameter

                              +

                              Request Parameters

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

                              Parameter

                              Mandatory

                              +

                              Mandatory

                              Type

                              +

                              Type

                              Description

                              +

                              Description

                              Content-Type

                              +

                              Content-Type

                              Yes

                              +

                              Yes

                              String

                              +

                              String

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

                              -

                              The default value is application/json.

                              +

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

                              +

                              Default value: application/json

                              X-Auth-Token

                              +

                              X-Auth-Token

                              Yes

                              +

                              Yes

                              String

                              +

                              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.

                              +

                              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
                              GET https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/access
                              -
                            • -

                              Response

                              • Response parameters -
                                Table 3 Response body parameter description

                                Parameter

                                +

                                Response Parameters

                                Status code: 200

                                + +
                                - - - - - - - - - - - - - -
                                Table 3 Response body parameters

                                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

                                +

                                UserAuth object

                                Permissions of the current user.

                                +

                                Permissions of the current user.

                                others_auths

                                +

                                others_auths

                                Array of objects

                                +

                                Array of UserAuth objects

                                Permissions of other users.

                                +

                                Permissions of other users.

                                -
                                Table 4 self_auth parameter description

                                Parameter

                                +
                                - - - - - - - - - - -
                                Table 4 UserAuth

                                Parameter

                                Type

                                +

                                Type

                                Description

                                +

                                Description

                                user_id

                                +

                                user_id

                                String

                                +

                                String

                                User ID

                                +

                                User ID, which needs to be obtained from IAM.

                                user_name

                                +

                                user_name

                                String

                                +

                                String

                                Username

                                +

                                Username, which needs to be obtained from IAM.

                                auth

                                +

                                auth

                                Integer

                                +

                                Long

                                User permission

                                -
                                • 7: Manage
                                • 3: Write
                                • 1: Read
                                +

                                User permissions. 7: Manage. 3: Write. 1: Read.

                                - -
                                - - - - - - - - - - - - - - - - - -
                                Table 5 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": 1422,
                                -    "name": "busybox",
                                -    "self_auth": {
                                -        "user_id": "3059e6b5562241fda3fa441cca6f228b",
                                -        "user_name": "admin",
                                -        "auth": 7
                                -    },
                                -    "others_auths": [
                                -        {
                                -            "user_id": "fb3f175c1fd146ab8cdae3272be6107b",
                                -            "user_name": "user",
                                -            "auth": 1
                                -        }
                                -    ]
                                +

                                Example Request

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

                                Example Response

                                Status code: 200

                                +

                                Query succeeded.

                                +
                                {
                                +  "id" : 1422,
                                +  "name" : "group",
                                +  "self_auth" : {
                                +    "user_id" : "3059e6b5562241fda3fa441cca6f228b",
                                +    "user_name" : "user01",
                                +    "auth" : 7
                                +  },
                                +  "others_auths" : [ {
                                +    "user_id" : "fb3f175c1fd146ab8cdae3272be6107b",
                                +    "user_name" : "user02",
                                +    "auth" : 7
                                +  } ]
                                 }
                                -
                              • -

                                Status Code

                                -

                                Status Code

                                +

                                Status Codes

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

                                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 was not found.

                                500

                                +

                                500

                                Internal error.

                                +

                                Internal error.

                                -

                                Error Codes

                                For details, see Error Codes.

                                +

                                Error Codes

                                For details, see Error Codes.

                                diff --git a/docs/swr/api-ref/swr_02_0052.html b/docs/swr/api-ref/swr_02_0052.html new file mode 100644 index 000000000..c034048f7 --- /dev/null +++ b/docs/swr/api-ref/swr_02_0052.html @@ -0,0 +1,180 @@ + + +

                                Generating a Temporary Login Command

                                +

                                Description

                                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.

                                +
                                +

                                Constraints

                                None

                                +
                                +

                                URI

                                POST /v2/manage/utils/secret

                                + +
                                + + + + + + + + + + + +
                                Table 1 Query parameter

                                Parameter

                                +

                                Mandatory

                                +

                                Type

                                +

                                Description

                                +

                                projectname

                                +

                                No

                                +

                                String

                                +

                                Project name. The default value is the region name.

                                +

                                Example: eu-de

                                +
                                +
                                +
                                +

                                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.

                                +

                                Default value: 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 Parameters

                                Status code: 200

                                + +
                                + + + + + + + + + +
                                Table 3 Response header parameter

                                Parameter

                                +

                                Type

                                +

                                Description

                                +

                                X-Swr-Dockerlogin

                                +

                                String

                                +

                                Docker login command, for example:

                                +

                                docker login -u ********@OW******FPUKBXI -p 6f0779072******863d1ae3ccef921b7f33

                                +
                                +
                                + +
                                + + + + + + + + + +
                                Table 4 Response body parameter

                                Parameter

                                +

                                Type

                                +

                                Description

                                +

                                auths

                                +

                                Map<String,AuthInfo>

                                +

                                Authentication information.

                                +
                                +
                                + +
                                + + + + + + + + + +
                                Table 5 AuthInfo

                                Parameter

                                +

                                Type

                                +

                                Description

                                +

                                auth

                                +

                                String

                                +

                                Base64-encoded authentication information.

                                +
                                +
                                +
                                +

                                Example Request

                                POST https://{endpoint}/v2/manage/utils/secret
                                +
                                +

                                Example Response

                                Status code: 200

                                +

                                Creation succeeded.

                                +
                                {
                                +  "auths" : {
                                +    "swr.xxx" : {
                                +      "auth" : "Y24tbm9ydGg******hhMTgzMGVmN2RhZjJm"
                                +    }
                                +  }
                                +}
                                +
                                +

                                Status Codes

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

                                Status Code

                                +

                                Description

                                +

                                200

                                +

                                Creation succeeded.

                                +

                                400

                                +

                                Request error.

                                +

                                401

                                +

                                Authentication failed.

                                +

                                500

                                +

                                Internal error.

                                +
                                +
                                +
                                +

                                Error Codes

                                For details, see Error Codes.

                                +
                                +
                                +
                                + +
                                + diff --git a/docs/swr/api-ref/swr_02_0053.html b/docs/swr/api-ref/swr_02_0053.html new file mode 100644 index 000000000..f07500bb8 --- /dev/null +++ b/docs/swr/api-ref/swr_02_0053.html @@ -0,0 +1,269 @@ + + +

                                Querying Image Retention Policies

                                +

                                Description

                                Query image retention policies.

                                +
                                +

                                Constraints

                                None

                                +
                                +

                                URI

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

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

                                Parameter

                                +

                                Mandatory

                                +

                                Type

                                +

                                Description

                                +

                                namespace

                                +

                                Yes

                                +

                                String

                                +

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

                                +

                                repository

                                +

                                Yes

                                +

                                String

                                +

                                Image repository name. 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 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.

                                +

                                Default value: 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, 100 records will be returned.

                                +
                                +
                                +

                                Response Parameters

                                Status code: 200

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

                                Parameter

                                +

                                Type

                                +

                                Description

                                +

                                [items]

                                +

                                Array of Retention objects

                                +

                                Query succeeded.

                                +
                                +
                                + +
                                + + + + + + + + + + + + + + + + + + + + + +
                                Table 4 Retention

                                Parameter

                                +

                                Type

                                +

                                Description

                                +

                                algorithm

                                +

                                String

                                +

                                Retention policy matching rule. The value is or.

                                +

                                id

                                +

                                Integer

                                +

                                ID

                                +

                                rules

                                +

                                Array of Rule objects

                                +

                                Image retention policy.

                                +

                                scope

                                +

                                String

                                +

                                Reserved field.

                                +
                                +
                                + +
                                + + + + + + + + + + + + + + + + + +
                                Table 5 Rule

                                Parameter

                                +

                                Type

                                +

                                Description

                                +

                                template

                                +

                                String

                                +

                                Retention policy type. The value can be date_rule and tag_rule.

                                +

                                params

                                +

                                Object

                                +

                                If template is set to date_rule, set params to {"days": "xxx"}. If template is set to tag_rule, set params to {"num": "xxx"}.

                                +

                                tag_selectors

                                +

                                Array of TagSelector objects

                                +

                                Exception images.

                                +
                                +
                                + +
                                + + + + + + + + + + + + + +
                                Table 6 TagSelector

                                Parameter

                                +

                                Type

                                +

                                Description

                                +

                                kind

                                +

                                String

                                +

                                Matching rule. The value can be label or regexp.

                                +

                                pattern

                                +

                                String

                                +

                                If kind is set to label, set this parameter to the image tag. If kind is set to regexp, set this parameter to a regular expression.

                                +
                                +
                                +
                                +

                                Example Request

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

                                Example Response

                                Status code: 200

                                +

                                Query succeeded.

                                +
                                [ {
                                +  "algorithm" : "or",
                                +  "id" : 222,
                                +  "rules" : [ {
                                +    "params" : {
                                +      "days" : "30"
                                +    },
                                +    "tag_selectors" : [ {
                                +      "kind" : "label",
                                +      "pattern" : "v5"
                                +    }, {
                                +      "kind" : "label",
                                +      "pattern" : "1.0.1"
                                +    }, {
                                +      "kind" : "regexp",
                                +      "pattern" : "^123$"
                                +    } ],
                                +    "template" : "date_rule"
                                +  } ],
                                +  "scope" : ""
                                +} ]
                                +
                                +

                                Status Codes

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

                                Status Code

                                +

                                Description

                                +

                                200

                                +

                                Query succeeded.

                                +

                                400

                                +

                                Request error.

                                +

                                401

                                +

                                Authentication failed.

                                +

                                404

                                +

                                The organization or repository was not found.

                                +

                                500

                                +

                                Internal error.

                                +
                                +
                                +
                                +

                                Error Codes

                                For details, see Error Codes.

                                +
                                +
                                +
                                + +
                                + diff --git a/docs/swr/api-ref/swr_02_0054.html b/docs/swr/api-ref/swr_02_0054.html new file mode 100644 index 000000000..3b991dff9 --- /dev/null +++ b/docs/swr/api-ref/swr_02_0054.html @@ -0,0 +1,136 @@ + + +

                                Deleting an Image Retention Policy

                                +

                                Description

                                Delete an image retention policy.

                                +
                                +

                                Constraints

                                None

                                +
                                +

                                URI

                                DELETE /v2/manage/namespaces/{namespace}/repos/{repository}/retentions/{retention_id}

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

                                Parameter

                                +

                                Mandatory

                                +

                                Type

                                +

                                Description

                                +

                                namespace

                                +

                                Yes

                                +

                                String

                                +

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

                                +

                                repository

                                +

                                Yes

                                +

                                String

                                +

                                Image repository name. 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.

                                +

                                retention_id

                                +

                                Yes

                                +

                                Integer

                                +

                                Image retention policy ID.

                                +
                                +
                                +
                                +

                                Request Parameters

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

                                Parameter

                                +

                                Mandatory

                                +

                                Type

                                +

                                Description

                                +

                                Content-Type

                                +

                                No

                                +

                                String

                                +

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

                                +

                                Default value: 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 Parameters

                                None

                                +
                                +

                                Example Request

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

                                Example Response

                                None

                                +
                                +

                                Status Codes

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

                                Status Code

                                +

                                Description

                                +

                                200

                                +

                                Deletion succeeded.

                                +

                                400

                                +

                                Request error.

                                +

                                401

                                +

                                Authentication failed.

                                +

                                404

                                +

                                The organization, image repository, or policy was not found.

                                +

                                500

                                +

                                Internal error.

                                +
                                +
                                +
                                +

                                Error Codes

                                For details, see Error Codes.

                                +
                                +
                                +
                                + +
                                + diff --git a/docs/swr/api-ref/swr_02_0055.html b/docs/swr/api-ref/swr_02_0055.html new file mode 100644 index 000000000..667970259 --- /dev/null +++ b/docs/swr/api-ref/swr_02_0055.html @@ -0,0 +1,257 @@ + + +

                                Querying Details About an Image Retention Policy

                                +

                                Description

                                Query details about an image retention policy.

                                +
                                +

                                Constraints

                                None

                                +
                                +

                                URI

                                GET /v2/manage/namespaces/{namespace}/repos/{repository}/retentions/{retention_id}

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

                                Parameter

                                +

                                Mandatory

                                +

                                Type

                                +

                                Description

                                +

                                namespace

                                +

                                Yes

                                +

                                String

                                +

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

                                +

                                repository

                                +

                                Yes

                                +

                                String

                                +

                                Image repository name. 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.

                                +

                                retention_id

                                +

                                Yes

                                +

                                Integer

                                +

                                Image retention policy ID.

                                +
                                +
                                +
                                +

                                Request Parameters

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

                                Parameter

                                +

                                Mandatory

                                +

                                Type

                                +

                                Description

                                +

                                Content-Type

                                +

                                No

                                +

                                String

                                +

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

                                +

                                Default value: 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 Parameters

                                Status code: 200

                                + +
                                + + + + + + + + + + + + + + + + + + + + + +
                                Table 3 Response body parameters

                                Parameter

                                +

                                Type

                                +

                                Description

                                +

                                algorithm

                                +

                                String

                                +

                                Retention policy matching rule. The value is or.

                                +

                                id

                                +

                                Integer

                                +

                                ID

                                +

                                rules

                                +

                                Array of Rule objects

                                +

                                Image retention policy.

                                +

                                scope

                                +

                                String

                                +

                                Reserved field.

                                +
                                +
                                + +
                                + + + + + + + + + + + + + + + + + +
                                Table 4 Rule

                                Parameter

                                +

                                Type

                                +

                                Description

                                +

                                template

                                +

                                String

                                +

                                Retention policy type. The value can be date_rule and tag_rule.

                                +

                                params

                                +

                                Object

                                +

                                If template is set to date_rule, set params to {"days": "xxx"}. If template is set to tag_rule, set params to {"num": "xxx"}.

                                +

                                tag_selectors

                                +

                                Array of TagSelector objects

                                +

                                Exception images.

                                +
                                +
                                + +
                                + + + + + + + + + + + + + +
                                Table 5 TagSelector

                                Parameter

                                +

                                Type

                                +

                                Description

                                +

                                kind

                                +

                                String

                                +

                                Matching rule. The value can be label or regexp.

                                +

                                pattern

                                +

                                String

                                +

                                If kind is set to label, set this parameter to the image tag. If kind is set to regexp, set this parameter to a regular expression.

                                +
                                +
                                +
                                +

                                Example Request

                                GET https://{endpoint}/v2/manage/namespaces/{namespace}/repos/{repository}/retentions/{retention_id}
                                +
                                +

                                Example Response

                                Status code: 200

                                +

                                Query succeeded.

                                +
                                {
                                +  "algorithm" : "or",
                                +  "id" : 222,
                                +  "rules" : [ {
                                +    "params" : {
                                +      "days" : "30"
                                +    },
                                +    "tag_selectors" : [ {
                                +      "kind" : "label",
                                +      "pattern" : "v5"
                                +    }, {
                                +      "kind" : "label",
                                +      "pattern" : "1.0.1"
                                +    }, {
                                +      "kind" : "regexp",
                                +      "pattern" : "^123$"
                                +    } ],
                                +    "template" : "date_rule"
                                +  } ],
                                +  "scope" : ""
                                +}
                                +
                                +

                                Status Codes

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

                                Status Code

                                +

                                Description

                                +

                                200

                                +

                                Query succeeded.

                                +

                                400

                                +

                                Request error.

                                +

                                401

                                +

                                Authentication failed.

                                +

                                404

                                +

                                The organization, image repository, or policy was not found.

                                +

                                500

                                +

                                Internal error.

                                +
                                +
                                +
                                +

                                Error Codes

                                For details, see Error Codes.

                                +
                                +
                                +
                                + +
                                + diff --git a/docs/swr/api-ref/swr_02_0056.html b/docs/swr/api-ref/swr_02_0056.html new file mode 100644 index 000000000..003fbd0b7 --- /dev/null +++ b/docs/swr/api-ref/swr_02_0056.html @@ -0,0 +1,261 @@ + + +

                                Modifying an Image Retention Policy

                                +

                                Description

                                Modify an image retention policy.

                                +
                                +

                                Constraints

                                None

                                +
                                +

                                URI

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

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

                                Parameter

                                +

                                Mandatory

                                +

                                Type

                                +

                                Description

                                +

                                namespace

                                +

                                Yes

                                +

                                String

                                +

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

                                +

                                repository

                                +

                                Yes

                                +

                                String

                                +

                                Image repository name. 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.

                                +

                                retention_id

                                +

                                Yes

                                +

                                Integer

                                +

                                Image retention policy ID.

                                +
                                +
                                +
                                +

                                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.

                                +

                                Default value: 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.

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

                                Parameter

                                +

                                Mandatory

                                +

                                Type

                                +

                                Description

                                +

                                algorithm

                                +

                                Yes

                                +

                                String

                                +

                                Retention policy matching rule. The value is or.

                                +

                                rules

                                +

                                Yes

                                +

                                Array of Rule objects

                                +

                                Image retention policy.

                                +
                                +
                                + +
                                + + + + + + + + + + + + + + + + + + + + + +
                                Table 4 Rule

                                Parameter

                                +

                                Mandatory

                                +

                                Type

                                +

                                Description

                                +

                                template

                                +

                                Yes

                                +

                                String

                                +

                                Retention policy type. The value can be date_rule and tag_rule. This parameter cannot be changed.

                                +

                                params

                                +

                                Yes

                                +

                                Object

                                +

                                If template is set to date_rule, set params to {"days": "xxx"}. If template is set to tag_rule, set params to {"num": "xxx"}.

                                +

                                tag_selectors

                                +

                                Yes

                                +

                                Array of TagSelector objects

                                +

                                Exception images.

                                +
                                +
                                + +
                                + + + + + + + + + + + + + + + + +
                                Table 5 TagSelector

                                Parameter

                                +

                                Mandatory

                                +

                                Type

                                +

                                Description

                                +

                                kind

                                +

                                Yes

                                +

                                String

                                +

                                Matching rule. The value can be label or regexp.

                                +

                                pattern

                                +

                                Yes

                                +

                                String

                                +

                                If kind is set to label, set this parameter to the image tag. If kind is set to regexp, set this parameter to a regular expression.

                                +
                                +
                                +
                                +

                                Response Parameters

                                None

                                +
                                +

                                Example Request

                                PATCH https://{endpoint}/v2/manage/namespaces/{namespace}/repos/{repository}/retentions/{retention_id}
                                +
                                +{
                                +  "algorithm" : "or",
                                +  "rules" : [ {
                                +    "params" : {
                                +      "days" : "30"
                                +    },
                                +    "tag_selectors" : [ {
                                +      "kind" : "label",
                                +      "pattern" : "v5"
                                +    }, {
                                +      "kind" : "label",
                                +      "pattern" : "1.0.1"
                                +    }, {
                                +      "kind" : "regexp",
                                +      "pattern" : "^123$"
                                +    } ],
                                +    "template" : "date_rule"
                                +  } ]
                                +}
                                +
                                +

                                Example Response

                                None

                                +
                                +

                                Status Codes

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

                                Status Code

                                +

                                Description

                                +

                                201

                                +

                                Update succeeded.

                                +

                                400

                                +

                                Request error.

                                +

                                401

                                +

                                Authentication failed.

                                +

                                404

                                +

                                The organization, image repository, or policy was not found.

                                +

                                500

                                +

                                Internal error.

                                +
                                +
                                +
                                +

                                Error Codes

                                For details, see Error Codes.

                                +
                                +
                                +
                                + +
                                + diff --git a/docs/swr/api-ref/swr_02_0057.html b/docs/swr/api-ref/swr_02_0057.html new file mode 100644 index 000000000..68f524bf7 --- /dev/null +++ b/docs/swr/api-ref/swr_02_0057.html @@ -0,0 +1,288 @@ + + +

                                Querying Image Retention Records

                                +

                                Description

                                Query image retention records.

                                +
                                +

                                Constraints

                                None

                                +
                                +

                                URI

                                GET /v2/manage/namespaces/{namespace}/repos/{repository}/retentions/histories

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

                                Parameter

                                +

                                Mandatory

                                +

                                Type

                                +

                                Description

                                +

                                namespace

                                +

                                Yes

                                +

                                String

                                +

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

                                +

                                repository

                                +

                                Yes

                                +

                                String

                                +

                                Image repository name. 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.

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

                                Parameter

                                +

                                Mandatory

                                +

                                Type

                                +

                                Description

                                +

                                limit

                                +

                                No

                                +

                                String

                                +

                                Number of returned records. Parameters offset and limit should always be used together.

                                +

                                offset

                                +

                                No

                                +

                                String

                                +

                                Start index. The value must be 0 or a positive number.

                                +

                                Parameters offset and limit should always be used together.

                                +

                                filter

                                +

                                No

                                +

                                String

                                +

                                Set this parameter to limit::{limit}|offset::{offset}. limit indicates the number of returned records. offset indicates the start index. Parameters offset and limit should always be used together.

                                +
                                +
                                +
                                +

                                Request Parameters

                                +
                                + + + + + + + + + + + + + + + + +
                                Table 3 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.

                                +

                                Default value: 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 Parameters

                                Status code: 200

                                + +
                                + + + + + + + + + +
                                Table 4 Response header parameter

                                Parameter

                                +

                                Type

                                +

                                Description

                                +

                                Content-Range

                                +

                                String

                                +

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

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

                                Parameter

                                +

                                Type

                                +

                                Description

                                +

                                retention_log

                                +

                                Array of RetentionLog objects

                                +

                                Image retention log.

                                +

                                total

                                +

                                Integer

                                +

                                Total number.

                                +
                                +
                                + +
                                + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                Table 6 RetentionLog

                                Parameter

                                +

                                Type

                                +

                                Description

                                +

                                created_at

                                +

                                String

                                +

                                Creation time.

                                +

                                id

                                +

                                Integer

                                +

                                ID

                                +

                                namespace

                                +

                                String

                                +

                                Organization name.

                                +

                                repo

                                +

                                String

                                +

                                Image repository name.

                                +

                                retention_id

                                +

                                Integer

                                +

                                Image retention policy ID.

                                +

                                rule_type

                                +

                                String

                                +

                                Policy.

                                +

                                tag

                                +

                                String

                                +

                                Image tag.

                                +
                                +
                                +
                                +

                                Example Request

                                GET https://{endpoint}/v2/manage/namespaces/{namespace}/repos/{repository}/retentions/histories
                                +
                                +

                                Example Response

                                Status code: 200

                                +

                                Request succeeded.

                                +
                                {
                                +  "retention_log" : [ {
                                +    "created_at" : "2020-04-17T08:01:09.658309Z",
                                +    "id" : 9088,
                                +    "namespace" : "hwstaff_l00283074",
                                +    "repo" : "experience_2048",
                                +    "retention_id" : 91,
                                +    "rule_type" : "{\"template\":\"tag_rule\",\"params\":{\"num\":\"7\"},\"tag_selectors\":[]}",
                                +    "tag" : "4"
                                +  } ],
                                +  "total" : 1
                                +}
                                +
                                +

                                Status Codes

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

                                Status Code

                                +

                                Description

                                +

                                200

                                +

                                Request succeeded.

                                +

                                400

                                +

                                Request error.

                                +

                                401

                                +

                                Authentication failed.

                                +

                                404

                                +

                                The organization or the repository was not found.

                                +

                                500

                                +

                                Internal error.

                                +
                                +
                                +
                                +

                                Error Codes

                                For details, see Error Codes.

                                +
                                +
                                +
                                + +
                                + diff --git a/docs/swr/api-ref/swr_02_0064-1.html b/docs/swr/api-ref/swr_02_0064-1.html new file mode 100644 index 000000000..36ab8365b --- /dev/null +++ b/docs/swr/api-ref/swr_02_0064-1.html @@ -0,0 +1,46 @@ + + +

                                Change History

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

                                Release Date

                                +

                                Description

                                +

                                2025-10-23

                                +
                                +

                                2025-07-10

                                +

                                Optimized the parameters and titles of APIs related to image retention.

                                +

                                2025-05-21

                                +
                                +
                                • Updated parameter descriptions and other information.
                                +

                                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.

                                +

                                2020-04-21

                                +

                                This issue is the first official release.

                                +
                                +
                                +
                                + diff --git a/docs/swr/api-ref/swr_02_0064.html b/docs/swr/api-ref/swr_02_0064.html deleted file mode 100644 index e842c5f1a..000000000 --- a/docs/swr/api-ref/swr_02_0064.html +++ /dev/null @@ -1,30 +0,0 @@ - - -

                                Change History

                                -
                                -
                                - - - - - - - - - - - - - -

                                Release Date

                                -

                                Description

                                -

                                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.

                                -

                                2020-04-21

                                -

                                This issue is the first official release.

                                -
                                -
                                -
                                - diff --git a/docs/swr/api-ref/swr_02_0070.html b/docs/swr/api-ref/swr_02_0070.html index 8fdf6a167..58420c441 100644 --- a/docs/swr/api-ref/swr_02_0070.html +++ b/docs/swr/api-ref/swr_02_0070.html @@ -1,183 +1,184 @@ -

                                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.

                                +

                                Sharing an Image with an Account

                                +

                                Description

                                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.

                                -

                                URI

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

                                -

                                For details about parameters, see Table 1.

                                +

                                Constraints

                                None

                                +
                                +

                                URI

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

                                -
                                Table 1 Parameter description

                                Parameter

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

                                Parameter

                                Mandatory

                                +

                                Mandatory

                                Type

                                +

                                Type

                                Description

                                +

                                Description

                                namespace

                                +

                                namespace

                                Yes

                                +

                                Yes

                                String

                                +

                                String

                                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.

                                +

                                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

                                +

                                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 -
                                  Table 2 Request header parameters

                                  Parameter

                                  +

                                  Request Parameters

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

                                  Parameter

                                  Mandatory

                                  +

                                  Mandatory

                                  Type

                                  +

                                  Type

                                  Description

                                  +

                                  Description

                                  Content-Type

                                  +

                                  Content-Type

                                  Yes

                                  +

                                  Yes

                                  String

                                  +

                                  String

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

                                  -

                                  The default value is application/json.

                                  +

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

                                  +

                                  Default value: application/json

                                  X-Auth-Token

                                  +

                                  X-Auth-Token

                                  Yes

                                  +

                                  Yes

                                  String

                                  +

                                  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.

                                  +

                                  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.

                                  -
                                  Table 3 Request body parameter description

                                  Parameter

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

                                  Parameter

                                  Mandatory

                                  +

                                  Mandatory

                                  Type

                                  +

                                  Type

                                  Description

                                  +

                                  Description

                                  access_domain

                                  +

                                  access_domain

                                  Yes

                                  +

                                  Yes

                                  String

                                  +

                                  String

                                  Name of the account used for image sharing.

                                  +

                                  Shared tenant name.

                                  permit

                                  +

                                  permit

                                  Yes

                                  +

                                  Yes

                                  String

                                  +

                                  String

                                  Currently, only the read permission is supported.

                                  +

                                  Currently, only the read permission is supported.

                                  deadline

                                  +

                                  deadline

                                  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.

                                  +

                                  Valid until (UTC). forever indicates permanently valid.

                                  description

                                  +

                                  description

                                  No

                                  +

                                  No

                                  String

                                  +

                                  String

                                  Description.

                                  +

                                  Description

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

                                  Body:

                                  -
                                  {
                                  -    "access_domain": "domain_name",
                                  -    "permit": "read",
                                  -    "deadline": "2021-10-01T16:00:00.000Z",
                                  -    "description": "description"
                                  +
                                  +

                                  Response Parameters

                                  None

                                  +
                                  +

                                  Example Request

                                  POST https://{endpoint}/v2/manage/namespaces/{namespace}/repositories/{repository}/access-domains
                                  +
                                  +{
                                  +  "access_domain" : "demo",
                                  +  "permit" : "read",
                                  +  "deadline" : "2018-10-01T16:00:00.000Z",
                                  +  "description" : "description"
                                   }
                                  -
                                • -

                                  Response

                                  • Response parameters

                                    N/A

                                    -
                                  • Example response

                                    None

                                    -
                                  +

                                  Example Response

                                  None

                                  -

                                  Status Code

                                  -

                                  Status Code

                                  +

                                  Status Codes

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

                                  Status Code

                                  Description

                                  +

                                  Description

                                  201

                                  +

                                  201

                                  Creation successful.

                                  +

                                  Creation succeeded.

                                  400

                                  +

                                  400

                                  Request error.

                                  +

                                  Request error.

                                  401

                                  +

                                  401

                                  Authentication failed.

                                  +

                                  Authentication failed.

                                  409

                                  +

                                  409

                                  The repository has been shared.

                                  +

                                  The shared account already exists.

                                  500

                                  +

                                  500

                                  Internal error.

                                  +

                                  Internal error.

                                  -

                                  Error Codes

                                  For details, see Error Codes.

                                  +

                                  Error Codes

                                  For details, see Error Codes.

                                  diff --git a/docs/swr/api-ref/swr_02_0071.html b/docs/swr/api-ref/swr_02_0071.html index 66bbedcec..dedeb8e87 100644 --- a/docs/swr/api-ref/swr_02_0071.html +++ b/docs/swr/api-ref/swr_02_0071.html @@ -1,128 +1,131 @@ -

                                  Deleting an Account Used for Image Sharing

                                  -

                                  Function

                                  Delete an account used for image sharing.

                                  +

                                  Deleting an Account from the Sharing List

                                  +

                                  Description

                                  Delete an account from the sharing list.

                                  -

                                  URI

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

                                  -

                                  For details about parameters, see Table 1.

                                  +

                                  Constraints

                                  None

                                  +
                                  +

                                  URI

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

                                  -
                                  Table 1 Parameter description

                                  Parameter

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

                                  Parameter

                                  Mandatory

                                  +

                                  Mandatory

                                  Type

                                  +

                                  Type

                                  Description

                                  +

                                  Description

                                  namespace

                                  +

                                  namespace

                                  Yes

                                  +

                                  Yes

                                  String

                                  +

                                  String

                                  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.

                                  +

                                  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.

                                  +

                                  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.

                                  access_domain

                                  +

                                  access_domain

                                  Yes

                                  +

                                  Yes

                                  String

                                  +

                                  String

                                  Name of the account used for image sharing.

                                  +

                                  Shared tenant name.

                                  -

                                  Request

                                  • Request parameters -
                                    Table 2 Request header parameters

                                    Parameter

                                    +

                                    Request Parameters

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

                                    Parameter

                                    Mandatory

                                    +

                                    Mandatory

                                    Type

                                    +

                                    Type

                                    Description

                                    +

                                    Description

                                    Content-Type

                                    +

                                    Content-Type

                                    Yes

                                    +

                                    Yes

                                    String

                                    +

                                    String

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

                                    -

                                    The default value is application/json.

                                    +

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

                                    +

                                    Default value: application/json

                                    X-Auth-Token

                                    +

                                    X-Auth-Token

                                    Yes

                                    +

                                    Yes

                                    String

                                    +

                                    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
                                    -
                                  • -
                                    -

                                    Response

                                    N/A

                                    -
                                    -

                                    Status Code

                                    -
                                    - - - - - - - - - - - - - -

                                    Status Code

                                    -

                                    Description

                                    -

                                    204

                                    -

                                    Deleted successfully.

                                    -

                                    400

                                    -

                                    Request error.

                                    -

                                    401

                                    -

                                    Authentication failed.

                                    -

                                    500

                                    -

                                    Failed to complete the request because of an internal service error.

                                    +

                                    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.

                                    -

                                    Error Codes

                                    For details, see Error Codes.

                                    +

                                    Response Parameters

                                    None

                                    +
                                    +

                                    Example Request

                                    DELETE https://{endpoint}/v2/manage/namespaces/{namespace}/repositories/{repository}/access-domains/{access_domain}
                                    +
                                    +

                                    Example Response

                                    None

                                    +
                                    +

                                    Status Codes

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

                                    Status Code

                                    +

                                    Description

                                    +

                                    204

                                    +

                                    Deletion succeeded.

                                    +

                                    400

                                    +

                                    Request error.

                                    +

                                    401

                                    +

                                    Authentication failed.

                                    +

                                    500

                                    +

                                    Internal error.

                                    +
                                    +
                                    +
                                    +

                                    Error Codes

                                    For details, see Error Codes.

                                    diff --git a/docs/swr/api-ref/swr_02_0072.html b/docs/swr/api-ref/swr_02_0072.html index ff7209ba1..82658ec01 100644 --- a/docs/swr/api-ref/swr_02_0072.html +++ b/docs/swr/api-ref/swr_02_0072.html @@ -1,173 +1,178 @@ -

                                    Updating an Account Used for Image Sharing

                                    -

                                    Function

                                    Update an account used for image sharing.

                                    +

                                    Updating an Account An Image Is Shared With

                                    +

                                    Description

                                    Update an account an image is shared with.

                                    -

                                    URI

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

                                    -

                                    For details about parameters, see Table 1.

                                    +

                                    Constraints

                                    None

                                    +
                                    +

                                    URI

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

                                    -
                                    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

                                    +

                                    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.

                                    access_domain

                                    +

                                    access_domain

                                    Yes

                                    +

                                    Yes

                                    String

                                    +

                                    String

                                    Name of the account used for image sharing

                                    +

                                    Name of the account used for image sharing.

                                    -

                                    Request

                                    • Request parameters -
                                      Table 2 Request header parameters

                                      Parameter

                                      +

                                      Request Parameters

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

                                      Parameter

                                      Mandatory

                                      +

                                      Mandatory

                                      Type

                                      +

                                      Type

                                      Description

                                      +

                                      Description

                                      Content-Type

                                      +

                                      Content-Type

                                      Yes

                                      +

                                      Yes

                                      String

                                      +

                                      String

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

                                      -

                                      The default value is application/json.

                                      +

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

                                      +

                                      Default value: application/json

                                      X-Auth-Token

                                      +

                                      X-Auth-Token

                                      Yes

                                      +

                                      Yes

                                      String

                                      +

                                      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.

                                      +

                                      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.

                                      -
                                      Table 3 Request body parameter description

                                      Parameter

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

                                      Parameter

                                      Mandatory

                                      +

                                      Mandatory

                                      Type

                                      +

                                      Type

                                      Description

                                      +

                                      Description

                                      permit

                                      +

                                      permit

                                      Yes

                                      +

                                      Yes

                                      String

                                      +

                                      String

                                      Currently, only the read permission is supported.

                                      +

                                      Currently, only the read permission is supported.

                                      deadline

                                      +

                                      deadline

                                      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.

                                      +

                                      Valid until (UTC). forever indicates permanently valid.

                                      description

                                      +

                                      description

                                      No

                                      +

                                      No

                                      String

                                      +

                                      String

                                      Description. This parameter is left blank by default.

                                      +

                                      Description. This parameter is left blank by default.

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

                                      Body:

                                      -
                                      {
                                      -    "permit": "read",
                                      -    "deadline": "forever",
                                      -    "description": "description"
                                      +
                                      +

                                      Response Parameters

                                      None

                                      +
                                      +

                                      Example Request

                                      PATCH https://{endpoint}/v2/manage/namespaces/{namespace}/repositories/{repository}/access-domains
                                      +
                                      +{
                                      +  "permit" : "read",
                                      +  "deadline" : "2018-10-01T16:00:00.000Z",
                                      +  "description" : "description"
                                       }
                                      -
                                    • -

                                      Response

                                      N/A

                                      +

                                      Example Response

                                      None

                                      -

                                      Status Code

                                      -

                                      Status Code

                                      +

                                      Status Codes

                                      +
                                      - - - - - - - - -

                                      Status Code

                                      Description

                                      +

                                      Description

                                      201

                                      +

                                      201

                                      Modified successfully.

                                      +

                                      Modification succeeded.

                                      400

                                      +

                                      400

                                      Request error.

                                      +

                                      Request error.

                                      401

                                      +

                                      401

                                      Authentication failed.

                                      +

                                      Authentication failed.

                                      500

                                      +

                                      500

                                      Internal error.

                                      +

                                      Internal error.

                                      +

                                      Error Codes

                                      For details, see Error Codes.

                                      +
                                      diff --git a/docs/swr/api-ref/swr_02_0073.html b/docs/swr/api-ref/swr_02_0073.html index 1192fb34c..d915862af 100644 --- a/docs/swr/api-ref/swr_02_0073.html +++ b/docs/swr/api-ref/swr_02_0073.html @@ -1,240 +1,242 @@ -

                                      Checking the Existence of an Account Used for Image Sharing

                                      -

                                      Function

                                      Check whether an account used for image sharing exists.

                                      +

                                      Checking Whether an Account Exists for Receiving a Shared Image

                                      +

                                      Description

                                      Check whether an account exists for receiving a shared image.

                                      -

                                      URI

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

                                      -

                                      For details about parameters, see Table 1.

                                      +

                                      Constraints

                                      None

                                      +
                                      +

                                      URI

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

                                      -
                                      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

                                      +

                                      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.

                                      access_domain

                                      +

                                      access_domain

                                      Yes

                                      +

                                      Yes

                                      String

                                      +

                                      String

                                      Name of the account used for image sharing.

                                      +

                                      Name of the account used for image sharing.

                                      -

                                      Request

                                      • Request parameters -
                                        Table 2 Request header parameters

                                        Parameter

                                        +

                                        Request Parameters

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

                                        Parameter

                                        Mandatory

                                        +

                                        Mandatory

                                        Type

                                        +

                                        Type

                                        Description

                                        +

                                        Description

                                        Content-Type

                                        +

                                        Content-Type

                                        Yes

                                        +

                                        Yes

                                        String

                                        +

                                        String

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

                                        -

                                        The default value is application/json.

                                        +

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

                                        +

                                        Default value: application/json

                                        X-Auth-Token

                                        +

                                        X-Auth-Token

                                        Yes

                                        +

                                        Yes

                                        String

                                        +

                                        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/repositories/busybox/access-domains/domain_name
                                        -
                                      • -
                                        -

                                        Response

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

                                          Parameter

                                          -

                                          Type

                                          -

                                          Description

                                          -

                                          exist

                                          -

                                          Boolean

                                          -

                                          true: Exist. false: Not exist.

                                          -

                                          namespace

                                          -

                                          String

                                          -

                                          Organization name.

                                          -

                                          repository

                                          -

                                          String

                                          -

                                          Image repository name.

                                          -

                                          access_domain

                                          -

                                          String

                                          -

                                          Name of the account used for image sharing.

                                          -

                                          permit

                                          -

                                          String

                                          -

                                          Permission.

                                          -

                                          deadline

                                          -

                                          String

                                          -

                                          Expiration time.

                                          -

                                          description

                                          -

                                          String

                                          -

                                          Description.

                                          -

                                          creator_id

                                          -

                                          String

                                          -

                                          Creator ID.

                                          -

                                          creator_name

                                          -

                                          String

                                          -

                                          Name of the creator.

                                          -

                                          created

                                          -

                                          String

                                          -

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

                                          -

                                          updated

                                          -

                                          String

                                          -

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

                                          -

                                          status

                                          -

                                          Boolean

                                          -

                                          Status.

                                          -

                                          true: valid. false: expired.

                                          +

                                          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 response
                                          {
                                          -    "exist": true,
                                          -    "namespace": "group",
                                          -    "repository": "busybox",
                                          -    "access_domain": "xxx",
                                          -    "permit": "read",
                                          -    "deadline": "2021-10-01T16:00:00Z",
                                          -    "description": "description",
                                          -    "creator_id": "0504186e6a8010e01f3ec009a7279baa",
                                          -    "creator_name": "xxx",
                                          -    "created": "2021-06-10T08:14:42.56632Z",
                                          -    "updated": "2021-06-10T08:14:42.566325Z",
                                          -    "status": true
                                          +

                                          Response Parameters

                                          Status code: 200

                                          + +
                                          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                          Table 3 Response body parameters

                                          Parameter

                                          +

                                          Type

                                          +

                                          Description

                                          +

                                          exist

                                          +

                                          Boolean

                                          +

                                          true: The account exists. false: The account does not exist.

                                          +

                                          namespace

                                          +

                                          String

                                          +

                                          Organization name.

                                          +

                                          repository

                                          +

                                          String

                                          +

                                          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.

                                          +

                                          access_domain

                                          +

                                          String

                                          +

                                          Name of the account used for image sharing.

                                          +

                                          permit

                                          +

                                          String

                                          +

                                          Permissions.

                                          +

                                          deadline

                                          +

                                          String

                                          +

                                          Expiration time.

                                          +

                                          description

                                          +

                                          String

                                          +

                                          Description.

                                          +

                                          creator_id

                                          +

                                          String

                                          +

                                          Creator ID.

                                          +

                                          creator_name

                                          +

                                          String

                                          +

                                          Name of the creator.

                                          +

                                          created

                                          +

                                          String

                                          +

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

                                          +

                                          updated

                                          +

                                          String

                                          +

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

                                          +

                                          status

                                          +

                                          Boolean

                                          +

                                          Status. true: valid; false: expired.

                                          +
                                          +
                                          +
                                          +

                                          Example Request

                                          GET https://{endpoint}/v2/manage/namespaces/{namespace}/repositories/{repository}/access-domains/{access_domain}
                                          +
                                          +

                                          Example Response

                                          Status code: 200

                                          +

                                          Query succeeded.

                                          +
                                          {
                                          +  "exist" : true,
                                          +  "namespace" : "group",
                                          +  "repository" : "busybox",
                                          +  "access_domain" : "xxx",
                                          +  "permit" : "read",
                                          +  "deadline" : "2021-10-01T16:00:00Z",
                                          +  "description" : "description",
                                          +  "creator_id" : "0504186e6a8010e01f3ec009a7279baa",
                                          +  "creator_name" : "xxx",
                                          +  "created" : "2021-06-10T08:14:42.56632Z",
                                          +  "updated" : "2021-06-10T08:14:42.566325Z",
                                          +  "status" : true
                                           }
                                          -
                                        -

                                        Status Code

                                        -

                                        Status Code

                                        +

                                        Status Codes

                                        +
                                        - - - - - - - - -

                                        Status Code

                                        Description

                                        +

                                        Description

                                        200

                                        +

                                        200

                                        Query succeeded.

                                        +

                                        Query succeeded.

                                        400

                                        +

                                        400

                                        Request error.

                                        +

                                        Request error.

                                        401

                                        +

                                        401

                                        Authentication failed.

                                        +

                                        Authentication failed.

                                        500

                                        +

                                        500

                                        Internal error.

                                        +

                                        Internal error.

                                        -

                                        Error Codes

                                        For details, see Error Codes.

                                        +

                                        Error Codes

                                        For details, see Error Codes.

                                        diff --git a/docs/swr/api-ref/swr_02_0074.html b/docs/swr/api-ref/swr_02_0074.html index db1bd45a7..1720bb3ad 100644 --- a/docs/swr/api-ref/swr_02_0074.html +++ b/docs/swr/api-ref/swr_02_0074.html @@ -1,244 +1,246 @@ -

                                        Obtaining the List of Accounts Used for Image Sharing

                                        -

                                        Function

                                        Obtain the list of accounts used for image sharing.

                                        +

                                        Querying Accounts an Image Is Shared With

                                        +

                                        Description

                                        Query accounts an image is shared with.

                                        -

                                        URI

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

                                        -

                                        For details about parameters, see Table 1.

                                        +

                                        Constraints

                                        None

                                        +
                                        +

                                        URI

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

                                        -
                                        Table 1 Parameter description

                                        Parameter

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

                                        Parameter

                                        Mandatory

                                        +

                                        Mandatory

                                        Type

                                        +

                                        Type

                                        Description

                                        +

                                        Description

                                        namespace

                                        +

                                        namespace

                                        Yes

                                        +

                                        Yes

                                        String

                                        +

                                        String

                                        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.

                                        +

                                        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

                                        +

                                        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 -
                                          Table 2 Request header parameters

                                          Parameter

                                          +

                                          Request Parameters

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

                                          Parameter

                                          Mandatory

                                          +

                                          Mandatory

                                          Type

                                          +

                                          Type

                                          Description

                                          +

                                          Description

                                          Content-Type

                                          +

                                          Content-Type

                                          Yes

                                          +

                                          Yes

                                          String

                                          +

                                          String

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

                                          -

                                          The default value is application/json.

                                          +

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

                                          +

                                          Default value: application/json

                                          X-Auth-Token

                                          +

                                          X-Auth-Token

                                          Yes

                                          +

                                          Yes

                                          String

                                          +

                                          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.

                                          +

                                          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
                                          GET https://{Endpoint}/v2/manage/namespaces/group/repositories/busybox/access-domains
                                          -
                                        • -
                                          -

                                          By default, 100 records will be returned.

                                          +

                                          By default, 100 records will be returned.

                                          -

                                          Response

                                          • Response parameters -
                                            Table 3 Response body parameter description

                                            Parameter

                                            + +

                                            Response Parameters

                                            Status code: 200

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

                                            Parameter

                                            Type

                                            +

                                            Type

                                            Description

                                            +

                                            Description

                                            [Array element]

                                            +

                                            [items]

                                            Array of objects

                                            +

                                            Array of ShowRepoDomainsResponse objects

                                            Shared accounts.

                                            +

                                            The list of shared tenants.

                                            -
                                            Table 4 [Array element] parameter description

                                            Parameter

                                            +
                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                            Table 4 ShowRepoDomainsResponse

                                            Parameter

                                            Type

                                            +

                                            Type

                                            Description

                                            +

                                            Description

                                            namespace

                                            +

                                            namespace

                                            String

                                            +

                                            String

                                            Organization name.

                                            +

                                            Organization.

                                            repository

                                            +

                                            repository

                                            String

                                            +

                                            String

                                            Image repository name.

                                            +

                                            Image repository.

                                            access_domain

                                            +

                                            access_domain

                                            String

                                            +

                                            String

                                            Name of the account used for image sharing.

                                            +

                                            Shared tenant name.

                                            permit

                                            +

                                            permit

                                            String

                                            +

                                            String

                                            Permission.

                                            +

                                            Permissions.

                                            deadline

                                            +

                                            deadline

                                            String

                                            +

                                            String

                                            Expiration time.

                                            +

                                            Expiration time.

                                            description

                                            +

                                            description

                                            String

                                            +

                                            String

                                            Description.

                                            +

                                            Description.

                                            creator_id

                                            +

                                            creator_id

                                            String

                                            +

                                            String

                                            Creator ID.

                                            +

                                            Creator ID.

                                            creator_name

                                            +

                                            creator_name

                                            String

                                            +

                                            String

                                            Name of the creator.

                                            +

                                            Name of the creator.

                                            created

                                            +

                                            created

                                            String

                                            +

                                            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.

                                            +

                                            Time when the image was created. It is the UTC standard time. Users need to calculate the offset based on the local time, for example, UTC+8:00 for the East 8th Time Zone.

                                            updated

                                            +

                                            updated

                                            String

                                            +

                                            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.

                                            +

                                            Time when an image was updated. It is the UTC standard time. Users need to calculate the offset based on the local time, for example, UTC+8:00 for the East 8th Time Zone.

                                            status

                                            +

                                            status

                                            Boolean

                                            +

                                            Boolean

                                            Status. true: valid; false: expired

                                            -
                                            -
                                            -
                                          • Example response
                                            [
                                            -    {
                                            -        "namespace": "group",
                                            -        "repository": "busybox",
                                            -        "access_domain": "swr",
                                            -        "permit": "read",
                                            -        "deadline": "2021-10-01T16:00:00Z",
                                            -        "description": "description",
                                            -        "creator_id": "fb3f175c1fd146ab8cdae3272be6107b",
                                            -        "creator_name": "group",
                                            -        "created": "2021-06-10T08:14:42.56632Z",
                                            -        "updated": "2021-06-10T08:14:42.566325Z",
                                            -        "status": true
                                            -    }
                                            -]
                                            -
                                          • - -

                                            Status Code

                                            -
                                            - - - - - - - - - - - - - -

                                            Status Code

                                            -

                                            Description

                                            -

                                            200

                                            -

                                            The list of image sharing accounts is returned successfully.

                                            -

                                            400

                                            -

                                            Request error. Error information is returned.

                                            -

                                            401

                                            -

                                            Authentication failed.

                                            -

                                            500

                                            -

                                            Internal error. Error information is returned.

                                            +

                                            Status. true: valid; false: expired.

                                            -

                                            Error Codes

                                            For details, see Error Codes.

                                            +

                                            Example Request

                                            GET https://{endpoint}/v2/manage/namespaces/{namespace}/repositories/{repository}/access-domains
                                            +
                                            +

                                            Example Response

                                            Status code: 200

                                            +

                                            The list of shared accounts is queried successfully.

                                            +
                                            [ {
                                            +  "namespace" : "demo",
                                            +  "repository" : "paas",
                                            +  "access_domain" : "swr",
                                            +  "permit" : "read",
                                            +  "deadline" : "2018-10-01T16:00:00.000Z",
                                            +  "description" : "description",
                                            +  "creator_id" : "fb3f175c1fd146ab8cdae3272be6107b",
                                            +  "creator_name" : "user1",
                                            +  "created" : "2017-04-08T14:12:23Z",
                                            +  "updated" : "2017-04-13T21:01:11Z",
                                            +  "status" : false
                                            +} ]
                                            +
                                            +

                                            Status Codes

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

                                            Status Code

                                            +

                                            Description

                                            +

                                            200

                                            +

                                            List of image sharing accounts queried.

                                            +

                                            400

                                            +

                                            Request error.

                                            +

                                            401

                                            +

                                            Authentication failed.

                                            +

                                            500

                                            +

                                            Internal error.

                                            +
                                            +
                                            +
                                            +

                                            Error Codes

                                            For details, see Error Codes.

                                            diff --git a/docs/swr/api-ref/swr_02_0075.html b/docs/swr/api-ref/swr_02_0075.html index 107322523..6cec1ade5 100644 --- a/docs/swr/api-ref/swr_02_0075.html +++ b/docs/swr/api-ref/swr_02_0075.html @@ -1,356 +1,400 @@ -

                                            Viewing the List of Shared Images

                                            -

                                            Function

                                            View the list of shared images.

                                            +

                                            Querying Shared Images

                                            +

                                            Description

                                            Query shared images.

                                            -

                                            URI

                                            GET /v2/manage/shared-repositories

                                            +

                                            Constraints

                                            None

                                            +
                                            +

                                            URI

                                            GET /v2/manage/shared-repositories

                                            -
                                            Table 1 Query parameters

                                            Parameter

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

                                            Parameter

                                            Mandatory

                                            +

                                            Mandatory

                                            Type

                                            +

                                            Type

                                            Description

                                            +

                                            Description

                                            namespace

                                            +

                                            namespace

                                            No

                                            +

                                            No

                                            String

                                            +

                                            String

                                            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.

                                            +

                                            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.

                                            name

                                            +

                                            name

                                            No

                                            +

                                            No

                                            String

                                            +

                                            String

                                            Image repository name.

                                            +

                                            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.

                                            center

                                            +

                                            center

                                            No

                                            +

                                            Yes

                                            String

                                            +

                                            String

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

                                            +

                                            The value can only be self or thirdparty.

                                            +

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

                                            limit

                                            +

                                            domain_name

                                            No

                                            +

                                            No

                                            String

                                            +

                                            String

                                            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.

                                            +

                                            Owner name.

                                            offset

                                            +

                                            status

                                            No

                                            +

                                            No

                                            String

                                            +

                                            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.

                                            +

                                            false: The sharing has expired. true: The sharing is valid.

                                            order_column

                                            +

                                            limit

                                            No

                                            +

                                            No

                                            String

                                            +

                                            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.

                                            +

                                            Number of returned records. Parameters offset and limit should always be used together. If this parameter is not specified, 100 records are returned by default. The maximum number of records that can be returned is 1,000.

                                            order_type

                                            +

                                            offset

                                            No

                                            +

                                            No

                                            String

                                            +

                                            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.

                                            +

                                            Start index. The value must be 0 or a positive number. If this parameter is not specified, all records will be returned by default.

                                            +

                                            Parameters offset and limit should always be used together.

                                            filter

                                            +

                                            order_column

                                            No

                                            +

                                            No

                                            String

                                            +

                                            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).

                                            +

                                            Sorting by column. You can set this parameter to updated_at (update time), name, tag_count (number of tags), namespace (organization), or domain_name (owner). Parameters order_column and order_type should always be used together.

                                            +

                                            order_type

                                            +

                                            No

                                            +

                                            String

                                            +

                                            Sorting order. You can set this parameter to desc (descending order) and asc (ascending order). 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}.

                                            +

                                            Where,

                                            +

                                            center can be set to self (images shared by you) or thirdparty (images shared with you 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. The value can be updated_at (update time), name (image repository name), tag_count (number of tags), namespace (organization), and domain_name (owner).

                                            +

                                            order_type indicates the sorting order. The value can be desc (descending order) or asc (ascending order).

                                            -

                                            Request

                                            • Request parameters

                                              N/A

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

                                            Response

                                            • Response parameters -
                                              Table 2 Request header parameters

                                              Parameter

                                              +

                                              Request Parameters

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

                                              Parameter

                                              Mandatory

                                              +

                                              Mandatory

                                              Type

                                              +

                                              Type

                                              Description

                                              +

                                              Description

                                              Content-Type

                                              +

                                              Content-Type

                                              Yes

                                              +

                                              Yes

                                              String

                                              +

                                              String

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

                                              -

                                              The default value is application/json.

                                              +

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

                                              +

                                              Default value: application/json

                                              X-Auth-Token

                                              +

                                              X-Auth-Token

                                              Yes

                                              +

                                              Yes

                                              String

                                              +

                                              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.

                                              +

                                              User token.

                                              +

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

                                              +
                                              +
                                              +
                                              +

                                              Response Parameters

                                              Status code: 200

                                              + +
                                              + + + + + + +
                                              Table 3 Response header parameter

                                              Parameter

                                              +

                                              Type

                                              +

                                              Description

                                              +

                                              Content-Range

                                              +

                                              String

                                              +

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

                                              -
                                              Table 3 Response body parameter description

                                              Parameter

                                              +
                                              - - - - -
                                              Table 4 Response body parameter

                                              Parameter

                                              Type

                                              +

                                              Type

                                              Description

                                              +

                                              Description

                                              [Array element]

                                              +

                                              [items]

                                              Array of objects

                                              +

                                              Array of ShowReposResp objects

                                              Viewing the list of shared images.

                                              +

                                              Request succeeded.

                                              -
                                              Table 4 [Array element] parameters description

                                              Parameter

                                              +
                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                              Table 5 ShowReposResp

                                              Parameter

                                              Type

                                              +

                                              Type

                                              Description

                                              +

                                              Description

                                              name

                                              +

                                              name

                                              String

                                              +

                                              String

                                              Image repository name.

                                              +

                                              Repository name.

                                              category

                                              +

                                              category

                                              String

                                              +

                                              String

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

                                              +

                                              Repository type. (Each image has multiple labels.)

                                              description

                                              +

                                              description

                                              String

                                              +

                                              String

                                              Image repository description.

                                              +

                                              Repository description.

                                              size

                                              +

                                              size

                                              Integer

                                              +

                                              Long

                                              Total size of the images in an image repository.

                                              +

                                              Repository size.

                                              is_public

                                              +

                                              is_public

                                              Boolean

                                              +

                                              Boolean

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

                                              +

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

                                              num_images

                                              +

                                              num_images

                                              Integer

                                              +

                                              Long

                                              Number of image tags in an image repository.

                                              +

                                              Number of images in a repository, ranging from 0 to 9,223,372,036,854,775,807.

                                              num_download

                                              +

                                              num_download

                                              Integer

                                              +

                                              Long

                                              Download times.

                                              +

                                              The number of downloads.

                                              created_at

                                              +

                                              created_at

                                              String

                                              +

                                              String

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

                                              +

                                              Time when a repository was created. It is the UTC standard time. Users need to calculate the offset based on the local time, for example, UTC+8:00 for the East 8th Time Zone.

                                              updated_at

                                              +

                                              updated_at

                                              String

                                              +

                                              String

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

                                              +

                                              Time when a repository was updated. It is the UTC standard time. Users need to calculate the offset based on the local time, for example, UTC+8:00 for the East 8th Time Zone.

                                              logo

                                              +

                                              logo

                                              String

                                              +

                                              String

                                              (Reserved field) Image repository logo address.

                                              +

                                              Repository logo address (not in use).

                                              url

                                              +

                                              url

                                              String

                                              +

                                              String

                                              (Reserved field) URL of the image repository logo.

                                              +

                                              URL of the repository logo (not in use).

                                              path

                                              +

                                              path

                                              String

                                              +

                                              String

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

                                              +

                                              External image pull address, for example, swr.{region}.mycloud.com/namespace/repository.

                                              internal_path

                                              +

                                              internal_path

                                              String

                                              +

                                              String

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

                                              +

                                              Internal image pull address, for example, 10.125.0.198:20202/namespace/repository.

                                              domain_name

                                              +

                                              domain_name

                                              String

                                              +

                                              String

                                              Domain name.

                                              +

                                              Tenant name.

                                              namespace

                                              +

                                              namespace

                                              String

                                              +

                                              String

                                              Organization name.

                                              +

                                              Tenant organization.

                                              tags

                                              +

                                              tags

                                              Array of strings

                                              +

                                              Array of strings

                                              Image tag list.

                                              +

                                              Image tag list.

                                              status

                                              +

                                              status

                                              Boolean

                                              +

                                              Boolean

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

                                              Query images shared by others: specifies whether the shared images have expired. Query images shared by yourself: The default value is false, which is meaningless.

                                              total_range

                                              +

                                              total_range

                                              Integer

                                              +

                                              Long

                                              Total number of records.

                                              -
                                              -
                                              -
                                            • Example response
                                              [
                                              -    {
                                              -        "name": "busybox",
                                              -        "category": "other",
                                              -        "description": "",
                                              -        "size": 115645792,
                                              -        "is_public": false,
                                              -        "num_images": 1,
                                              -        "num_download": 0,
                                              -        "created_at": "2021-06-02T09:23:01.751202Z",
                                              -        "updated_at": "2021-06-10T07:24:35.204517Z",
                                              -        "logo": "",
                                              -        "url": "",
                                              -        "path": "{Repository address}/group/busybox",
                                              -        "internal_path": "{Repository address}/group/busybox",
                                              -        "domain_name": "domain",
                                              -        "namespace": "namespace",
                                              -        "tags": [
                                              -            "v1",
                                              -            "v2"
                                              -        ],
                                              -        "status": true,
                                              -        "total_range": 1
                                              -    }
                                              -]
                                              -
                                            • - -

                                              Status Code

                                              -
                                              - - - - - - - - - - - - - -

                                              Status Code

                                              -

                                              Description

                                              -

                                              200

                                              -

                                              Request successful.

                                              -

                                              400

                                              -

                                              Request error. Error information is returned.

                                              -

                                              401

                                              -

                                              Authentication failed.

                                              -

                                              500

                                              -

                                              Internal error. Error information is returned.

                                              +

                                              Total number of records.

                                              -

                                              Error Codes

                                              For details, see Error Codes.

                                              +

                                              Example Request

                                              GET https://{endpoint}/v2/manage/shared-repositories
                                              +
                                              +

                                              Example Response

                                              Status code: 200

                                              +

                                              Request succeeded.

                                              +
                                              [ {
                                              +  "name" : "demo",
                                              +  "category" : "other",
                                              +  "description" : "",
                                              +  "size" : 115645792,
                                              +  "is_public" : false,
                                              +  "num_images" : 1,
                                              +  "num_download" : 0,
                                              +  "created_at" : "2018-03-21T12:22:37Z",
                                              +  "updated_at" : "2018-03-21T12:22:37Z",
                                              +  "logo" : "",
                                              +  "url" : "",
                                              +  "path" : "swr.***.mycloud.com/namespace/demo",
                                              +  "internal_path" : "100.125.0.198:20202/namespace/demo",
                                              +  "domain_name" : "domain_name",
                                              +  "namespace" : "namespace",
                                              +  "tags" : [ "latest" ],
                                              +  "status" : true
                                              +} ]
                                              +
                                              +

                                              Status Codes

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

                                              Status Code

                                              +

                                              Description

                                              +

                                              200

                                              +

                                              Request succeeded.

                                              +

                                              400

                                              +

                                              Request error.

                                              +

                                              401

                                              +

                                              Authentication failed.

                                              +

                                              500

                                              +

                                              Internal error.

                                              +
                                              +
                                              +
                                              +

                                              Error Codes

                                              For details, see Error Codes.

                                              diff --git a/docs/swr/api-ref/en-us_topic_0000001420528490.html b/docs/swr/api-ref/swr_02_0076.html similarity index 66% rename from docs/swr/api-ref/en-us_topic_0000001420528490.html rename to docs/swr/api-ref/swr_02_0076.html index 28cb3b2ea..4915e0802 100644 --- a/docs/swr/api-ref/en-us_topic_0000001420528490.html +++ b/docs/swr/api-ref/swr_02_0076.html @@ -1,25 +1,25 @@ - +

                                              Image Repository Management

                                              diff --git a/docs/swr/api-ref/en-us_topic_0000001420688458.html b/docs/swr/api-ref/swr_02_0077.html similarity index 61% rename from docs/swr/api-ref/en-us_topic_0000001420688458.html rename to docs/swr/api-ref/swr_02_0077.html index 2ef6ad22f..901e86a4e 100644 --- a/docs/swr/api-ref/en-us_topic_0000001420688458.html +++ b/docs/swr/api-ref/swr_02_0077.html @@ -1,17 +1,17 @@ - +

                                              Image Tag Management

                                              diff --git a/docs/swr/api-ref/swr_02_0080.html b/docs/swr/api-ref/swr_02_0080.html index 4edbd66fd..c041388d8 100644 --- a/docs/swr/api-ref/swr_02_0080.html +++ b/docs/swr/api-ref/swr_02_0080.html @@ -1,191 +1,184 @@

                                              Querying All API Versions

                                              -

                                              Function

                                              Query all available API versions of SWR.

                                              +

                                              Description

                                              Query all API versions.

                                              -

                                              URI

                                              GET /

                                              +

                                              Constraints

                                              None

                                              -

                                              Request Parameters

                                              -
                                              Table 1 Request header parameters

                                              Parameter

                                              +

                                              URI

                                              GET /

                                              +
                                              +

                                              Request Parameters

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

                                              Parameter

                                              Mandatory

                                              +

                                              Mandatory

                                              Type

                                              +

                                              Type

                                              Description

                                              +

                                              Description

                                              Content-Type

                                              +

                                              Content-Type

                                              Yes

                                              +

                                              Yes

                                              String

                                              +

                                              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.

                                              +

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

                                              +

                                              Default value: application/json

                                              -

                                              Response

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

                                                Parameter

                                                +

                                                Response Parameters

                                                Status code: 200

                                                + +
                                                - - - - -
                                                Table 2 Response body parameter

                                                Parameter

                                                Type

                                                +

                                                Type

                                                Description

                                                +

                                                Description

                                                versions

                                                +

                                                versions

                                                Array of objects

                                                +

                                                Array of VersionDetail objects

                                                A list of objects related to the version.

                                                +

                                                List of all versions.

                                                -
                                                Table 3 versions parameter description

                                                Parameter

                                                +
                                                - - - - - - - - - - - - - - - - - - - -
                                                Table 3 VersionDetail

                                                Parameter

                                                Type

                                                +

                                                Type

                                                Description

                                                +

                                                Description

                                                id

                                                +

                                                id

                                                String

                                                +

                                                String

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

                                                +

                                                Version ID.

                                                links

                                                +

                                                links

                                                Object

                                                +

                                                Link 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.

                                                +

                                                Maximum microversion. If microversions are not supported, the value is empty.

                                                status

                                                +

                                                status

                                                String

                                                +

                                                String

                                                Version status. The options are as follows:

                                                -
                                                • CURRENT: The version is the primary version.
                                                • SUPPORTED: The version is an old version, but it is still supported.
                                                • DEPRECATED: The version is a deprecated version, which may be deleted later.
                                                +

                                                Version status. The value can be:

                                                +
                                                • CURRENT: The version is the primary version.
                                                • SUPPORTED: The version is an earlier 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 in UTC. For example, the release time of v1 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.

                                                +

                                                Minimum microversion. If microversions are not supported, the value is empty.

                                                -
                                                Table 4 links parameter description

                                                Parameter

                                                +
                                                - - - - - - - -
                                                -
                                              • Example response
                                                { 
                                                -   "versions": [
                                                -        {
                                                -            "id": "v2",
                                                -            "links": 
                                                -                {
                                                -                    "href": "https://xxx",
                                                -                    "rel": "self"
                                                -                }
                                                -            "min_version": "2.0",
                                                -            "status": "CURRENT",
                                                -            "updated": "2020-07-09T00:00:00Z",
                                                -            "version": "2.26",
                                                -        }
                                                -    ]
                                                +

                                                Example Request

                                                GET https://{endpoint}
                                                +
                                                +

                                                Example Response

                                                Status code: 200

                                                +

                                                Query succeeded.

                                                +
                                                {
                                                +  "versions" : [ {
                                                +    "id" : "v2",
                                                +    "links" : {
                                                +      "href" : "https://swr-api.xxxx.mycloud.com/v2/",
                                                +      "rel" : "self"
                                                +    },
                                                +    "min_version" : "2.0",
                                                +    "status" : "CURRENT",
                                                +    "updated" : "2020-07-09T00:00:00Z",
                                                +    "version" : "2.26"
                                                +  } ]
                                                 }
                                                -
                                              • -

                                                Status Code

                                                -

                                                Status Code

                                                +

                                                Status Codes

                                                +
                                                - - - - -

                                                Status Code

                                                Description

                                                +

                                                Description

                                                200

                                                +

                                                200

                                                Request successful.

                                                +

                                                Query succeeded.

                                                500

                                                +

                                                500

                                                Failed to complete the request because of an internal service error.

                                                +

                                                Internal error.

                                                -

                                                Error Codes

                                                For details, see Error Codes.

                                                +

                                                Error Codes

                                                For details, see Error Codes.

                                                diff --git a/docs/swr/api-ref/swr_02_0081.html b/docs/swr/api-ref/swr_02_0081.html index 750d8cb6e..f589765db 100644 --- a/docs/swr/api-ref/swr_02_0081.html +++ b/docs/swr/api-ref/swr_02_0081.html @@ -1,214 +1,217 @@ -

                                                Querying a Specific API Version

                                                -

                                                Function

                                                Query a specific API version of SWR.

                                                +

                                                Querying a Specified API Version

                                                +

                                                Description

                                                Query a specified API version.

                                                -

                                                URI

                                                GET /{api_version}

                                                -

                                                For details about parameters, see Table 1.

                                                +

                                                Constraints

                                                None

                                                +
                                                +

                                                URI

                                                GET /{api_version}

                                                -
                                                Table 1 Parameter description

                                                Parameter

                                                +
                                                - - - - - - -
                                                Table 1 Path parameter

                                                Parameter

                                                Mandatory

                                                +

                                                Mandatory

                                                Type

                                                +

                                                Type

                                                Description

                                                +

                                                Description

                                                api_version

                                                +

                                                api_version

                                                Yes

                                                +

                                                Yes

                                                String

                                                +

                                                String

                                                API version

                                                +

                                                API version.

                                                -

                                                Request

                                                • Request parameters -
                                                  Table 2 Request header parameters

                                                  Parameter

                                                  +

                                                  Request Parameters

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

                                                  Parameter

                                                  Mandatory

                                                  +

                                                  Mandatory

                                                  Type

                                                  +

                                                  Type

                                                  Description

                                                  +

                                                  Description

                                                  Content-Type

                                                  +

                                                  Content-Type

                                                  Yes

                                                  +

                                                  Yes

                                                  String

                                                  +

                                                  String

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

                                                  -

                                                  The default value is application/json.

                                                  +

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

                                                  +

                                                  Default value: application/json

                                                  X-Auth-Token

                                                  +

                                                  X-Auth-Token

                                                  Yes

                                                  +

                                                  Yes

                                                  String

                                                  +

                                                  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.

                                                  +

                                                  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 3 Response body parameter description

                                                    Parameter

                                                    +

                                                    Response Parameters

                                                    Status code: 200

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

                                                    Parameter

                                                    Type

                                                    +

                                                    Type

                                                    Description

                                                    +

                                                    Description

                                                    version

                                                    +

                                                    version

                                                    Object

                                                    +

                                                    VersionDetail object

                                                    A list of objects related to the version.

                                                    +

                                                    List of specified versions.

                                                    -
                                                    Table 4 version parameter description

                                                    Parameter

                                                    +
                                                    - - - - - - - - - - - - - - - - - - - -
                                                    Table 4 VersionDetail

                                                    Parameter

                                                    Type

                                                    +

                                                    Type

                                                    Description

                                                    +

                                                    Description

                                                    id

                                                    +

                                                    id

                                                    String

                                                    +

                                                    String

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

                                                    +

                                                    Version ID.

                                                    links

                                                    +

                                                    links

                                                    Object

                                                    +

                                                    Link 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.

                                                    +

                                                    Maximum microversion. If microversions are not supported, the value is empty.

                                                    status

                                                    +

                                                    status

                                                    String

                                                    +

                                                    String

                                                    Version status. The options are as follows:

                                                    -
                                                    • CURRENT: The version is the primary version.
                                                    • SUPPORTED: The version is an old version, but it is still supported.
                                                    • DEPRECATED: The version is a deprecated version, which may be deleted later.
                                                    +

                                                    Version status. The value can be:

                                                    +
                                                    • CURRENT: The version is the primary version.
                                                    • SUPPORTED: The version is an earlier 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 2018-06-28T12:20:21Z.

                                                    +

                                                    Version release time in UTC. For example, the release time of v1 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.

                                                    +

                                                    Minimum microversion. If microversions are not supported, the value is empty.

                                                    -
                                                    Table 5 links parameter description

                                                    Parameter

                                                    +
                                                    - - - - - - - -
                                                    -
                                                  • Example response
                                                    {
                                                    -    "version": {
                                                    -        "id": "v2",
                                                    -        "links": 
                                                    -            {
                                                    -                "href": "https://xxx",
                                                    -                "rel": "self"
                                                    -            }
                                                    -        "min_version": "2.0",
                                                    -        "status": "CURRENT",
                                                    -        "updated": "2017-12-09T00:00:00Z",
                                                    -        "version": "2.26"
                                                    -    }
                                                    +
                                                    +

                                                    Example Request

                                                    GET https://{endpoint}/{api_version}
                                                    +
                                                    +

                                                    Example Response

                                                    Status code: 200

                                                    +

                                                    Query succeeded.

                                                    +
                                                    {
                                                    +  "version" : {
                                                    +    "id" : "v2",
                                                    +    "links" : {
                                                    +      "href" : "https://swr-api.xxxx.mycloud.com/v2/",
                                                    +      "rel" : "self"
                                                    +    },
                                                    +    "min_version" : "2.0",
                                                    +    "status" : "CURRENT",
                                                    +    "updated" : "2017-12-09T00:00:00Z",
                                                    +    "version" : "2.26"
                                                    +  }
                                                     }
                                                    -
                                                  • -

                                                    Status Code

                                                    -

                                                    Status Code

                                                    +

                                                    Status Codes

                                                    +
                                                    - - - - -

                                                    Status Code

                                                    Description

                                                    +

                                                    Description

                                                    200

                                                    +

                                                    200

                                                    Request successful.

                                                    +

                                                    Query succeeded.

                                                    500

                                                    +

                                                    500

                                                    Failed to complete the request because of an internal service error.

                                                    +

                                                    Internal error.

                                                    -

                                                    Error Codes

                                                    For details, see Error Codes.

                                                    +

                                                    Error Codes

                                                    For details, see Error Codes.

                                                    diff --git a/docs/swr/api-ref/swr_02_0088.html b/docs/swr/api-ref/swr_02_0088.html new file mode 100644 index 000000000..c85bafe78 --- /dev/null +++ b/docs/swr/api-ref/swr_02_0088.html @@ -0,0 +1,23 @@ + + +

                                                    Shared Account Management

                                                    +
                                                    + + diff --git a/docs/swr/api-ref/en-us_topic_0000001471005441.html b/docs/swr/api-ref/swr_02_0089.html similarity index 70% rename from docs/swr/api-ref/en-us_topic_0000001471005441.html rename to docs/swr/api-ref/swr_02_0089.html index d9fdf57bd..bd43b7fc5 100644 --- a/docs/swr/api-ref/en-us_topic_0000001471005441.html +++ b/docs/swr/api-ref/swr_02_0089.html @@ -1,4 +1,4 @@ - +

                                                    API Versions

                                                    @@ -6,12 +6,12 @@ diff --git a/docs/swr/api-ref/en-us_topic_0000001421005366.html b/docs/swr/api-ref/swr_02_0090.html similarity index 72% rename from docs/swr/api-ref/en-us_topic_0000001421005366.html rename to docs/swr/api-ref/swr_02_0090.html index 2bc2928fb..81250ddf3 100644 --- a/docs/swr/api-ref/en-us_topic_0000001421005366.html +++ b/docs/swr/api-ref/swr_02_0090.html @@ -1,4 +1,4 @@ - +

                                                    Organization Permission Management

                                                    @@ -6,7 +6,7 @@ diff --git a/docs/swr/api-ref/en-us_topic_0000001470924909.html b/docs/swr/api-ref/swr_02_0091.html similarity index 63% rename from docs/swr/api-ref/en-us_topic_0000001470924909.html rename to docs/swr/api-ref/swr_02_0091.html index 5479373c8..4b3de9406 100644 --- a/docs/swr/api-ref/en-us_topic_0000001470924909.html +++ b/docs/swr/api-ref/swr_02_0091.html @@ -1,12 +1,12 @@ - +

                                                    Image Permission Management

                                                    diff --git a/docs/swr/api-ref/swr_02_0094.html b/docs/swr/api-ref/swr_02_0094.html new file mode 100644 index 000000000..35548954b --- /dev/null +++ b/docs/swr/api-ref/swr_02_0094.html @@ -0,0 +1,25 @@ + + +

                                                    Image Retention Policy Management

                                                    +
                                                    + + diff --git a/docs/swr/api-ref/swr_02_0095.html b/docs/swr/api-ref/swr_02_0095.html new file mode 100644 index 000000000..733a3b5f2 --- /dev/null +++ b/docs/swr/api-ref/swr_02_0095.html @@ -0,0 +1,15 @@ + + +

                                                    Temporary Login Command

                                                    +
                                                    +
                                                    + + + +
                                                    + diff --git a/docs/swr/api-ref/swr_02_0096.html b/docs/swr/api-ref/swr_02_0096.html new file mode 100644 index 000000000..978ef38b8 --- /dev/null +++ b/docs/swr/api-ref/swr_02_0096.html @@ -0,0 +1,15 @@ + + +

                                                    Quota Management

                                                    +
                                                    +
                                                    + + + +
                                                    + diff --git a/docs/swr/api-ref/swr_02_0118.html b/docs/swr/api-ref/swr_02_0118.html new file mode 100644 index 000000000..6a149037a --- /dev/null +++ b/docs/swr/api-ref/swr_02_0118.html @@ -0,0 +1,267 @@ + + +

                                                    Creating an Image Retention Policy

                                                    +

                                                    Description

                                                    Create an image retention policy.

                                                    +
                                                    +

                                                    Constraints

                                                    None

                                                    +
                                                    +

                                                    URI

                                                    POST /v2/manage/namespaces/{namespace}/repos/{repository}/retentions

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

                                                    Parameter

                                                    +

                                                    Mandatory

                                                    +

                                                    Type

                                                    +

                                                    Description

                                                    +

                                                    namespace

                                                    +

                                                    Yes

                                                    +

                                                    String

                                                    +

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

                                                    +

                                                    repository

                                                    +

                                                    Yes

                                                    +

                                                    String

                                                    +

                                                    Image repository name. 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 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.

                                                    +

                                                    Default value: 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.

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

                                                    Parameter

                                                    +

                                                    Mandatory

                                                    +

                                                    Type

                                                    +

                                                    Description

                                                    +

                                                    algorithm

                                                    +

                                                    Yes

                                                    +

                                                    String

                                                    +

                                                    Retention policy matching rule. The value is or.

                                                    +

                                                    rules

                                                    +

                                                    Yes

                                                    +

                                                    Array of Rule objects

                                                    +

                                                    Image retention policy.

                                                    +
                                                    +
                                                    + +
                                                    + + + + + + + + + + + + + + + + + + + + + +
                                                    Table 4 Rule

                                                    Parameter

                                                    +

                                                    Mandatory

                                                    +

                                                    Type

                                                    +

                                                    Description

                                                    +

                                                    template

                                                    +

                                                    Yes

                                                    +

                                                    String

                                                    +

                                                    Retention policy type. The value can be date_rule and tag_rule.

                                                    +

                                                    params

                                                    +

                                                    Yes

                                                    +

                                                    Object

                                                    +

                                                    If template is set to date_rule, set params to {"days": "xxx"}. If template is set to tag_rule, set params to {"num": "xxx"}.

                                                    +

                                                    tag_selectors

                                                    +

                                                    Yes

                                                    +

                                                    Array of TagSelector objects

                                                    +

                                                    Exception images.

                                                    +
                                                    +
                                                    + +
                                                    + + + + + + + + + + + + + + + + +
                                                    Table 5 TagSelector

                                                    Parameter

                                                    +

                                                    Mandatory

                                                    +

                                                    Type

                                                    +

                                                    Description

                                                    +

                                                    kind

                                                    +

                                                    Yes

                                                    +

                                                    String

                                                    +

                                                    Matching rule. The value can be label or regexp.

                                                    +

                                                    pattern

                                                    +

                                                    Yes

                                                    +

                                                    String

                                                    +

                                                    If kind is set to label, set this parameter to the image tag. If kind is set to regexp, set this parameter to a regular expression.

                                                    +
                                                    +
                                                    +
                                                    +

                                                    Response Parameters

                                                    Status code: 201

                                                    + +
                                                    + + + + + + + + + +
                                                    Table 6 Response body parameter

                                                    Parameter

                                                    +

                                                    Type

                                                    +

                                                    Description

                                                    +

                                                    id

                                                    +

                                                    Integer

                                                    +

                                                    Image retention policy ID.

                                                    +
                                                    +
                                                    +
                                                    +

                                                    Example Request

                                                    POST https://{endpoint}/v2/manage/namespaces/{namespace}/repos/{repository}/retentions
                                                    +
                                                    +{
                                                    +  "algorithm" : "string",
                                                    +  "rules" : [ {
                                                    +    "params" : { },
                                                    +    "tag_selectors" : [ {
                                                    +      "kind" : "string",
                                                    +      "pattern" : "string"
                                                    +    } ],
                                                    +    "template" : "string"
                                                    +  } ]
                                                    +}
                                                    +
                                                    +

                                                    Example Response

                                                    Status code: 201

                                                    +

                                                    Creation succeeded.

                                                    +
                                                    {
                                                    +  "id" : 34
                                                    +}
                                                    +
                                                    +

                                                    Status Codes

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

                                                    Status Code

                                                    +

                                                    Description

                                                    +

                                                    201

                                                    +

                                                    Creation succeeded.

                                                    +

                                                    400

                                                    +

                                                    Request error.

                                                    +

                                                    401

                                                    +

                                                    Authentication failed.

                                                    +

                                                    404

                                                    +

                                                    The organization or repository was not found.

                                                    +

                                                    500

                                                    +

                                                    Internal error.

                                                    +
                                                    +
                                                    +
                                                    +

                                                    Error Codes

                                                    For details, see Error Codes.

                                                    +
                                                    +
                                                    +
                                                    + +
                                                    + diff --git a/docs/swr/api-ref/swr_02_0119.html b/docs/swr/api-ref/swr_02_0119.html new file mode 100644 index 000000000..d806b0c3a --- /dev/null +++ b/docs/swr/api-ref/swr_02_0119.html @@ -0,0 +1,19 @@ + + +

                                                    Other

                                                    +
                                                    + + diff --git a/docs/swr/api-ref/swr_02_0120.html b/docs/swr/api-ref/swr_02_0120.html new file mode 100644 index 000000000..9648137ea --- /dev/null +++ b/docs/swr/api-ref/swr_02_0120.html @@ -0,0 +1,162 @@ + + +

                                                    Querying the Tenant Resource Overview

                                                    +

                                                    Description

                                                    Query the tenant resource overview.

                                                    +
                                                    +

                                                    Constraints

                                                    None

                                                    +
                                                    +

                                                    URI

                                                    GET /v2/manage/overview

                                                    +
                                                    +

                                                    Request Parameters

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

                                                    Parameter

                                                    +

                                                    Mandatory

                                                    +

                                                    Type

                                                    +

                                                    Description

                                                    +

                                                    Content-Type

                                                    +

                                                    Yes

                                                    +

                                                    String

                                                    +

                                                    Message body type (format). Possible values:

                                                    +

                                                    application/json;charset=utf-8

                                                    +

                                                    application/json

                                                    +

                                                    X-Auth-Token

                                                    +

                                                    Yes

                                                    +

                                                    String

                                                    +

                                                    User token.

                                                    +

                                                    It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

                                                    +
                                                    +
                                                    +
                                                    +

                                                    Response Parameters

                                                    Status code: 200

                                                    + +
                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                    Table 2 Response body parameters

                                                    Parameter

                                                    +

                                                    Type

                                                    +

                                                    Description

                                                    +

                                                    domain_id

                                                    +

                                                    String

                                                    +

                                                    Tenant ID.

                                                    +

                                                    domain_name

                                                    +

                                                    String

                                                    +

                                                    Tenant name.

                                                    +

                                                    namspace_num

                                                    +

                                                    Integer

                                                    +

                                                    Number of namespaces of the tenant.

                                                    +

                                                    repo_num

                                                    +

                                                    Integer

                                                    +

                                                    Number of repositories of the tenant.

                                                    +

                                                    image_num

                                                    +

                                                    Integer

                                                    +

                                                    Number of images of the tenant.

                                                    +

                                                    store_space

                                                    +

                                                    Double

                                                    +

                                                    Storage size of the tenant.

                                                    +

                                                    downflow_size

                                                    +

                                                    Double

                                                    +

                                                    Download traffic of the tenant.

                                                    +
                                                    +
                                                    +
                                                    +

                                                    Example Request

                                                    GET https://{endpoint}/v2/manage/overview
                                                    +
                                                    +

                                                    Example Response

                                                    Status code: 200

                                                    +

                                                    Query the tenant resource overview.

                                                    +
                                                    {
                                                    +  "domain_id" : "08d35*********113760",
                                                    +  "domain_name" : "",
                                                    +  "namspace_num" : 36,
                                                    +  "repo_num" : 20,
                                                    +  "image_num" : 36,
                                                    +  "store_space" : 99.21,
                                                    +  "downflow_size" : 0
                                                    +}
                                                    +
                                                    +

                                                    Status Codes

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

                                                    Status Code

                                                    +

                                                    Description

                                                    +

                                                    200

                                                    +

                                                    Succeeded.

                                                    +

                                                    400

                                                    +

                                                    Request error.

                                                    +

                                                    401

                                                    +

                                                    Authentication failed.

                                                    +

                                                    500

                                                    +

                                                    Internal error.

                                                    +
                                                    +
                                                    +
                                                    +

                                                    Error Codes

                                                    For details, see Error Codes.

                                                    +
                                                    +
                                                    +
                                                    + +
                                                    + diff --git a/docs/swr/api-ref/swr_02_0121.html b/docs/swr/api-ref/swr_02_0121.html new file mode 100644 index 000000000..9c1c26677 --- /dev/null +++ b/docs/swr/api-ref/swr_02_0121.html @@ -0,0 +1,176 @@ + + +

                                                    Querying Tenant Resource Statistics

                                                    +

                                                    Description

                                                    Query tenant resource statistics.

                                                    +
                                                    +

                                                    Constraints

                                                    None

                                                    +
                                                    +

                                                    URI

                                                    GET /v2/manage/reports/{resource_type}/{frequency}

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

                                                    Parameter

                                                    +

                                                    Mandatory

                                                    +

                                                    Type

                                                    +

                                                    Description

                                                    +

                                                    resource_type

                                                    +

                                                    Yes

                                                    +

                                                    String

                                                    +

                                                    Resource type.

                                                    +

                                                    frequency

                                                    +

                                                    Yes

                                                    +

                                                    String

                                                    +

                                                    Frequency type.

                                                    +
                                                    +
                                                    +
                                                    +

                                                    Request Parameters

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

                                                    Parameter

                                                    +

                                                    Mandatory

                                                    +

                                                    Type

                                                    +

                                                    Description

                                                    +

                                                    Content-Type

                                                    +

                                                    Yes

                                                    +

                                                    String

                                                    +

                                                    Message body type (format). Possible values:

                                                    +

                                                    application/json;charset=utf-8

                                                    +

                                                    application/json

                                                    +

                                                    X-Auth-Token

                                                    +

                                                    Yes

                                                    +

                                                    String

                                                    +

                                                    User token.

                                                    +

                                                    It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

                                                    +
                                                    +
                                                    +
                                                    +

                                                    Response Parameters

                                                    Status code: 200

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

                                                    Parameter

                                                    +

                                                    Type

                                                    +

                                                    Description

                                                    +

                                                    [items]

                                                    +

                                                    Array of ReportData objects

                                                    +

                                                    Statistics.

                                                    +
                                                    +
                                                    + +
                                                    + + + + + + + + + + + + + +
                                                    Table 4 ReportData

                                                    Parameter

                                                    +

                                                    Type

                                                    +

                                                    Description

                                                    +

                                                    date

                                                    +

                                                    String

                                                    +

                                                    Time point.

                                                    +

                                                    value

                                                    +

                                                    Double

                                                    +

                                                    Statistics.

                                                    +
                                                    +
                                                    +
                                                    +

                                                    Example Request

                                                    GET https://{endpoint}/v2/reports/{resource_type}/{frequency}
                                                    +
                                                    +

                                                    Example Response

                                                    Status code: 200

                                                    +

                                                    Query tenant resource statistics.

                                                    +
                                                    [ {
                                                    +  "date" : "2024-09-01",
                                                    +  "value" : 0
                                                    +}, {
                                                    +  "date" : "2024-09-02",
                                                    +  "value" : 0
                                                    +} ]
                                                    +
                                                    +

                                                    Status Codes

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

                                                    Status Codes

                                                    +

                                                    Description

                                                    +

                                                    200

                                                    +

                                                    Succeeded.

                                                    +

                                                    400

                                                    +

                                                    Request error.

                                                    +

                                                    401

                                                    +

                                                    Authentication failed.

                                                    +

                                                    500

                                                    +

                                                    Internal error.

                                                    +
                                                    +
                                                    +
                                                    +

                                                    Error Codes

                                                    For details, see Error Codes.

                                                    +
                                                    +
                                                    +
                                                    + +
                                                    + diff --git a/docs/swr/api-ref/swr_02_0122.html b/docs/swr/api-ref/swr_02_0122.html new file mode 100644 index 000000000..fab474152 --- /dev/null +++ b/docs/swr/api-ref/swr_02_0122.html @@ -0,0 +1,182 @@ + + +

                                                    Querying Service Feature Status

                                                    +

                                                    Description

                                                    Query service feature status.

                                                    +
                                                    +

                                                    Constraints

                                                    None

                                                    +
                                                    +

                                                    URI

                                                    GET /v2/manage/projects/{project_id}/feature-gates

                                                    + +
                                                    + + + + + + + + + + + +
                                                    Table 1 Path parameter

                                                    Parameter

                                                    +

                                                    Mandatory

                                                    +

                                                    Type

                                                    +

                                                    Description

                                                    +

                                                    project_id

                                                    +

                                                    Yes

                                                    +

                                                    String

                                                    +

                                                    Project ID.

                                                    +
                                                    +
                                                    +
                                                    +

                                                    Request Parameters

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

                                                    Parameter

                                                    +

                                                    Mandatory

                                                    +

                                                    Type

                                                    +

                                                    Description

                                                    +

                                                    X-Auth-Token

                                                    +

                                                    Yes

                                                    +

                                                    String

                                                    +

                                                    User token.

                                                    +

                                                    It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

                                                    +
                                                    +
                                                    +
                                                    +

                                                    Response Parameters

                                                    Status code: 200

                                                    + +
                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                    Table 3 Response body parameters

                                                    Parameter

                                                    +

                                                    Type

                                                    +

                                                    Description

                                                    +

                                                    enable_experience

                                                    +

                                                    Boolean

                                                    +

                                                    Whether the experience center is enabled.

                                                    +

                                                    enable_hss_service

                                                    +

                                                    Boolean

                                                    +

                                                    Whether interconnection with HSS is enabled.

                                                    +

                                                    enable_image_scan

                                                    +

                                                    Boolean

                                                    +

                                                    Whether image scanning is enabled.

                                                    +

                                                    enable_sm3

                                                    +

                                                    Boolean

                                                    +

                                                    Whether SM algorithms are enabled.

                                                    +

                                                    enable_image_sync

                                                    +

                                                    Boolean

                                                    +

                                                    Whether image synchronization is enabled.

                                                    +

                                                    enable_cci_service

                                                    +

                                                    Boolean

                                                    +

                                                    Whether interconnection with CCI is enabled.

                                                    +

                                                    enable_image_label

                                                    +

                                                    Boolean

                                                    +

                                                    Whether image tagging is enabled.

                                                    +

                                                    enable_pipeline

                                                    +

                                                    Boolean

                                                    +

                                                    Whether the pipeline service is enabled.

                                                    +
                                                    +
                                                    +
                                                    +

                                                    Example Request

                                                    GET https://{endpoint}/v2/manage/projects/{project_id}/feature-gates
                                                    +
                                                    +

                                                    Example Response

                                                    Status code: 200

                                                    +

                                                    Query service feature status.

                                                    +
                                                    {
                                                    +  "enable_experience" : true,
                                                    +  "enable_hss_service" : true,
                                                    +  "enable_image_scan" : true,
                                                    +  "enable_sm3" : true,
                                                    +  "enable_image_sync" : true,
                                                    +  "enable_cci_service" : true,
                                                    +  "enable_image_label" : false,
                                                    +  "enable_pipeline" : false,
                                                    +}
                                                    +
                                                    +

                                                    Status Codes

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

                                                    Status Code

                                                    +

                                                    Description

                                                    +

                                                    200

                                                    +

                                                    Succeeded.

                                                    +

                                                    400

                                                    +

                                                    Request error.

                                                    +

                                                    401

                                                    +

                                                    Authentication failed.

                                                    +

                                                    500

                                                    +

                                                    Internal error.

                                                    +
                                                    +
                                                    +
                                                    +

                                                    Error Codes

                                                    For details, see Error Codes.

                                                    +
                                                    +
                                                    +
                                                    + +
                                                    +