diff --git a/docs/tms/api-ref/ALL_META.TXT.json b/docs/tms/api-ref/ALL_META.TXT.json index 3f33ba05..c646df94 100644 --- a/docs/tms/api-ref/ALL_META.TXT.json +++ b/docs/tms/api-ref/ALL_META.TXT.json @@ -3,7 +3,7 @@ "uri":"en-us_topic_0056283725.html", "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 ", + "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", "title":"APIs", @@ -43,7 +43,7 @@ "uri":"en-us_topic_0133313257.html", "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 requestNameMandatoryTypeDescriptionapi_versi", + "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", "title":"Querying Details About a Specified TMS API Version", @@ -73,10 +73,10 @@ "uri":"en-us_topic_0056765936.html", "product_code":"tms", "code":"8", - "des":"This API is used to query the predefined tag list.GET /v1.0/predefine_tagsParameter descriptionParameters in the requestNameMandatoryTypeDescriptionkeyNoStringSpecifies t", + "des":"This API is used to query predefined tags.GET /v1.0/predefine_tagsParameter descriptionParameters in the requestNameMandatoryTypeDescriptionkeyNoStringSpecifies the key.S", "doc_type":"api", - "kw":"Querying the Predefined Tag List,Predefined Tag Operations,API Reference", - "title":"Querying the Predefined Tag List", + "kw":"Querying Predefined Tags,Predefined Tag Operations,API Reference", + "title":"Querying Predefined Tags", "githuburl":"" }, { @@ -103,10 +103,10 @@ "uri":"en-us_topic_0180205868.html", "product_code":"tms", "code":"11", - "des":"This section describes fine-grained permissions management for your TMS. If your account does not need individual IAM users, then you may skip over this section.By defaul", + "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":"Permissions Policies and Supported Actions,Permissions Policies and Supported Actions,API Reference", - "title":"Permissions Policies and Supported Actions", + "kw":"Introduction,Permissions Policies and Supported Actions,API Reference", + "title":"Introduction", "githuburl":"" }, { diff --git a/docs/tms/api-ref/CLASS.TXT.json b/docs/tms/api-ref/CLASS.TXT.json index 896d3b83..b6038036 100644 --- a/docs/tms/api-ref/CLASS.TXT.json +++ b/docs/tms/api-ref/CLASS.TXT.json @@ -1,6 +1,6 @@ [ { - "desc":"Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform ", + "desc":"Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform ", "product_code":"tms", "title":"APIs", "uri":"en-us_topic_0056283725.html", @@ -36,7 +36,7 @@ "code":"4" }, { - "desc":"This API is used to query the details of a specified TMS API version.GET /{api_version}Parameter descriptionParameters in the requestNameMandatoryTypeDescriptionapi_versi", + "desc":"This API is used to query the details of a specified TMS API version.GET /{api_version}Parameter descriptionParameters in the requestParameterMandatoryTypeDescriptionapi_", "product_code":"tms", "title":"Querying Details About a Specified TMS API Version", "uri":"en-us_topic_0133313257.html", @@ -63,9 +63,9 @@ "code":"7" }, { - "desc":"This API is used to query the predefined tag list.GET /v1.0/predefine_tagsParameter descriptionParameters in the requestNameMandatoryTypeDescriptionkeyNoStringSpecifies t", + "desc":"This API is used to query predefined tags.GET /v1.0/predefine_tagsParameter descriptionParameters in the requestNameMandatoryTypeDescriptionkeyNoStringSpecifies the key.S", "product_code":"tms", - "title":"Querying the Predefined Tag List", + "title":"Querying Predefined Tags", "uri":"en-us_topic_0056765936.html", "doc_type":"api", "p_code":"6", @@ -90,9 +90,9 @@ "code":"10" }, { - "desc":"This section describes fine-grained permissions management for your TMS. If your account does not need individual IAM users, then you may skip over this section.By defaul", + "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":"Permissions Policies and Supported Actions", + "title":"Introduction", "uri":"en-us_topic_0180205868.html", "doc_type":"api", "p_code":"10", diff --git a/docs/tms/api-ref/en-us_topic_0056283725.html b/docs/tms/api-ref/en-us_topic_0056283725.html index ecfb04e3..d40a3018 100644 --- a/docs/tms/api-ref/en-us_topic_0056283725.html +++ b/docs/tms/api-ref/en-us_topic_0056283725.html @@ -1,8 +1,8 @@
Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.
-Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by Application/json.
+Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.
+Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with the media type represented by Application/json.
For details about how to use APIs, see API Usage Guidelines.
Array of objects
Specifies the tag list.
+Specifies the tags.
For details, see Table 2.
POST https://TMS endpoint/v1.0/predefine_tags/action+
POST https://{TMS endpoint}/v1.0/predefine_tags/action
{ "action": "create", "tags": [ diff --git a/docs/tms/api-ref/en-us_topic_0056765936.html b/docs/tms/api-ref/en-us_topic_0056765936.html index a0f8f455..4d8a0e97 100644 --- a/docs/tms/api-ref/en-us_topic_0056765936.html +++ b/docs/tms/api-ref/en-us_topic_0056765936.html @@ -1,7 +1,7 @@ -Querying the Predefined Tag List
-Function
This API is used to query the predefined tag list.
+Querying Predefined Tags
+Function
This API is used to query predefined tags.
@@ -69,7 +69,7 @@URI
GET /v1.0/predefine_tags
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.
@@ -130,9 +130,9 @@ order_method
@@ -105,7 +105,7 @@- Array of objects
Specifies the tag list.
+Specifies the tags.
For details, see Table 3.
- tags field description
-
Table 3 Parameter description @@ -156,7 +156,7 @@ - Name
Type
+- Type
Description
+Description
- String
Specifies the update time, which must be the UTC time, for example, 2016-12-09T00:00:00Z.
+diff --git a/docs/tms/api-ref/en-us_topic_0057939858.html b/docs/tms/api-ref/en-us_topic_0057939858.html index 1d2c51bc..5fb7ab03 100644 --- a/docs/tms/api-ref/en-us_topic_0057939858.html +++ b/docs/tms/api-ref/en-us_topic_0057939858.html @@ -8,7 +8,13 @@ - Specifies the update time, which must be the UTC time, for example, 2016-12-09T00:00:00Z.
2023-04-07
++ + 2023-07-30
++ This release incorporates the following change:
+Added Table 2 in Querying Details About a Specified TMS API Version.
+2023-04-07
This release incorporates the following change:
@@ -28,14 +34,14 @@- 2018-06-15
This release incorporates the following changes:
+This release incorporates the following change:
Modified the requirements for Key and Value.
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_0133313256.html b/docs/tms/api-ref/en-us_topic_0133313256.html index 48617213..52a59a5a 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 @@- Links field description +
- Links field description
Table 3 Parameter description Name
Type
diff --git a/docs/tms/api-ref/en-us_topic_0133313257.html b/docs/tms/api-ref/en-us_topic_0133313257.html index caea8691..30044956 100644 --- a/docs/tms/api-ref/en-us_topic_0133313257.html +++ b/docs/tms/api-ref/en-us_topic_0133313257.html @@ -6,7 +6,7 @@URI
GET /{api_version}
Request
- Parameter description -
Table 1 Parameters in the request Name
++ +
Table 1 Parameters in the request Parameter
@@ -28,11 +28,34 @@ Mandatory
+
Table 2 Request header parameters + + + Parameter
++ Mandatory
++ Type
++ Description
++ + + X-Auth-Token
++ Yes
++ String
++ 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.
+- Example request
GET https://{TMS endpoint}/v1.0Response
- Parameter description -
Table 2 Parameters in the response Name
+-
Table 3 Parameters in the response Name
@@ -45,14 +68,14 @@ Type
object
Specifies the version of a specified API.
-For details, see Table 3.
+For details, see Table 4.
- version field data structure -
Table 3 version field data structure description Name
+- version field description +
-
Table 4 Parameter description Name
@@ -72,7 +95,7 @@ Type
List<Link>
Specifies the API URL.
-For details, see Table 4.
+For details, see Table 5.
version
@@ -88,7 +111,7 @@Specifies the version status.
Possible values are as follows:
-+
- CURRENT: indicates that the version is the primary version.
- SUPPORTED: indicates that the version is an old version, but it is still supported.
- DEPRECATED: indicates a deprecated version which may be deleted later.
- CURRENT: indicates that the version is the primary version.
- SUPPORTED: indicates that the version is an old version, but it is still supported.
- DEPRECATED: indicates a deprecated version which may be deleted later.
updated
@@ -108,8 +131,8 @@- Links field data structure -
Table 4 Links field data structure description Name
+- Links field description +
Table 5 Parameter description Name
diff --git a/docs/tms/api-ref/en-us_topic_0133313258.html b/docs/tms/api-ref/en-us_topic_0133313258.html index 9e9990b8..755763a9 100644 --- a/docs/tms/api-ref/en-us_topic_0133313258.html +++ b/docs/tms/api-ref/en-us_topic_0133313258.html @@ -6,7 +6,7 @@ Type
- Creating or Deleting Predefined Tags
-
- Querying the Predefined Tag List
+- Querying Predefined Tags
- Modifying Predefined Tags
diff --git a/docs/tms/api-ref/en-us_topic_0170638684.html b/docs/tms/api-ref/en-us_topic_0170638684.html index c3b15cc9..2e5af951 100644 --- a/docs/tms/api-ref/en-us_topic_0170638684.html +++ b/docs/tms/api-ref/en-us_topic_0170638684.html @@ -4,7 +4,7 @@
-
- Permissions Policies and Supported Actions
+- Introduction
- TMS API Actions
diff --git a/docs/tms/api-ref/en-us_topic_0180205868.html b/docs/tms/api-ref/en-us_topic_0180205868.html index c5f69ae5..8430b9c2 100644 --- a/docs/tms/api-ref/en-us_topic_0180205868.html +++ b/docs/tms/api-ref/en-us_topic_0180205868.html @@ -1,14 +1,14 @@ -
Permissions Policies and Supported Actions
-This section describes fine-grained permissions management for your TMS. If your account does not need individual IAM users, then you may skip over this section.
-By default, new IAM users do not have permissions assigned. You need to add a user to one or more groups, and attach permissions policies or roles to these groups. Users inherit permissions from the groups to which they are added and can perform specified operations on cloud services based on the permissions.
-You can grant users permissions by using roles and policies. Roles are a type of coarse-grained authorization mechanism that defines permissions related to user responsibilities. Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.
+Introduction
+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 can skip this section.
+A policy is a set of permissions defined in JSON format. By default, new IAM users do not have permissions assigned. You need to add a user to one or more groups, and attach permissions policies or roles to these groups. Users inherit permissions from the groups to which they are added and can perform specified operations on cloud services based on the permissions. For more information about system policies supported by TMS, see "Permissions Management" in Tag Management Service User Guide.
+You can grant users permissions using roles and policies. Roles are a type of coarse-grained authorization mechanism that defines permissions related to user responsibilities. Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.
![]()
Policy-based authorization is useful if you want to allow or deny the access to an API.
An account has all of the permissions required to call all APIs, but IAM users must be assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user wants to query predefined tags using an API, the user must have been granted permissions that allow the tms:predefineTags:list action.
Supported Actions
Operations supported by a fine-grained policy are specific to APIs. The following are common concepts related to policies:
-+
- Permissions: Statements in a policy that allow or deny certain operations.
- APIs: REST APIs that can be called by a user who has been granted specific permissions.
- Actions: Specific operations that are allowed or denied.
- Related actions: Actions on which a specific action depends to take effect. When assigning permissions for the action to a user, you also need to assign permissions for the related actions.
- IAM or enterprise projects: Type of projects for which an action will take effect. Policies that contain actions supporting both IAM and enterprise projects can be used and take effect in both IAM and Enterprise Management. Policies that only contain actions for IAM projects can be used and only take effect for IAM. Administrators can check whether an action supports IAM projects or enterprise projects in the action list. "√" indicates that the action supports the project and "×" indicates that the action does not support the project.
- Permissions: Statements in a policy that allow or deny certain operations.
- APIs: REST APIs that can be called by a user who has been granted specific permissions.
- Actions: Specific operations that are allowed or denied.
- Dependencies: actions which a specific action depends on. When allowing an action for a user, you also need to allow any existing action dependencies for that user.
- IAM or enterprise projects: Type of projects for which an action will take effect. Policies that contain actions supporting both IAM and enterprise projects can be used and take effect in both IAM and Enterprise Management. Policies that only contain actions for IAM projects can be used and only take effect for IAM. Administrators can check whether an action supports IAM projects or enterprise projects in the action list.
diff --git a/docs/tms/api-ref/en-us_topic_0180205869.html b/docs/tms/api-ref/en-us_topic_0180205869.html index d5127db2..d8f4a430 100644 --- a/docs/tms/api-ref/en-us_topic_0180205869.html +++ b/docs/tms/api-ref/en-us_topic_0180205869.html @@ -20,9 +20,9 @@- tms:predefineTags:list
√
+- Supported
x
+Not supported
Creating predefined tags
@@ -31,9 +31,9 @@- tms:predefineTags:create
√
+- Supported
x
+Not supported
- Deleting predefined tags
@@ -42,53 +42,20 @@- tms:predefineTags:delete
√
+- Supported
x
+Not supported
Modifying predefined tags
+- Modifying a predefined tag
PUT /v1.0/predefine_tags/action
- tms:predefineTags:update
√
+- Supported
- x
-- - Querying resource tags
-- GET /v1.0/tags
-- tms:resourceTags:list
-- √
-- x
-- - Creating tags
-- POST /v1.0/{resource_type}/{resource_id}/tags/action
-- tms:resourceTags:create
-- √
-- x
-- Deleting resource tags
-- POST /v1.0/{resource_type}/{resource_id}/tags/action
-- tms:resourceTags:delete
-- √
-x
+Not supported