From ab04d480742b27901d1e49203cb1b4bd580dae72 Mon Sep 17 00:00:00 2001 From: "Wei, Hongmin" Date: Fri, 17 Nov 2023 10:45:11 +0000 Subject: [PATCH] TMS API 1024 Version Reviewed-by: Ziuzko, Alevtina Co-authored-by: Wei, Hongmin Co-committed-by: Wei, Hongmin --- docs/tms/api-ref/ALL_META.TXT.json | 357 +++++++- docs/tms/api-ref/CLASS.TXT.json | 135 ++- docs/tms/api-ref/CreateResourceTag.html | 237 +++++ docs/tms/api-ref/DeleteResourceTag.html | 223 +++++ docs/tms/api-ref/GetResourceTag.html | 161 ++++ docs/tms/api-ref/ListProviders.html | 910 +++++++++++++++++++ docs/tms/api-ref/ListResource.html | 348 +++++++ docs/tms/api-ref/ListTagKeys.html | 153 ++++ docs/tms/api-ref/ListTagValues.html | 162 ++++ docs/tms/api-ref/ShowTagQuota.html | 117 +++ docs/tms/api-ref/en-us_topic_0056765894.html | 6 + docs/tms/api-ref/en-us_topic_0056765935.html | 61 +- docs/tms/api-ref/en-us_topic_0056765936.html | 99 +- docs/tms/api-ref/en-us_topic_0057939857.html | 125 ++- docs/tms/api-ref/en-us_topic_0057939858.html | 34 +- docs/tms/api-ref/en-us_topic_0060929630.html | 69 +- docs/tms/api-ref/en-us_topic_0133313256.html | 6 +- docs/tms/api-ref/en-us_topic_0133313257.html | 4 +- docs/tms/api-ref/en-us_topic_0180205869.html | 93 +- docs/tms/api-ref/topic_300000002.html | 16 + docs/tms/api-ref/topic_300000003.html | 26 + docs/tms/api-ref/topic_300000004.html | 16 + 22 files changed, 3219 insertions(+), 139 deletions(-) create mode 100644 docs/tms/api-ref/CreateResourceTag.html create mode 100644 docs/tms/api-ref/DeleteResourceTag.html create mode 100644 docs/tms/api-ref/GetResourceTag.html create mode 100644 docs/tms/api-ref/ListProviders.html create mode 100644 docs/tms/api-ref/ListResource.html create mode 100644 docs/tms/api-ref/ListTagKeys.html create mode 100644 docs/tms/api-ref/ListTagValues.html create mode 100644 docs/tms/api-ref/ShowTagQuota.html create mode 100644 docs/tms/api-ref/topic_300000002.html create mode 100644 docs/tms/api-ref/topic_300000003.html create mode 100644 docs/tms/api-ref/topic_300000004.html diff --git a/docs/tms/api-ref/ALL_META.TXT.json b/docs/tms/api-ref/ALL_META.TXT.json index c646df94e..2278f94a5 100644 --- a/docs/tms/api-ref/ALL_META.TXT.json +++ b/docs/tms/api-ref/ALL_META.TXT.json @@ -1,171 +1,508 @@ [ + { + "dockw":"API Reference" + }, { "uri":"en-us_topic_0056283725.html", + "node_id":"en-us_topic_0056283725.xml", "product_code":"tms", "code":"1", "des":"Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform ", "doc_type":"api", "kw":"APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"tms" + } + ], "title":"APIs", "githuburl":"" }, { "uri":"en-us_topic_0056765894.html", + "node_id":"en-us_topic_0056765894.xml", "product_code":"tms", "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 Description", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"tms" + } + ], "title":"API Description", "githuburl":"" }, { "uri":"en-us_topic_0133313255.html", + "node_id":"en-us_topic_0133313255.xml", "product_code":"tms", "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.", "doc_type":"api", "kw":"Querying the API Version", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"tms" + } + ], "title":"Querying the API Version", "githuburl":"" }, { "uri":"en-us_topic_0133313256.html", + "node_id":"en-us_topic_0133313256.xml", "product_code":"tms", "code":"4", "des":"This API is used to query the versions of all TMS APIs.GET /Example requestParameter descriptionParameters in the responseNameTypeDescriptionversionsArraySpecifies all AP", "doc_type":"api", "kw":"Querying the API Versions,Querying the API Version,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"tms" + } + ], "title":"Querying the API Versions", "githuburl":"" }, { "uri":"en-us_topic_0133313257.html", + "node_id":"en-us_topic_0133313257.xml", "product_code":"tms", "code":"5", "des":"This API is used to query the details of a specified TMS API version.GET /{api_version}Parameter descriptionParameters in the requestParameterMandatoryTypeDescriptionapi_", "doc_type":"api", "kw":"Querying Details About a Specified TMS API Version,Querying the API Version,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"tms" + } + ], "title":"Querying Details About a Specified TMS API Version", "githuburl":"" }, { "uri":"en-us_topic_0133313258.html", + "node_id":"en-us_topic_0133313258.xml", "product_code":"tms", "code":"6", "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":"Predefined Tag Operations", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"tms" + } + ], "title":"Predefined Tag Operations", "githuburl":"" }, { "uri":"en-us_topic_0056765935.html", + "node_id":"en-us_topic_0056765935.xml", "product_code":"tms", "code":"7", "des":"This API is used to create or delete predefined tags. You can add tags to resources using the predefined tags.This API supports idempotency and batch processing.Idempoten", "doc_type":"api", "kw":"Creating or Deleting Predefined Tags,Predefined Tag Operations,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"tms" + } + ], "title":"Creating or Deleting Predefined Tags", "githuburl":"" }, { "uri":"en-us_topic_0056765936.html", + "node_id":"en-us_topic_0056765936.xml", "product_code":"tms", "code":"8", - "des":"This API is used to query predefined tags.GET /v1.0/predefine_tagsParameter descriptionParameters in the requestNameMandatoryTypeDescriptionkeyNoStringSpecifies the key.S", + "des":"This API is used to query predefined tags.GET /v1.0/predefine_tagsParameter descriptionRequest header parametersParameterMandatoryTypeDescriptionX-Auth-TokenYesStringSpec", "doc_type":"api", "kw":"Querying Predefined Tags,Predefined Tag Operations,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"tms" + } + ], "title":"Querying Predefined Tags", "githuburl":"" }, { "uri":"en-us_topic_0060929630.html", + "node_id":"en-us_topic_0060929630.xml", "product_code":"tms", "code":"9", - "des":"This API is used for modifying predefined tags.PUT /v1.0/predefine_tagsParameter descriptionParameters in the requestNameMandatoryTypeDescriptionold_tagYesObjectSpecifies", + "des":"This API is used for modifying predefined tags.PUT /v1.0/predefine_tagsParameter descriptionRequest header parametersParameterMandatoryTypeDescriptionX-Auth-TokenYesStrin", "doc_type":"api", "kw":"Modifying Predefined Tags,Predefined Tag Operations,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"tms" + } + ], "title":"Modifying Predefined Tags", "githuburl":"" }, { - "uri":"en-us_topic_0170638684.html", + "uri":"topic_300000002.html", + "node_id":"topic_300000002.xml", "product_code":"tms", "code":"10", "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":"Quotas", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"tms" + } + ], + "title":"Quotas", + "githuburl":"" + }, + { + "uri":"ShowTagQuota.html", + "node_id":"showtagquota.xml", + "product_code":"tms", + "code":"11", + "des":"This API is used to query tag quotas.GET /v1.0/tms/quotasStatus code: 200Querying tag quotasStatus code: 200Successful operationSee Status Codes.See Error Codes.", + "doc_type":"api", + "kw":"Querying Tag Quotas,Quotas,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"tms" + } + ], + "title":"Querying Tag Quotas", + "githuburl":"" + }, + { + "uri":"topic_300000003.html", + "node_id":"topic_300000003.xml", + "product_code":"tms", + "code":"12", + "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":"Resource Tags", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"tms" + } + ], + "title":"Resource Tags", + "githuburl":"" + }, + { + "uri":"CreateResourceTag.html", + "node_id":"createresourcetag.xml", + "product_code":"tms", + "code":"13", + "des":"You can use this API to add tags to multiple resources. Up to 10 tags can be added to a resource and a maximum of 50 resources can be tagged at a time.POST /v1.0/resource", + "doc_type":"api", + "kw":"Batch Adding Tags,Resource Tags,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"tms" + } + ], + "title":"Batch Adding Tags", + "githuburl":"" + }, + { + "uri":"DeleteResourceTag.html", + "node_id":"deleteresourcetag.xml", + "product_code":"tms", + "code":"14", + "des":"You can use this API to remove tags from multiple resources. Up to 10 tags can be removed from a resource and a maximum of 50 resources can be operated at a time.POST /v1", + "doc_type":"api", + "kw":"Batch Removing Tags,Resource Tags,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"tms" + } + ], + "title":"Batch Removing Tags", + "githuburl":"" + }, + { + "uri":"ListTagKeys.html", + "node_id":"listtagkeys.xml", + "product_code":"tms", + "code":"15", + "des":"You can use this API to query any tag key in a specified region.GET /v1.0/tag-keysStatus code: 200Query tag keysStatus code: 200Successful operationSee Status Codes.See E", + "doc_type":"api", + "kw":"Querying Tag Keys,Resource Tags,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"tms" + } + ], + "title":"Querying Tag Keys", + "githuburl":"" + }, + { + "uri":"ListTagValues.html", + "node_id":"listtagvalues.xml", + "product_code":"tms", + "code":"16", + "des":"You can use this API to query any tag value in a specified region.GET /v1.0/tag-valuesStatus code: 200Querying tag valuesStatus code: 200Successful operationSee Status Co", + "doc_type":"api", + "kw":"Query Tag Values,Resource Tags,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"tms" + } + ], + "title":"Query Tag Values", + "githuburl":"" + }, + { + "uri":"GetResourceTag.html", + "node_id":"getresourcetag.xml", + "product_code":"tms", + "code":"17", + "des":"You can use this API to query tags of a specific resource.GET /v2.0/resources/{resource_id}/tagsStatus code: 200Querying tags of a resourceStatus code: 200Successful oper", + "doc_type":"api", + "kw":"Querying Resource Tags,Resource Tags,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"tms" + } + ], + "title":"Querying Resource Tags", + "githuburl":"" + }, + { + "uri":"ListResource.html", + "node_id":"listresource.xml", + "product_code":"tms", + "code":"18", + "des":"You can use this API to filter resources by tag.POST /v1.0/resource-instances/filterStatus code: 200Filtering resources by tagStatus code: 200Successful operationSee Stat", + "doc_type":"api", + "kw":"Querying Resources by Tag,Resource Tags,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"tms" + } + ], + "title":"Querying Resources by Tag", + "githuburl":"" + }, + { + "uri":"topic_300000004.html", + "node_id":"topic_300000004.xml", + "product_code":"tms", + "code":"19", + "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":"Querying Services Supported by TMS", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"tms" + } + ], + "title":"Querying Services Supported by TMS", + "githuburl":"" + }, + { + "uri":"ListProviders.html", + "node_id":"listproviders.xml", + "product_code":"tms", + "code":"20", + "des":"You can use this API to query services supported by TMS.GET /v1.0/tms/providersStatus code: 200Querying supported services by TMSStatus code: 200Successful operationSee S", + "doc_type":"api", + "kw":"Querying Services Supported by TMS,Querying Services Supported by TMS,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"tms" + } + ], + "title":"Querying Services Supported by TMS", + "githuburl":"" + }, + { + "uri":"en-us_topic_0170638684.html", + "node_id":"en-us_topic_0170638684.xml", + "product_code":"tms", + "code":"21", + "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":"Permissions Policies and Supported Actions", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"tms" + } + ], "title":"Permissions Policies and Supported Actions", "githuburl":"" }, { "uri":"en-us_topic_0180205868.html", + "node_id":"en-us_topic_0180205868.xml", "product_code":"tms", - "code":"11", + "code":"22", "des":"You can use Identity and Access Management (IAM) for fine-grained permissions management of your TMS resources. If your account does not need individual IAM users, you ca", "doc_type":"api", "kw":"Introduction,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"tms" + } + ], "title":"Introduction", "githuburl":"" }, { "uri":"en-us_topic_0180205869.html", + "node_id":"en-us_topic_0180205869.xml", "product_code":"tms", - "code":"12", + "code":"23", "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":"TMS API Actions,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"tms" + } + ], "title":"TMS API Actions", "githuburl":"" }, { "uri":"en-us_topic_0126416865.html", + "node_id":"en-us_topic_0126416865.xml", "product_code":"tms", - "code":"13", + "code":"24", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Appendix", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"tms" + } + ], "title":"Appendix", "githuburl":"" }, { "uri":"en-us_topic_0130578970.html", + "node_id":"en-us_topic_0130578970.xml", "product_code":"tms", - "code":"14", + "code":"25", "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,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"tms" + } + ], "title":"Status Codes", "githuburl":"" }, { "uri":"en-us_topic_0057939857.html", + "node_id":"en-us_topic_0057939857.xml", "product_code":"tms", - "code":"15", + "code":"26", "des":"If the returned status code of a TMS API is 400, the customized error information will also be returned. This section describes the meaning of each TMS error code.", "doc_type":"api", "kw":"Error Codes,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"tms" + } + ], "title":"Error Codes", "githuburl":"" }, { "uri":"en-us_topic_0126416752.html", + "node_id":"en-us_topic_0126416752.xml", "product_code":"tms", - "code":"16", + "code":"27", "des":"A project ID is required for some URLs when an API is called. Therefore, you need to obtain a project ID in advance. Two methods are available:Obtain the Project ID by Ca", "doc_type":"api", "kw":"Obtaining a Project ID,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"tms" + } + ], "title":"Obtaining a Project ID", "githuburl":"" }, { "uri":"en-us_topic_0057939858.html", + "node_id":"en-us_topic_0057939858.xml", "product_code":"tms", - "code":"17", + "code":"28", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Change History,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"tms" + } + ], "title":"Change History", "githuburl":"" } diff --git a/docs/tms/api-ref/CLASS.TXT.json b/docs/tms/api-ref/CLASS.TXT.json index b6038036e..adb75717a 100644 --- a/docs/tms/api-ref/CLASS.TXT.json +++ b/docs/tms/api-ref/CLASS.TXT.json @@ -63,7 +63,7 @@ "code":"7" }, { - "desc":"This API is used to query predefined tags.GET /v1.0/predefine_tagsParameter descriptionParameters in the requestNameMandatoryTypeDescriptionkeyNoStringSpecifies the key.S", + "desc":"This API is used to query predefined tags.GET /v1.0/predefine_tagsParameter descriptionRequest header parametersParameterMandatoryTypeDescriptionX-Auth-TokenYesStringSpec", "product_code":"tms", "title":"Querying Predefined Tags", "uri":"en-us_topic_0056765936.html", @@ -72,7 +72,7 @@ "code":"8" }, { - "desc":"This API is used for modifying predefined tags.PUT /v1.0/predefine_tagsParameter descriptionParameters in the requestNameMandatoryTypeDescriptionold_tagYesObjectSpecifies", + "desc":"This API is used for modifying predefined tags.PUT /v1.0/predefine_tagsParameter descriptionRequest header parametersParameterMandatoryTypeDescriptionX-Auth-TokenYesStrin", "product_code":"tms", "title":"Modifying Predefined Tags", "uri":"en-us_topic_0060929630.html", @@ -83,29 +83,128 @@ { "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":"tms", - "title":"Permissions Policies and Supported Actions", - "uri":"en-us_topic_0170638684.html", + "title":"Quotas", + "uri":"topic_300000002.html", "doc_type":"api", - "p_code":"", + "p_code":"2", "code":"10" }, { - "desc":"You can use Identity and Access Management (IAM) for fine-grained permissions management of your TMS resources. If your account does not need individual IAM users, you ca", + "desc":"This API is used to query tag quotas.GET /v1.0/tms/quotasStatus code: 200Querying tag quotasStatus code: 200Successful operationSee Status Codes.See Error Codes.", "product_code":"tms", - "title":"Introduction", - "uri":"en-us_topic_0180205868.html", + "title":"Querying Tag Quotas", + "uri":"ShowTagQuota.html", "doc_type":"api", "p_code":"10", "code":"11" }, + { + "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":"tms", + "title":"Resource Tags", + "uri":"topic_300000003.html", + "doc_type":"api", + "p_code":"2", + "code":"12" + }, + { + "desc":"You can use this API to add tags to multiple resources. Up to 10 tags can be added to a resource and a maximum of 50 resources can be tagged at a time.POST /v1.0/resource", + "product_code":"tms", + "title":"Batch Adding Tags", + "uri":"CreateResourceTag.html", + "doc_type":"api", + "p_code":"12", + "code":"13" + }, + { + "desc":"You can use this API to remove tags from multiple resources. Up to 10 tags can be removed from a resource and a maximum of 50 resources can be operated at a time.POST /v1", + "product_code":"tms", + "title":"Batch Removing Tags", + "uri":"DeleteResourceTag.html", + "doc_type":"api", + "p_code":"12", + "code":"14" + }, + { + "desc":"You can use this API to query any tag key in a specified region.GET /v1.0/tag-keysStatus code: 200Query tag keysStatus code: 200Successful operationSee Status Codes.See E", + "product_code":"tms", + "title":"Querying Tag Keys", + "uri":"ListTagKeys.html", + "doc_type":"api", + "p_code":"12", + "code":"15" + }, + { + "desc":"You can use this API to query any tag value in a specified region.GET /v1.0/tag-valuesStatus code: 200Querying tag valuesStatus code: 200Successful operationSee Status Co", + "product_code":"tms", + "title":"Query Tag Values", + "uri":"ListTagValues.html", + "doc_type":"api", + "p_code":"12", + "code":"16" + }, + { + "desc":"You can use this API to query tags of a specific resource.GET /v2.0/resources/{resource_id}/tagsStatus code: 200Querying tags of a resourceStatus code: 200Successful oper", + "product_code":"tms", + "title":"Querying Resource Tags", + "uri":"GetResourceTag.html", + "doc_type":"api", + "p_code":"12", + "code":"17" + }, + { + "desc":"You can use this API to filter resources by tag.POST /v1.0/resource-instances/filterStatus code: 200Filtering resources by tagStatus code: 200Successful operationSee Stat", + "product_code":"tms", + "title":"Querying Resources by Tag", + "uri":"ListResource.html", + "doc_type":"api", + "p_code":"12", + "code":"18" + }, + { + "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":"tms", + "title":"Querying Services Supported by TMS", + "uri":"topic_300000004.html", + "doc_type":"api", + "p_code":"2", + "code":"19" + }, + { + "desc":"You can use this API to query services supported by TMS.GET /v1.0/tms/providersStatus code: 200Querying supported services by TMSStatus code: 200Successful operationSee S", + "product_code":"tms", + "title":"Querying Services Supported by TMS", + "uri":"ListProviders.html", + "doc_type":"api", + "p_code":"19", + "code":"20" + }, + { + "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":"tms", + "title":"Permissions Policies and Supported Actions", + "uri":"en-us_topic_0170638684.html", + "doc_type":"api", + "p_code":"", + "code":"21" + }, + { + "desc":"You can use Identity and Access Management (IAM) for fine-grained permissions management of your TMS resources. If your account does not need individual IAM users, you ca", + "product_code":"tms", + "title":"Introduction", + "uri":"en-us_topic_0180205868.html", + "doc_type":"api", + "p_code":"21", + "code":"22" + }, { "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":"tms", "title":"TMS API Actions", "uri":"en-us_topic_0180205869.html", "doc_type":"api", - "p_code":"10", - "code":"12" + "p_code":"21", + "code":"23" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -114,7 +213,7 @@ "uri":"en-us_topic_0126416865.html", "doc_type":"api", "p_code":"", - "code":"13" + "code":"24" }, { "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.", @@ -122,8 +221,8 @@ "title":"Status Codes", "uri":"en-us_topic_0130578970.html", "doc_type":"api", - "p_code":"13", - "code":"14" + "p_code":"24", + "code":"25" }, { "desc":"If the returned status code of a TMS API is 400, the customized error information will also be returned. This section describes the meaning of each TMS error code.", @@ -131,8 +230,8 @@ "title":"Error Codes", "uri":"en-us_topic_0057939857.html", "doc_type":"api", - "p_code":"13", - "code":"15" + "p_code":"24", + "code":"26" }, { "desc":"A project ID is required for some URLs when an API is called. Therefore, you need to obtain a project ID in advance. Two methods are available:Obtain the Project ID by Ca", @@ -140,8 +239,8 @@ "title":"Obtaining a Project ID", "uri":"en-us_topic_0126416752.html", "doc_type":"api", - "p_code":"13", - "code":"16" + "p_code":"24", + "code":"27" }, { "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.", @@ -150,6 +249,6 @@ "uri":"en-us_topic_0057939858.html", "doc_type":"api", "p_code":"", - "code":"17" + "code":"28" } ] \ No newline at end of file diff --git a/docs/tms/api-ref/CreateResourceTag.html b/docs/tms/api-ref/CreateResourceTag.html new file mode 100644 index 000000000..fdf83c215 --- /dev/null +++ b/docs/tms/api-ref/CreateResourceTag.html @@ -0,0 +1,237 @@ + + +

Batch Adding Tags

+

Function

You can use this API to add tags to multiple resources. Up to 10 tags can be added to a resource and a maximum of 50 resources can be tagged at a time.

+
+

URI

POST /v1.0/resource-tags/batch-create

+
+

Request

+
+ + + + + + + + + + + +
Table 1 Header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token. TMS is a global service. So you need to set scope to domain when calling an IAM API to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

No

+

String

+

Specifies the project ID. This parameter is mandatory when resource_type is at a region level.

+

resources

+

Yes

+

Array of ResourceTagBody objects

+

Specifies resources.

+

tags

+

Yes

+

Array of CreateTagRequest objects

+

Specifies tags.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 ResourceTagBody

Parameter

+

Mandatory

+

Type

+

Description

+

resource_id

+

Yes

+

String

+

Specifies the resource ID.

+

resource_type

+

Yes

+

String

+

Specifies the resource type.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 CreateTagRequest

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Specifies the key.

+

It cannot be left blank and can contain a maximum of 36 Unicode characters. Only digits, letters, hyphens (-), at signs (@), and underscores (_) are allowed.

+

value

+

Yes

+

String

+

Specifies the value.

+

Each value contains a maximum of 43 Unicode characters and can be an empty string. Only digits, letters, hyphens (-), at signs (@), and underscores (_) are allowed.

+
+
+
+

Response

Status code: 200

+ +
+ + + + + + + + + +
Table 5 Body parameters

Parameter

+

Type

+

Description

+

failed_resources

+

Array of TagCreateResponseItem objects

+

Specifies resources for which tags fail to be added.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 6 TagCreateResponseItem

Parameter

+

Type

+

Description

+

resource_id

+

String

+

Specifies the resource ID.

+

resource_type

+

String

+

Specifies the resource type.

+

error_code

+

String

+

Error Codes

+

error_msg

+

String

+

Specifies the error.

+
+
+
+

Example Request

You can use this API to batch tag resources.

+
POST https://{Endpoint}/v1.0/resource-tags/batch-create
+
+{
+  "project_id" : "xxxdcffffffff",
+  "resources" : [ {
+    "resource_id" : "a28531fa-a8d5-468e-8417-86a80962ee5e",
+    "resource_type" : "disk"
+  }, {
+    "resource_id" : "a28531fa-a8d5-468e-8417-86a8096ddddd",
+    "resource_type" : "vpc"
+  } ],
+  "tags" : [ {
+    "key" : "ENV",
+    "value" : "dev"
+  }, {
+    "key" : "DEPT",
+    "value" : "pdd"
+  } ]
+}
+
+

Example Response

Status code: 200

+

Successful operation

+
{
+  "failed_resources": []
+}
+
+

Status Codes

See Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resource Tags
+
+
+ diff --git a/docs/tms/api-ref/DeleteResourceTag.html b/docs/tms/api-ref/DeleteResourceTag.html new file mode 100644 index 000000000..23732b7bd --- /dev/null +++ b/docs/tms/api-ref/DeleteResourceTag.html @@ -0,0 +1,223 @@ + + +

Batch Removing Tags

+

Function

You can use this API to remove tags from multiple resources. Up to 10 tags can be removed from a resource and a maximum of 50 resources can be operated at a time.

+
+

URI

POST /v1.0/resource-tags/batch-delete

+
+

Request

+
+ + + + + + + + + + + +
Table 1 Header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token. TMS is a global service. So you need to set scope to domain when calling an IAM API to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

No

+

String

+

Specifies the project ID. This parameter is mandatory when resource_type is at a region level.

+

resources

+

Yes

+

Array of ResourceTagBody objects

+

Specifies resource list

+

tags

+

Yes

+

Array of DeleteTagRequest objects

+

Specifies tags.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 ResourceTagBody

Parameter

+

Mandatory

+

Type

+

Description

+

resource_id

+

Yes

+

String

+

Specifies the resource ID.

+

resource_type

+

Yes

+

String

+

Specifies the resource type.

+
+
+ +
+ + + + + + + + + + + +
Table 4 DeleteTagRequest

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Specifies the key.

+

It cannot be left blank and can contain a maximum of 36 Unicode characters. Only digits, letters, hyphens (-), at signs (@), and underscores (_) are allowed.

+
+
+
+

Response

Status code: 200

+ +
+ + + + + + + + + +
Table 5 Body parameters

Parameter

+

Type

+

Description

+

failed_resources

+

Array of TagDeleteResponseItem objects

+

Specifies resources for which tags are failed to be deleted.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 6 TagDeleteResponseItem

Parameter

+

Type

+

Description

+

resource_id

+

String

+

Specifies the resource ID.

+

resource_type

+

String

+

Specifies the resource type.

+

error_code

+

String

+

Error Codes

+

error_msg

+

String

+

Specifies the error.

+
+
+
+

Example Request

Batch delete tags

+
POST https://{Endpoint}/v1.0/resource-tags/batch-delete
+
+{
+  "project_id" : "xxxdcffffffff",
+  "resources" : [ {
+    "resource_id" : "a28531fa-a8d5-468e-8417-86a80962ee5e",
+    "resource_type" : "disk"
+  }, {
+    "resource_id" : "vpc-dc7d19b7",
+    "resource_type" : "vpc"
+  } ],
+  "tags" : [ {
+    "key" : "ENV"
+  } ]
+}
+
+

Example Response

Status code: 200

+

Successful operation

+
{
+  "failed_resources": []
+}
+
+

Status Codes

See Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resource Tags
+
+
+ diff --git a/docs/tms/api-ref/GetResourceTag.html b/docs/tms/api-ref/GetResourceTag.html new file mode 100644 index 000000000..363ec07ab --- /dev/null +++ b/docs/tms/api-ref/GetResourceTag.html @@ -0,0 +1,161 @@ + + +

Querying Resource Tags

+

Function

You can use this API to query tags of a specific resource.

+
+

URI

GET /v2.0/resources/{resource_id}/tags

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

Parameter

+

Mandatory

+

Type

+

Description

+

resource_id

+

Yes

+

String

+

Specifies the resource ID.

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

No

+

String

+

Specifies the project ID. This parameter is mandatory for region-level resources.

+

resource_type

+

Yes

+

String

+

Specifies the resource type.

+
+
+
+

Request

+
+ + + + + + + + + + + +
Table 3 Header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token. TMS is a global service. So you need to set scope to domain when calling an IAM API to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+
+
+
+

Response

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Body parameters

Parameter

+

Type

+

Description

+

tags

+

Array of TagVo objects

+

Specifies resource tags.

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 TagVo

Parameter

+

Type

+

Description

+

key

+

String

+

Specifies the key.

+

It cannot be left blank and can contain a maximum of 36 Unicode characters. Only digits, letters, hyphens (-), at signs (@), and underscores (_) are allowed.

+

value

+

String

+

Specifies the value.

+

Each value contains a maximum of 43 Unicode characters and can be an empty string. Only digits, letters, hyphens (-), at signs (@), and underscores (_) are allowed.

+
+
+
+

Example Request

Querying tags of a resource

+
GET https://{Endpoint}/v2.0/resources/xxxx/tags?project_id=xxxx&resource_type=disk
+
+

Example Response

Status code: 200

+

Successful operation

+
{
+  "tags" : [ {
+    "key" : "key1",
+    "value" : "value1"
+  }, {
+    "key" : "key2",
+    "value" : "value2"
+  } ]
+}
+
+

Status Codes

See Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resource Tags
+
+
+ diff --git a/docs/tms/api-ref/ListProviders.html b/docs/tms/api-ref/ListProviders.html new file mode 100644 index 000000000..427bca8b1 --- /dev/null +++ b/docs/tms/api-ref/ListProviders.html @@ -0,0 +1,910 @@ + + +

Querying Services Supported by TMS

+

Function

You can use this API to query services supported by TMS.

+
+

URI

GET /v1.0/tms/providers

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

Parameter

+

Mandatory

+

Type

+

Description

+

locale

+

No

+

String

+

Specifies the display language.

+

limit

+

No

+

Integer

+

The maximum queries supported. The value 10 is used by default if this parameter is not set. The value range is 1 to 200.

+

offset

+

No

+

Integer

+

Specifies the index position, which starts from the next data record specified by offset. The value must be a number and cannot be negative. The default value is 0.

+

provider

+

No

+

String

+

Specifies the cloud service name.

+
+
+
+

Request

+
+ + + + + + + + + + + +
Table 2 Header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token. TMS is a global service. So you need to set scope to domain when calling an IAM API to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+
+
+
+

Response

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Body parameters

Parameter

+

Type

+

Description

+

providers

+

Array of ProviderResponseBody objects

+

Specifies the cloud services

+

total_count

+

Integer

+

Specifies the total cloud services supported.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 4 ProviderResponseBody

Parameter

+

Type

+

Description

+

provider

+

String

+

Specifies the cloud service name.

+

provider_i18n_display_name

+

String

+

Specifies the display name of the resource. You can set the language by setting the **locale** parameter.

+

resource_types

+

Array of ResourceTypeBody objects

+

Specifies the resource type.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 5 ResourceTypeBody

Parameter

+

Type

+

Description

+

resource_type

+

String

+

Specifies the resource type.

+

resource_type_i18n_display_name

+

String

+

Specifies the display name of the resource type. You can set the language by setting the **locale** parameter.

+

regions

+

Array of strings

+

Specifies the supported regions.

+

global

+

Boolean

+

Specifies whether the resource is a global resource.

+
+
+
+

Example Request

Querying supported services by TMS

+
GET https://{Endpoint}/v1.0/tms/providers?locale=en-us&limit=200
+
+

Example Response

Status code: 200

+

Successful operation

+
{
+    "providers": [
+        {
+            "provider": "drs",
+            "provider_i18n_display_name": "drs",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "sync",
+                    "resource_type_i18n_display_name": "sync",
+                    "regions": [
+                        "eu-de"
+                    ]
+                },
+                {
+                    "global": false,
+                    "resource_type": "cloudDataGuard",
+                    "resource_type_i18n_display_name": "cloudDataGuard",
+                    "regions": [
+                        "eu-de"
+                    ]
+                },
+                {
+                    "global": false,
+                    "resource_type": "subscription",
+                    "resource_type_i18n_display_name": "subscription",
+                    "regions": [
+                        "eu-de"
+                    ]
+                },
+                {
+                    "global": false,
+                    "resource_type": "backupMigration",
+                    "resource_type_i18n_display_name": "backupMigration",
+                    "regions": [
+                        "eu-de"
+                    ]
+                },
+                {
+                    "global": false,
+                    "resource_type": "migration",
+                    "resource_type_i18n_display_name": "migration",
+                    "regions": [
+                        "eu-de"
+                    ]
+                }
+            ]
+        },
+        {
+            "provider": "dli",
+            "provider_i18n_display_name": "dli",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "dli_basic_datasource",
+                    "resource_type_i18n_display_name": "dli_basic_datasource",
+                    "regions": [
+                        "eu-de"
+                    ]
+                },
+                {
+                    "global": false,
+                    "resource_type": "dli_queue",
+                    "resource_type_i18n_display_name": "dli_queue",
+                    "regions": [
+                        "eu-de"
+                    ]
+                }
+            ]
+        },
+        {
+            "provider": "gaussdb",
+            "provider_i18n_display_name": "gaussdb",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "gaussdb",
+                    "resource_type_i18n_display_name": "gaussdb",
+                    "regions": [
+                        "eu-de"
+                    ]
+                }
+            ]
+        },
+        {
+            "provider": "er",
+            "provider_i18n_display_name": "er",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "instance",
+                    "resource_type_i18n_display_name": "instance",
+                    "regions": [
+                        "eu-de"
+                    ]
+                }
+            ]
+        },
+        {
+            "provider": "nosql",
+            "provider_i18n_display_name": "GaussDBNoSQL",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "nosql",
+                    "resource_type_i18n_display_name": "nosql",
+                    "regions": [
+                        "cn-north-7",
+                        "eu-de"
+                    ]
+                }
+            ]
+        },
+        {
+            "provider": "as",
+            "provider_i18n_display_name": "AS",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "scaling_group",
+                    "resource_type_i18n_display_name": "AS",
+                    "regions": [
+                        "ru-northwest-2"
+                    ]
+                }
+            ]
+        },
+        {
+            "provider": "ecs",
+            "provider_i18n_display_name": "ecs",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "ecs",
+                    "resource_type_i18n_display_name": "ECS",
+                    "regions": [
+                        "ru-northwest-2",
+                        "eu-de",
+                        "eu-nl"
+                    ]
+                }
+            ]
+        },
+        {
+            "provider": "vpc",
+            "provider_i18n_display_name": "vpc",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "subnet",
+                    "resource_type_i18n_display_name": "subnet",
+                    "regions": [
+                        "eu-de",
+                        "eu-nl"
+                    ]
+                },
+                {
+                    "global": false,
+                    "resource_type": "eip",
+                    "resource_type_i18n_display_name": "eip",
+                    "regions": [
+                        "eu-de"
+                    ]
+                },
+                {
+                    "global": false,
+                    "resource_type": "vpc",
+                    "resource_type_i18n_display_name": "vpc",
+                    "regions": [
+                        "eu-de",
+                        "eu-nl"
+                    ]
+                },
+                {
+                    "global": false,
+                    "resource_type": "nat_gateways",
+                    "resource_type_i18n_display_name": "nat_gateways",
+                    "regions": [
+                        "eu-de"
+                    ]
+                },
+                {
+                    "global": false,
+                    "resource_type": "nat_gateways",
+                    "resource_type_i18n_display_name": "nat_gateways",
+                    "regions": [
+                        "eu-de"
+                    ]
+                },
+                {
+                    "global": false,
+                    "resource_type": "loadbalancers",
+                    "resource_type_i18n_display_name": "loadbalancers",
+                    "regions": [
+                        "eu-de",
+                        "eu-nl"
+                    ]
+                },
+                {
+                    "global": false,
+                    "resource_type": "listeners",
+                    "resource_type_i18n_display_name": "listeners",
+                    "regions": [
+                        "eu-de",
+                        "eu-nl"
+                    ]
+                },
+                {
+                    "global": false,
+                    "resource_type": "ipsec-site-connections",
+                    "resource_type_i18n_display_name": "ipsec-site-connections",
+                    "regions": [
+                        "eu-de",
+                        "eu-nl"
+                    ]
+                },
+                {
+                    "global": false,
+                    "resource_type": "nat_gateways",
+                    "resource_type_i18n_display_name": "nat_gateways",
+                    "regions": [
+                        "eu-de"
+                    ]
+                },
+                {
+                    "global": false,
+                    "resource_type": "nat_gateways",
+                    "resource_type_i18n_display_name": "nat_gateways",
+                    "regions": [
+                        "eu-de",
+                        "eu-nl"
+                    ]
+                },
+                {
+                    "global": false,
+                    "resource_type": "nat_gateways",
+                    "resource_type_i18n_display_name": "nat_gateways",
+                    "regions": [
+                        "eu-de",
+                        "eu-nl"
+                    ]
+                },
+                {
+                    "global": false,
+                    "resource_type": "nat_gateways",
+                    "resource_type_i18n_display_name": "nat_gateways",
+                    "regions": [
+                        "eu-de",
+                        "eu-nl"
+                    ]
+                },
+                {
+                    "global": false,
+                    "resource_type": "nat_gateways",
+                    "resource_type_i18n_display_name": "nat_gateways",
+                    "regions": [
+                        "eu-de",
+                        "eu-nl"
+                    ]
+                },
+                {
+                    "global": false,
+                    "resource_type": "nat_gateways",
+                    "resource_type_i18n_display_name": "nat_gateways",
+                    "regions": [
+                        "eu-de"
+                    ]
+                },
+                {
+                    "global": false,
+                    "resource_type": "nat_gateways",
+                    "resource_type_i18n_display_name": "nat_gateways",
+                    "regions": [
+                        "eu-de"
+                    ]
+                },
+                {
+                    "global": false,
+                    "resource_type": "nat_gateways",
+                    "resource_type_i18n_display_name": "nat_gateways",
+                    "regions": [
+                        "eu-de"
+                    ]
+                },
+                {
+                    "global": false,
+                    "resource_type": "nat_gateways",
+                    "resource_type_i18n_display_name": "nat_gateways",
+                    "regions": [
+                        "eu-de",
+                        "eu-nl"
+                    ]
+                },
+                {
+                    "global": false,
+                    "resource_type": "nat_gateways",
+                    "resource_type_i18n_display_name": "nat_gateways",
+                    "regions": [
+                        "eu-de",
+                        "eu-nl"
+                    ]
+                },
+                {
+                    "global": false,
+                    "resource_type": "nat_gateways",
+                    "resource_type_i18n_display_name": "nat_gateways",
+                    "regions": [
+                        "eu-de",
+                        "eu-nl"
+                    ]
+                },
+                {
+                    "global": false,
+                    "resource_type": "nat_gateways",
+                    "resource_type_i18n_display_name": "nat_gateways",
+                    "regions": [
+                        "eu-de",
+                        "eu-nl"
+                    ]
+                },
+                {
+                    "global": false,
+                    "resource_type": "nat_gateways",
+                    "resource_type_i18n_display_name": "nat_gateways",
+                    "regions": [
+                        "eu-de"
+                    ]
+                },
+                {
+                    "global": false,
+                    "resource_type": "nat_gateways",
+                    "resource_type_i18n_display_name": "nat_gateways",
+                    "regions": [
+                        "eu-de"
+                    ]
+                }
+            ]
+        },
+        {
+            "provider": "DBSS",
+            "provider_i18n_display_name": "Database Security Service",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "auditInstance",
+                    "resource_type_i18n_display_name": "Database Security Service",
+                    "regions": [
+                        "eu-de"
+                    ]
+                }
+            ]
+        },
+        {
+            "provider": "FunctionGraph",
+            "provider_i18n_display_name": "FunctionGraph",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "functions",
+                    "resource_type_i18n_display_name": "functions",
+                    "regions": [
+                        "eu-de"
+                    ]
+                }
+            ]
+        },
+        {
+            "provider": "dms",
+            "provider_i18n_display_name": "dms",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "kafka",
+                    "resource_type_i18n_display_name": "kafka",
+                    "regions": [
+                        "eu-de"
+                    ]
+                }
+            ]
+        },
+        {
+            "provider": "dcs",
+            "provider_i18n_display_name": "dcs",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "dcs",
+                    "resource_type_i18n_display_name": "dcs",
+                    "regions": [
+                        "eu-de"
+                    ]
+                }
+            ]
+        },
+        {
+            "provider": "css",
+            "provider_i18n_display_name": "css",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "css-cluster",
+                    "resource_type_i18n_display_name": "css-cluster",
+                    "regions": [
+                        "eu-de"
+                    ]
+                }
+            ]
+        },
+        {
+            "provider": "cce",
+            "provider_i18n_display_name": "cce",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "cce-cluster",
+                    "resource_type_i18n_display_name": "cce-cluster",
+                    "regions": [
+                        "eu-de"
+                    ]
+                }
+            ]
+        },
+        {
+            "provider": "ims",
+            "provider_i18n_display_name": "ims",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "private_image",
+                    "resource_type_i18n_display_name": "private_image",
+                    "regions": [
+                        "eu-de"
+                    ]
+                }
+            ]
+        },
+        {
+            "provider": "vbs",
+            "provider_i18n_display_name": "vbs",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "backup",
+                    "resource_type_i18n_display_name": "backup",
+                    "regions": [
+                        "eu-de"
+                    ]
+                }
+            ]
+        },
+        {
+            "provider": "autoback",
+            "provider_i18n_display_name": "autoback",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "backup_policy",
+                    "resource_type_i18n_display_name": "backup_policy",
+                    "regions": [
+                        "eu-de"
+                    ]
+                }
+            ]
+        },
+        {
+            "provider": "rds",
+            "provider_i18n_display_name": "rds",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "rds",
+                    "resource_type_i18n_display_name": "rds",
+                    "regions": [
+                        "eu-de"
+                    ]
+                }
+            ]
+        },
+        {
+            "provider": "csbs",
+            "provider_i18n_display_name": "csbs",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "vault",
+                    "resource_type_i18n_display_name": "vault",
+                    "regions": [
+                        "eu-de"
+                    ]
+                },
+                {
+                    "global": false,
+                    "resource_type": "csbs_backup",
+                    "resource_type_i18n_display_name": "csbs_backup",
+                    "regions": [
+                        "eu-de"
+                    ]
+                },
+                {
+                    "global": false,
+                    "resource_type": "csbs_backup_policy",
+                    "resource_type_i18n_display_name": "csbs_backup_policy",
+                    "regions": [
+                        "eu-de"
+                    ]
+                }
+            ]
+        },
+        {
+            "provider": "dns",
+            "provider_i18n_display_name": "dns",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "DNS_ptr_record",
+                    "resource_type_i18n_display_name": "DNS_ptr_record",
+                    "regions": [
+                        "eu-de"
+                    ]
+                },
+                {
+                    "global": true,
+                    "resource_type": "DNS_private_zone",
+                    "resource_type_i18n_display_name": "DNS_private_zone",
+                    "regions": [
+                        "eu-de",
+                        "eu-nl"
+                    ]
+                },
+                {
+                    "global": true,
+                    "resource_type": "DNS_private_recordset",
+                    "resource_type_i18n_display_name": "DNS_private_recordset",
+                    "regions": [
+                        "eu-de"
+                    ]
+                }
+            ]
+        },
+        {
+            "provider": "evs",
+            "provider_i18n_display_name": "evs",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "disk",
+                    "resource_type_i18n_display_name": "disk",
+                    "regions": [
+                        "",
+                        "eu-de"
+                    ]
+                }
+            ]
+        },
+        {
+            "provider": "kms",
+            "provider_i18n_display_name": "kms",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "kms",
+                    "resource_type_i18n_display_name": "kms",
+                    "regions": [
+                        "eu-de"
+                    ]
+                }
+            ]
+        },
+        {
+            "provider": "smn",
+            "provider_i18n_display_name": "smn",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "smn_topic",
+                    "resource_type_i18n_display_name": "smn_topic",
+                    "regions": [
+                        "eu-de"
+                    ]
+                }
+            ]
+        },
+        {
+            "provider": "dws",
+            "provider_i18n_display_name": "dws",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "dws_clusters",
+                    "resource_type_i18n_display_name": "dws_clusters",
+                    "regions": [
+                        "eu-de"
+                    ]
+                }
+            ]
+        },
+        {
+            "provider": "bms",
+            "provider_i18n_display_name": "bms",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "bms_server",
+                    "resource_type_i18n_display_name": "bms_server",
+                    "regions": [
+                        "eu-de"
+                    ]
+                }
+            ]
+        },
+        {
+            "provider": "deh",
+            "provider_i18n_display_name": "deh",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "dedicated-host-tags",
+                    "resource_type_i18n_display_name": "dedicated-host-tags",
+                    "regions": [
+                        "eu-de"
+                    ]
+                }
+            ]
+        },
+        {
+            "provider": "waf",
+            "provider_i18n_display_name": "waf",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "waf",
+                    "resource_type_i18n_display_name": "waf",
+                    "regions": [
+                        "eu-de"
+                    ]
+                }
+            ]
+        },
+        {
+            "provider": "sfs",
+            "provider_i18n_display_name": "sfs",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "sfs",
+                    "resource_type_i18n_display_name": "sfs",
+                    "regions": [
+                        "eu-de"
+                    ]
+                }
+            ]
+        },
+        {
+            "provider": "obs",
+            "provider_i18n_display_name": "obs",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "bucket",
+                    "resource_type_i18n_display_name": "bucket",
+                    "regions": [
+                        "eu-de"
+                    ]
+                }
+            ]
+        },
+        {
+            "provider": "sdrs",
+            "provider_i18n_display_name": "sdrs",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "sdrs",
+                    "resource_type_i18n_display_name": "sdrs",
+                    "regions": [
+                        "eu-de"
+                    ]
+                }
+            ]
+        },
+        {
+            "provider": "dds",
+            "provider_i18n_display_name": "dds",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "dds",
+                    "resource_type_i18n_display_name": "dds",
+                    "regions": [
+                        "eu-de"
+                    ]
+                }
+            ]
+        },
+        {
+            "provider": "mrs",
+            "provider_i18n_display_name": "mrs",
+            "resource_types": [
+                {
+                    "global": false,
+                    "resource_type": "clusters",
+                    "resource_type_i18n_display_name": "clusters",
+                    "regions": [
+                        "eu-de"
+                    ]
+                }
+            ]
+        }
+    ],
+    "total_count": 32
+}
+
+

Status Codes

See Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Querying Services Supported by TMS
+
+
+ diff --git a/docs/tms/api-ref/ListResource.html b/docs/tms/api-ref/ListResource.html new file mode 100644 index 000000000..f66dc03dc --- /dev/null +++ b/docs/tms/api-ref/ListResource.html @@ -0,0 +1,348 @@ + + +

Querying Resources by Tag

+

Function

You can use this API to filter resources by tag.

+
+

URI

POST /v1.0/resource-instances/filter

+
+

Request

+
+ + + + + + + + + + + +
Table 1 Header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token. TMS is a global service. So you need to set scope to domain when calling an IAM API to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

No

+

String

+

Project ID. This parameter is mandatory when resource_type is a region-specific service.

+

resource_types

+

Yes

+

Array of strings

+

Resource type. This parameter is case-sensitive. Supported resource types can be provided as ecs,scaling_group, images, disk,vpcs,security-groups, shared_bandwidth,eip, cdn.

+

tags

+

Yes

+

Array of Tag objects

+

Tags

+

without_any_tag

+

No

+

Boolean

+

Specifies whether to query only untagged resources. If this parameter is set to true, only untagged resources are queried.

+

offset

+

No

+

Integer

+

Index position. The query starts from the next data specified by offset. The value must be a number and cannot be negative. The default value is 0.

+

limit

+

No

+

Integer

+

The maximum queries supported. The value 200 is used by default if this parameter is not set. The value range is 1 to 200.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 Tag

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Key.

+

It cannot be left blank and can contain a maximum of 36 Unicode characters. Only digits, letters, hyphens (-), at signs (@), and underscores (_) are allowed.

+

values

+

Yes

+

Array of strings

+

Specifies tag values.

+

Each value contains a maximum of 43 Unicode characters and can be an empty string. Only digits, letters, hyphens (-), at signs (@), and underscores (_) are allowed.

+
+
+
+

Response

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + +
Table 4 Body parameters

Parameter

+

Type

+

Description

+

resources

+

Array of Resources objects

+

Specifies resources.

+

errors

+

Array of Errors objects

+

Specifies resources of the tag.

+

total_count

+

Integer

+

Specifies the total number of resources of the tag.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 Resources

Parameter

+

Type

+

Description

+

project_id

+

String

+

ProjectID

+

project_name

+

String

+

Specifies the project name.

+

resource_id

+

String

+

Specifies the resource ID.

+

resource_name

+

String

+

Specifies the resource name.

+

resource_type

+

String

+

Specifies the resource type.

+

tags

+

Array of FilterTagResponse objects

+

Specifies the resource tag.

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 FilterTagResponse

Parameter

+

Type

+

Description

+

key

+

String

+

Specifies the key.

+

It cannot be left blank and can contain a maximum of 36 Unicode characters. Only digits, letters, hyphens (-), at signs (@), and underscores (_) are allowed.

+

value

+

String

+

Specifies the value.

+

Each value contains a maximum of 43 Unicode characters and can be an empty string. Only digits, letters, hyphens (-), at signs (@), and underscores (_) are allowed.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 7 Errors

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error.

+

project_id

+

String

+

ProjectID

+

resource_type

+

String

+

Specifies the resource type.

+
+
+
+

Example Request

Filtering resources by tag

+
POST https://v1.0/resource-instances/filter
+
+{
+  "project_id" : "e1eb7c40cbeaxxxxxxcde527594a306d",
+  "resource_types" : [ "disk", "ecs" ],
+  "tags" : [ {
+    "key" : "env",
+    "values" : [ "dev", "prod" ]
+  }, {
+    "key" : "test",
+    "values" : [ "test" ]
+  } ],
+  
+  "without_any_tag" : true,
+  "offset" : 0,
+  "limit" : 10
+}
+
+

Example Response

Status code: 200

+

Successful operation

+
{
+  "resources" : [ {
+    "project_id" : "e1eb7c40cbeaxxxxxxde527594a306d",
+    "project_name" : "XXXX",
+    "resource_type" : "disk",
+    "resource_id" : "b621f5ae-xxxx-xxxx-xxxx-752c445434b4",
+    "resource_name" : "xxx1-volume-0001",
+    "tags" : [ {
+      "key" : "ENV",
+      "value" : "dev"
+    } ]
+  }, {
+    "project_id" : "e1eb7c40cbxxxxxx89cde527594a306d",
+    "project_name" : "XXXX",
+    "resource_type" : "disk",
+    "resource_id" : "87c9edc9-xxxx-xxxx-xxxx-372b2e22d579",
+    "resource_name" : "xxx2-volume-0002",
+    "tags" : [ {
+      "key" : "test",
+      "value" : "test"
+    } ]
+  } ],
+  "errors" : [],
+  "total_count" : 2
+}
+
+

Status Codes

See Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resource Tags
+
+
+ diff --git a/docs/tms/api-ref/ListTagKeys.html b/docs/tms/api-ref/ListTagKeys.html new file mode 100644 index 000000000..dabe545e1 --- /dev/null +++ b/docs/tms/api-ref/ListTagKeys.html @@ -0,0 +1,153 @@ + + +

Querying Tag Keys

+

Function

You can use this API to query any tag key in a specified region.

+
+

URI

GET /v1.0/tag-keys

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

Parameter

+

Mandatory

+

Type

+

Description

+

region_id

+

No

+

String

+

Region ID

+

limit

+

No

+

Integer

+

The maximum queries supported. The value range is 1 to 200. If this parameter is not specified, the default value 200 is used by default.

+

Minimum value: 1

+

Maximum value: 200

+

Default value: 200

+

marker

+

No

+

String

+

Paging location identifier (index). The query starts from the next piece of data indexed by this parameter. When querying the data on the first page, you do not need to specify this parameter. When querying the data on subsequent pages, set this parameter to the value in the response body returned by querying data of the previous page. When the returned next_marker is empty, the last page has been queried.

+
+
+
+

Request

+
+ + + + + + + + + + + +
Table 2 Header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token. TMS is a global service. So you need to set scope to domain when calling an IAM API to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+
+
+
+

Response

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Body parameters

Parameter

+

Type

+

Description

+

keys

+

Array of strings

+

Tag keys.

+

page_info

+

PageInfoTagKeys object

+

Pagination information

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 PageInfoTagKeys

Parameter

+

Type

+

Description

+

next_marker

+

String

+

Paging location marker (index position)

+

current_count

+

Integer

+

Specifies the number of tag keys on the current page.

+
+
+
+

Example Request

Query tag keys

+
GET https://{Endpoint}/v1.0/tag-keys?limit=10&marker=9
+
+

Example Response

Status code: 200

+

Successful operation

+
{
+  "keys" : [ "ENV1", "ENV2" ],
+  "page_info" : [ {
+    "next_marker" : "9",
+    "current_count" : 10
+  } ]
+}
+
+

Status Codes

See Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resource Tags
+
+
+ diff --git a/docs/tms/api-ref/ListTagValues.html b/docs/tms/api-ref/ListTagValues.html new file mode 100644 index 000000000..554376b7e --- /dev/null +++ b/docs/tms/api-ref/ListTagValues.html @@ -0,0 +1,162 @@ + + +

Query Tag Values

+

Function

You can use this API to query any tag value in a specified region.

+
+

URI

GET /v1.0/tag-values

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

Parameter

+

Mandatory

+

Type

+

Description

+

region_id

+

No

+

String

+

Region ID

+

limit

+

No

+

Integer

+

The maximum queries supported. The value range is 1 to 200. If this parameter is not specified, the default value 200 is used by default.

+

Minimum value: 1

+

Maximum value: 200

+

Default value: 10

+

marker

+

No

+

String

+

Paging location identifier (index). The query starts from the next piece of data indexed by this parameter. When querying the data on the first page, you do not need to specify this parameter. When querying the data on subsequent pages, set this parameter to the value in the response body returned by querying data of the previous page. When the returned next_marker is empty, the last page has been queried.

+

key

+

Yes

+

String

+

Tag key.

+
+
+
+

Request

+
+ + + + + + + + + + + +
Table 2 Header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token. TMS is a global service. So you need to set scope to domain when calling an IAM API to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+
+
+
+

Response

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Body parameters

Parameter

+

Type

+

Description

+

values

+

Array of strings

+

Tag values queried.

+

page_info

+

PageInfoTagValues object

+

Pagination information

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 PageInfoTagValues

Parameter

+

Type

+

Description

+

next_marker

+

String

+

Paging location marker (index position)

+

current_count

+

Integer

+

The number of tag values on the current page.

+
+
+
+

Example Request

Querying tag values

+
GET https://{Endpoint}/v1.0/tag-values?limit=10&marker=9&key=dev
+
+

Example Response

Status code: 200

+

Successful operation

+
{
+  "values" : [ "ENV1", "ENV2" ],
+  "page_info" : [ {
+    "next_marker" : "9",
+    "current_count" : 10
+  } ]
+}
+
+

Status Codes

See Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resource Tags
+
+
+ diff --git a/docs/tms/api-ref/ShowTagQuota.html b/docs/tms/api-ref/ShowTagQuota.html new file mode 100644 index 000000000..e0585ea1e --- /dev/null +++ b/docs/tms/api-ref/ShowTagQuota.html @@ -0,0 +1,117 @@ + + +

Querying Tag Quotas

+

Function

This API is used to query tag quotas.

+
+

URI

GET /v1.0/tms/quotas

+
+

Request

+
+ + + + + + + + + + + +
Table 1 Header

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token. TMS is a global service. So you need to set scope to domain when calling an IAM API to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+
+
+
+

Response

Status code: 200

+ +
+ + + + + + + + + +
Table 2 Body

Parameter

+

Type

+

Description

+

quotas

+

Array of TagQuota objects

+

Quota lists

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 TagQuota

Parameter

+

Type

+

Description

+

quota_key

+

String

+

Specifies the quota key.

+

quota_limit

+

Integer

+

Specifies the quota value.

+

used

+

Integer

+

Specifies the used quota.

+

unit

+

String

+

Specifies the unit.

+
+
+
+

Example Request

Querying tag quotas

+
GET https://{Endpoint}/v1.0/tms/quotas
+
+

Example Response

Status code: 200

+

Successful operation

+
{
+  "quotas" : [ {
+    "used" : 4,
+    "unit" : "count",
+    "quota_key" : "predefine_tag",
+    "quota_limit" : 500
+  } ]
+}
+
+

Status Codes

See Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Quotas
+
+
+ diff --git a/docs/tms/api-ref/en-us_topic_0056765894.html b/docs/tms/api-ref/en-us_topic_0056765894.html index f3af52a35..9c697df22 100644 --- a/docs/tms/api-ref/en-us_topic_0056765894.html +++ b/docs/tms/api-ref/en-us_topic_0056765894.html @@ -8,6 +8,12 @@
  • Predefined Tag Operations
    • +
  • Quotas
    +
    • +
  • Resource Tags
    +
    • +
  • Querying Services Supported by TMS
    +
    • diff --git a/docs/tms/api-ref/en-us_topic_0056765935.html b/docs/tms/api-ref/en-us_topic_0056765935.html index b593a8282..8e4544978 100644 --- a/docs/tms/api-ref/en-us_topic_0056765935.html +++ b/docs/tms/api-ref/en-us_topic_0056765935.html @@ -9,41 +9,64 @@

    URI

    POST /v1.0/predefine_tags/action

    Request

    • Parameter description -
      Table 1 Parameters in the request

      Name

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

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      action

      +

      X-Auth-Token

      Yes

      +

      Yes

      String

      +

      String

      Specifies the operation identifier.

      +

      Specifies the user token. TMS is a global service. When calling the IAM API to obtain a user token, set scope to domain. The value of X-Subject-Token in the response header is the user token.

      +
      +
      + +
      + + + + + + + + + - - - -
      Table 2 Parameters

      Name

      +

      Mandatory

      +

      Type

      +

      Description

      +

      action

      +

      Yes

      +

      String

      +

      Specifies the operation identifier.

      This parameter value is case sensitive and can be create or delete.

      tags

      +

      tags

      Yes

      +

      Yes

      Array of objects

      +

      Array of objects

      Specifies the tags.

      -

      For details, see Table 2.

      +

      Specifies the tags.

      +

      For details, see Table 3.
    • tags field description -
      Table 2 Parameter description

      Name

      +
      @@ -60,7 +83,7 @@ @@ -93,10 +116,8 @@ } -

      Response

      • Parameter description

        None

        -
      -
      • Example response

        None

        -
      +

      Example Response

      Status code: 200

      +

      Successful operation

      Status Codes

      See Status Codes.

      diff --git a/docs/tms/api-ref/en-us_topic_0056765936.html b/docs/tms/api-ref/en-us_topic_0056765936.html index 4d8a0e975..078f1edb2 100644 --- a/docs/tms/api-ref/en-us_topic_0056765936.html +++ b/docs/tms/api-ref/en-us_topic_0056765936.html @@ -6,79 +6,102 @@

      URI

      GET /v1.0/predefine_tags

      Request

      • Parameter description -
      Table 3 Fields

      Name

      Mandatory

      String

      Specifies the key.

      -

      It cannot be left blank and can contain a maximum of 36 Unicode characters. Only digits, letters, hyphens (-), and underscores (_) are allowed.

      +

      It cannot be left blank and can contain a maximum of 36 Unicode characters. Only digits, letters, hyphens (-), at signs (@), and underscores (_) are allowed.

      value

      @@ -70,7 +93,7 @@

      String

      Specifies the value.

      -

      Each value contains a maximum of 43 Unicode characters and can be an empty string. Only digits, letters, hyphens (-), and underscores (_) are allowed.

      +

      Each value contains a maximum of 43 Unicode characters and can be an empty string. Only digits, letters, hyphens (-), at signs (@), and underscores (_) are allowed.
      Table 1 Parameters in the request

      Name

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

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      key

      +

      X-Auth-Token

      No

      +

      Yes

      String

      +

      String

      Specifies the key.

      +

      Specifies the user token. TMS is a global service. When calling the IAM API to obtain a user token, set scope to domain. The value of X-Subject-Token in the response header is the user token.

      +
      +
      + +
      + + + + + + + + + - - - - - - - - - - - - - - - - - - - -
      Table 2 Parameters

      Name

      +

      Mandatory

      +

      Type

      +

      Description

      +

      key

      +

      No

      +

      String

      +

      Specifies the key.

      Supports fuzzy search and is case insensitive. If this parameter value contains non-URL-safe characters, it must be URL encoded.

      value

      +

      value

      No

      +

      No

      String

      +

      String

      Specifies the value.

      +

      Specifies the value.

      Supports fuzzy search and is case insensitive. If this parameter value contains non-URL-safe characters, it must be URL encoded.

      limit

      +

      limit

      No

      +

      No

      Integer

      +

      Integer

      Specifies the number of query records.

      +

      Specifies the number of query records.

      The value ranges from 1 to 1000. If no value is specified, the value is 10 by default. If the value is set to 0, the number of query records is not limited.

      marker

      +

      marker

      No

      +

      No

      String

      +

      String

      Specifies the paging location identifier (index).

      +

      Specifies the paging location identifier (index).

      The query starts from the next piece of data indexed by this parameter.

      NOTE:

      When querying the data on the first page, you do not need to specify this parameter. When querying the data on subsequent pages, set this parameter to the value in the response body returned by querying data of the previous page. When the returned tags is an empty list, the last page has been queried.

      order_field

      +

      order_field

      No

      +

      No

      String

      +

      String

      Specifies the field for sorting.

      +

      Specifies the field for sorting.

      The parameter value is case sensitive and can be update_time, key, or value.

      Its default value is update_time.

      You can choose only one of the three values and based on the value of order_method to sort the remaining two default fields.

      For example:

      -
      • If order_field is set to update_time, both key and value are sorted in the ascending order.
      • If order_field is set to key, update_time is sorted in the descending order, and value is sorted in the ascending order.
      • If order_field is set to value, update_time is sorted in the descending order, and key is sorted in the ascending order.
      • If order_field is not specified, its default value update_time is taken. In this case, key and value are sorted in the ascending order.
      +
      • If order_field is set to update_time, both key and value are sorted in the ascending order.
      • If order_field is set to key, update_time is sorted in the descending order, and value is sorted in the ascending order.
      • If order_field is set to value, update_time is sorted in the descending order, and key is sorted in the ascending order.
      • If order_field is not specified, its default value update_time is taken. In this case, key and value are sorted in the ascending order.

      order_method

      +

      order_method

      No

      +

      No

      String

      +

      String

      Specifies the sorting method of the order_field field.

      +

      Specifies the sorting method of the order_field field.

      The method can be (case sensitive):

      • asc: ascending order
      • desc: descending order

      Only one of the preceding sorting methods can be selected.

      @@ -93,7 +116,7 @@

      Response

      • Parameter description -
        Table 2 Parameters in the response

        Name

        +
        @@ -106,7 +129,7 @@
        Table 3 Parameters

        Name

        Type

        Array of objects

        Specifies the tags.

        -

        For details, see Table 3.

        +

        For details, see Table 4.

        total_count

        @@ -128,11 +151,11 @@
      • tags field description -
        - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -105,9 +182,9 @@ - - - - - - - - - - - - - - @@ -270,9 +347,9 @@ - - - @@ -292,9 +369,9 @@ - - - - - @@ -325,7 +402,7 @@ - diff --git a/docs/tms/api-ref/en-us_topic_0057939858.html b/docs/tms/api-ref/en-us_topic_0057939858.html index 5fb7ab038..8298d651a 100644 --- a/docs/tms/api-ref/en-us_topic_0057939858.html +++ b/docs/tms/api-ref/en-us_topic_0057939858.html @@ -8,7 +8,37 @@ - + + + + + + + + + + + + + + +
        Table 3 Parameter description

        Name

        +
        - - @@ -141,7 +164,7 @@
        Table 4 Fields

        Name

        Type

        +

        Type

        Description

        +

        Description

        String

        Specifies the key.

        -

        It cannot be left blank and can contain a maximum of 36 Unicode characters. Only digits, letters, hyphens (-), and underscores (_) are allowed.

        +

        It cannot be left blank and can contain a maximum of 36 Unicode characters. Only digits, letters, hyphens (-), at signs (@), and underscores (_) are allowed.

        value

        @@ -149,7 +172,7 @@

        String

        Specifies the value.

        -

        Each value contains a maximum of 43 Unicode characters and can be an empty string. Only digits, letters, hyphens (-), and underscores (_) are allowed.

        +

        Each value contains a maximum of 43 Unicode characters and can be an empty string. Only digits, letters, hyphens (-), at signs (@), and underscores (_) are allowed.

        update_time

        @@ -163,7 +186,9 @@
        -
        • Example response
          {
+
          • Example response
            Status code: 200
            
+
            Successful operation
            
+
            {
     "marker": "12",
     "total_count": 13,
     "tags": [
diff --git a/docs/tms/api-ref/en-us_topic_0057939857.html b/docs/tms/api-ref/en-us_topic_0057939857.html
index d7e5a85ac..acde13f0a 100644
--- a/docs/tms/api-ref/en-us_topic_0057939857.html
+++ b/docs/tms/api-ref/en-us_topic_0057939857.html
@@ -22,7 +22,84 @@

        500

        +

        403

        +

        TMS.2030

        +

        You do not have the required permission to perform this operation. The required permission is: xxx.

        +

        Required permissions are not granted.

        +

        Grant required permissions.

        +

        400

        +

        TMS.2009

        +

        Projects is empty.

        +

        Projects is empty.

        +

        Specify Projects.

        +

        400

        +

        TMS.2017

        +

        Invalid element in projects.

        +

        Invalid projects element

        +

        Enter a valid projects value.

        +

        404

        +

        APIGW.0101

        +

        The API does not exist or has not been published in the environment.

        +

        The API does not exist or has not been published in the environment.

        +

        You can see What Should I Do If "The API does not exist or has not been published in the environment." Is Displayed?

        +

        400

        +

        APIGW.0106

        +

        Orchestration error.

        +

        There is orchestration error.

        +

        Check whether the frontend and backend parameters are properly set for the API.

        +

        400

        +

        TMS.5027

        +

        Invalid resource type.

        +

        Invalid resource type

        +

        Enter a valid resource type.

        +

        400

        +

        TMS.2011

        +

        Project_id is invalid.

        +

        Invalid project ID

        +

        Enter a valid project ID.

        +

        500

        TMS.0001

        Marker is invalid.

        Marker is invalid.

        +

        Marker is invalid.

        Enter a valid Marker value.

        +

        Enter a valid Marker value.

        400

        @@ -116,9 +193,9 @@

        Key is invalid.

        Key is invalid.

        +

        Key is invalid.

        Enter a valid Key value.

        +

        Enter a valid Key value.

        400

        @@ -127,9 +204,9 @@

        Value is invalid.

        Value is invalid.

        +

        Value is invalid.

        Enter a valid Value value.

        +

        Enter a valid Value value.

        400

        @@ -138,9 +215,9 @@

        Action is invalid.

        Action is invalid.

        +

        Action is invalid.

        Enter a valid Action value.

        +

        Enter a valid Action value.

        400

        @@ -151,7 +228,7 @@

        Tags is left blank.

        Specify Tags.

        +

        Specify Tags.

        400

        @@ -162,18 +239,18 @@

        Tags is invalid.

        Enter a valid Tags value.

        +

        Enter a valid Tags value.

        400

        +

        409

        TMS.0014

        Values is empty.

        Values is invalid.

        +

        Values is invalid.

        Enter a valid Values value.

        +

        Enter a valid Values value.

        400

        @@ -248,7 +325,7 @@

        Old_tag is empty.

        Old_tag is left blank.

        +

        Old_tag is left blank.

        Specify Old_tag.

        Invalid value in Old_tag.

        The value in Old_tag is invalid.

        +

        The value in Old_tag is invalid.

        Enter a valid value in Old_tag.

        +

        Enter a valid value in Old_tag.

        400

        @@ -281,7 +358,7 @@

        New_tag is empty.

        New_tag is left blank.

        +

        New_tag is left blank.

        Specify New_tag.

        Invalid key in New_tag.

        The key in New_tag is invalid.

        +

        The key in New_tag is invalid.

        Enter a valid key in New_tag.

        +

        Enter a valid key in New_tag.

        400

        @@ -303,9 +380,9 @@

        Invalid value in New_tag.

        The value in New_tag is invalid.

        +

        The value in New_tag is invalid.

        Enter a valid value in New_tag.

        +

        Enter a valid value in New_tag.

        400

        @@ -314,7 +391,7 @@

        Order_field is invalid.

        Order_field is invalid.

        +

        Order_field is invalid.

        Enter a valid Order_field value.

        Order_method is invalid.

        Order_method is invalid.

        +

        Order_method is invalid.

        Enter a valid Order_method value.

        2023-07-30

        +

        2023-11-17

        +

        This release incorporates the following change:

        +

        Modified the example request for the API Query Tag Values.

        +

        2023-11-16

        +

        This release incorporates the following changes:

        + +

        2023-11-15

        +

        This release incorporates the following changes:

        + +

        2023-11-07

        +

        This release incorporates the following changes:

        + +

        2023-10-25

        +

        This release incorporates the following changes:

        + +

        2023-07-30

        This release incorporates the following change:

        Added Table 2 in Querying Details About a Specified TMS API Version.

        @@ -41,7 +71,7 @@

        2018-03-30

        This release incorporates the following change:

        -

        Modified the requirements for Key and Value.

        +

        Modified the requirements for Key and Value.

        2018-03-16

        diff --git a/docs/tms/api-ref/en-us_topic_0060929630.html b/docs/tms/api-ref/en-us_topic_0060929630.html index f5756af86..e282e6944 100644 --- a/docs/tms/api-ref/en-us_topic_0060929630.html +++ b/docs/tms/api-ref/en-us_topic_0060929630.html @@ -6,41 +6,64 @@

        URI

        PUT /v1.0/predefine_tags

        Request

        • Parameter description -
          Table 1 Parameters in the request

          Name

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

          Parameter

          Mandatory

          +

          Mandatory

          Type

          +

          Type

          Description

          +

          Description

          old_tag

          +

          X-Auth-Token

          Yes

          +

          Yes

          Object

          +

          String

          Specifies the tag to be modified.

          -

          For details, see Table 2.

          +

          Specifies the user token. TMS is a global service. When calling the IAM API to obtain a user token, set scope to domain. The value of X-Subject-Token in the response header is the user token.

          new_tag

          +
          +
          + +
          + + + + + + - - - + + + + +
          Table 2 Parameters

          Name

          +

          Mandatory

          +

          Type

          +

          Description

          +

          old_tag

          Yes

          +

          Yes

          Object

          +

          Object

          Specifies the tag that has been modified.

          -

          For details, see Table 3.

          +

          Specifies the tag to be modified.

          +

          For details, see Table 3.

          +

          new_tag

          +

          Yes

          +

          Object

          +

          Specifies the tag that has been modified.

          +

          For details, see Table 4.
        • old_tag field description -
          - @@ -58,6 +58,97 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Table 2 Parameter description

          Name

          +
          @@ -57,7 +80,7 @@
          Table 3 Fields

          Name

          Mandatory

          String

          Specifies the key.

          -

          It cannot be left blank and can contain a maximum of 36 Unicode characters. Only digits, letters, hyphens (-), and underscores (_) are allowed.

          +

          It cannot be left blank and can contain a maximum of 36 Unicode characters. Only digits, letters, hyphens (-), at signs (@), and underscores (_) are allowed.

          value

          @@ -67,14 +90,14 @@

          String

          Specifies the value.

          -

          Each value contains a maximum of 43 Unicode characters and can be an empty string. Only digits, letters, hyphens (-), and underscores (_) are allowed.

          +

          Each value contains a maximum of 43 Unicode characters and can be an empty string. Only digits, letters, hyphens (-), at signs (@), and underscores (_) are allowed.
        • new_tag field description -
          Table 3 Parameter description

          Name

          +
          @@ -91,7 +114,7 @@ @@ -121,10 +144,8 @@ } -

          Response

          • Parameter description

            None

            -
          -
          • Example response

            None

            -
          +

          Example Response

          Status code: 200

          +

          Successful operation

          Status Codes

          See Status Codes.

          diff --git a/docs/tms/api-ref/en-us_topic_0133313256.html b/docs/tms/api-ref/en-us_topic_0133313256.html index 52a59a5ac..f8910735e 100644 --- a/docs/tms/api-ref/en-us_topic_0133313256.html +++ b/docs/tms/api-ref/en-us_topic_0133313256.html @@ -86,7 +86,7 @@
          Table 4 Fields

          Name

          Mandatory

          String

          Specifies the key.

          -

          It cannot be left blank and can contain a maximum of 36 Unicode characters. Only digits, letters, hyphens (-), and underscores (_) are allowed.

          +

          It can contain up to 36 Unicode characters and cannot be left blank. Only digits, letters, hyphens (-), at signs (@), and underscores (_) are allowed.

          value

          @@ -101,7 +124,7 @@

          String

          Specifies the value.

          -

          Each value contains a maximum of 43 Unicode characters and can be an empty string. Only digits, letters, hyphens (-), and underscores (_) are allowed.

          +

          Each value contains a maximum of 43 Unicode characters and can be an empty string. Only digits, letters, hyphens (-), at signs (@), and underscores (_) are allowed.
          -
        • Links field description +
        • Links field description
          Table 3 Parameter description

          Name

          Type

          @@ -113,7 +113,9 @@
          • -
          • Example response
            {
+
            • Example response
              Status code: 200
              
+
              Successful operation
              
+
              {
     "versions": [
         {
             "id": "v1.0",
diff --git a/docs/tms/api-ref/en-us_topic_0133313257.html b/docs/tms/api-ref/en-us_topic_0133313257.html
index 30044956f..a6ff78d7a 100644
--- a/docs/tms/api-ref/en-us_topic_0133313257.html
+++ b/docs/tms/api-ref/en-us_topic_0133313257.html
@@ -157,7 +157,8 @@
          -
        • Example response
          {
+
        • Example response

          Status code: 200

          +
          Successful operation
          {
     "version": {
         "id": "v1.0",
         "links": [
@@ -172,6 +173,7 @@
         "min_version": ""
     }
 }
          +

          • Status Codes

          See Status Codes.

          diff --git a/docs/tms/api-ref/en-us_topic_0180205869.html b/docs/tms/api-ref/en-us_topic_0180205869.html index d8f4a4307..82623ef7e 100644 --- a/docs/tms/api-ref/en-us_topic_0180205869.html +++ b/docs/tms/api-ref/en-us_topic_0180205869.html @@ -49,7 +49,7 @@

          Modifying a predefined tag

          PUT /v1.0/predefine_tags/action

          +

          PUT /v1.0/predefine_tags

          tms:predefineTags:update

          Not supported

          Batch creating tags

          +

          POST /v1.0/resource-tags/batch-create

          +

          tms:resourceTags:create

          +

          +

          Supported

          +

          Not supported

          +

          Batch deleting tags

          +

          POST /v1.0/resource-tags/batch-delete

          +

          tms:resourceTags:delete

          +

          +

          Supported

          +

          Not supported

          +

          Querying tag Keys

          +

          GET /v1.0/tag-keys

          +

          tms:tagKeys:list

          +

          Supported

          +

          Not supported

          +

          Querying tag values

          +

          GET /v1.0/tag-values

          +

          tms:tagValues:list

          +

          Supported

          +

          Not supported

          +

          Querying resource tags

          +

          GET /v2.0/resources/{resource_id}/tags

          +

          tms:resourceTags:list

          +

          Supported

          +

          Not supported

          +

          Querying resources by tag

          +

          POST /v1.0/resource-instances/filter

          +

          tms:resources:list

          +

          +

          Supported

          +

          Not supported

          +

          Querying tag quotas

          +

          GET /v1.0/tms/quotas

          +

          Included in the Tenant Guest permissions.

          +

          Not supported

          +

          Not supported

          +

          Querying supported services

          +

          GET /v1.0/tms/providers

          +

          Included in the Tenant Guest permissions.

          +

          Not supported

          +

          Not supported

          +
          diff --git a/docs/tms/api-ref/topic_300000002.html b/docs/tms/api-ref/topic_300000002.html new file mode 100644 index 000000000..51bd9e23b --- /dev/null +++ b/docs/tms/api-ref/topic_300000002.html @@ -0,0 +1,16 @@ + + +

          Quotas

          +

          +
          +
          + + +
          +
          Parent topic: API Description
          +
          +
          + diff --git a/docs/tms/api-ref/topic_300000003.html b/docs/tms/api-ref/topic_300000003.html new file mode 100644 index 000000000..9611d7d52 --- /dev/null +++ b/docs/tms/api-ref/topic_300000003.html @@ -0,0 +1,26 @@ + + +

          Resource Tags

          +

          +
          + + diff --git a/docs/tms/api-ref/topic_300000004.html b/docs/tms/api-ref/topic_300000004.html new file mode 100644 index 000000000..32df11ad9 --- /dev/null +++ b/docs/tms/api-ref/topic_300000004.html @@ -0,0 +1,16 @@ + + +

          Querying Services Supported by TMS

          +

          +
          + +