URI
- URI format
GET /v2/{project_id}/notifications/topics?offset={offset}&limit={limit}
+URI
- Parameter description
Parameter
@@ -45,9 +45,19 @@Integer
+ The maximum number of records return on each page
+Value range: 1–100
+Common values: 10, 20, and 50
+Default value: 100
+topic_id
+No
+String
+The ID of the topic to be searched for, which is fully matched
Response
- Parameter description
-
Parameter
+Parameter
Type
+Type
Description
+Description
@@ -151,6 +184,9 @@ "name": "test_topic_v1", "push_policy": 0, "enterprise_project_id" : "0" + "topic_id" : "84698185946d44d08431aa441d8e2cf2" + "create_time": "2016-08-01T02:16:38Z", + "update_time": "2016-08-01T02:16:38Z" } ] } diff --git a/docs/smn/api-ref/en-us_topic_0173558608.html b/docs/smn/api-ref/en-us_topic_0173558608.html index a405db9b9..c45d80b98 100644 --- a/docs/smn/api-ref/en-us_topic_0173558608.html +++ b/docs/smn/api-ref/en-us_topic_0173558608.html @@ -8,7 +8,7 @@Table 1 Topic structure Parameter
Type
+Type
Description
Enterprise project ID
topic_id
+String
+Topic ID
+create_time
+String
+The time when the topic was created
+The UTC time is in YYYY-MM-DDTHH:MM:SSZ format.
+update_time
+String
+The time when the topic was updated
+The UTC time is in YYYY-MM-DDTHH:MM:SSZ format.
+An account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned. 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 ECSs using an API, the user must have been granted permissions that allow the ecs:servers:list action.
diff --git a/docs/smn/api-ref/en-us_topic_0173593946.html b/docs/smn/api-ref/en-us_topic_0173593946.html index 61a487996..67a3ee76a 100644 --- a/docs/smn/api-ref/en-us_topic_0173593946.html +++ b/docs/smn/api-ref/en-us_topic_0173593946.html @@ -27,7 +27,7 @@Supported Actions
IAM provides system-defined policies that can be directly used. You can also create custom policies to supplement system-defined policies for more refined access control. Actions supported by policies are specific to APIs. Common concepts related to policies include:
-- 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 dependent actions.
- IAM or enterprise projects: type of projects for which an action will take effect. Policies that contain actions for both IAM and enterprise projects can be used and applied for 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 for both IAM and enterprise projects can be used and applied for 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.
SMN supports the following actions that can be defined in custom policies:
- Topic Operations, including actions supported by topic management APIs, such as APIs for creating, querying, updating, and deleting topics
- Template Operations, including actions supported by message template management APIs, such as the APIs for creating, querying, updating, and deleting message templates
- Tag Operations, including actions supported by TMS APIs, such as the APIs for querying resources, adding a resource tag, adding or deleting resource tags in batches, and deleting a resource a tag
- Message Publishing, including actions supported by message publishing management APIs, such as the message publishing API
- Sending an Application Message (Deprecated), including actions supported by direct application messaging management API, such as the API for sending an application message
Updating a tag
-
+N/A
smn:tag:update
Response
- Parameter description
-
Parameter
+@@ -126,6 +133,7 @@ "display_name": "test create topic v2", "request_id": "6837531fd3f54550927b930180a706bf", "enterprise_project_id" : "0" + "topic_id" : "84698185946d44d08431aa441d8e2cf2" } diff --git a/docs/smn/api-ref/smn_api_51006.html b/docs/smn/api-ref/smn_api_51006.html index bf370f07e..b46f4d9b9 100644 --- a/docs/smn/api-ref/smn_api_51006.html +++ b/docs/smn/api-ref/smn_api_51006.html @@ -6,7 +6,7 @@ -Parameter
Type
+Type
Description
+Description
Enterprise project ID
topic_id
+String
+Topic ID
+URI
- URI format
GET /v2/{project_id}/notifications/topics/{topic_urn}/attributes?name={name}
+URI
- Parameter description
Parameter
@@ -59,11 +59,11 @@Response
- Parameter description
-
Parameter
+Parameter
Type
+Type
Description
+Description
- Function
Query the list of all subscriptions by page. The list is sorted by the subscription adding time in ascending order. When querying the subscription list by page, you can specify offset and limit. If no subscription has been added to the topic, an empty list is returned.
URI
- URI format
GET /v2/{project_id}/notifications/subscriptions?offset={offset}&limit={limit}
+URI
- URI format
- Parameter description
Parameter
Response
- Parameter description
-
Parameter
+Parameter
Type
+Type
Description
+Description
Table 1 Subscription structure Parameter
Type
+Type
Description
- Function
Query the list of subscriptions of a specified topic by page. The list is sorted by the subscription adding time in ascending order. You can specify offset and limit. If no subscription has been added to the topic, an empty list is returned.
URI
- URI format
GET /v2/{project_id}/notifications/topics/{topic_urn}/subscriptions?offset={offset}&limit={limit}
+URI
- Parameter description
Parameter
@@ -68,11 +68,11 @@Response
- Parameter description
-
Parameter
+Parameter
Type
+Type
Description
+Description
Table 1 Subscription structure Parameter
Type
+Type
Description
- Function
Create a message template for quick message sending to reduce the request data volume.
By default, a user can create a maximum of 100 message templates. However, in a high-concurrency scenario, which is rare, extra templates may be successfully created.
-Message templates are identified by name, but you can create different templates with the same name as long as they are configured for different protocols. All template messages must include a Default template or they cannot be sent out. The Default template is used anytime a template has not been configured for a given protocol, but as long as there is a template for the protocol, then any subscriber who selected that protocol when they subscribed will receive a message using the corresponding template.
+Message templates are identified by name, but you can create different templates with the same name as long as they are configured for different protocols. You must create a Default template with the same name as each custom template. The Default template is used when no specific template has been set for a given protocol. If a template is configured for a specific protocol, any subscriber who chose that protocol during subscription will receive messages using that specific template. If you create a custom template but do not create a default template with the same name, you cannot use the custom template to publish messages.
Request
- Parameter description
-
Parameter
+Parameter
Mandatory
Type
+Type
Description
+Description
protocol
Yes
+No
String
Response
- Parameter description
-
Parameter
+Parameter
Type
+Type
Description
+Description
-
The template list provides only brief information. To query the template details, see Querying the Details of a Message Template.
URI
- URI format
GET /v2/{project_id}/notifications/message_template?offset={offset}&limit={limit}&message_template_name={message_template_name}&protocol={protocol}
+URI
- Parameter description
Parameter
@@ -82,11 +82,11 @@Response
- Parameter description
-
Parameter
+Parameter
Type
+Type
Description
+Description
Table 1 Message template structure Parameter
Type
+Type
Description
Request
- Parameter description
-
Parameter
+-Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
String
Start location of pagination query. The query starts from the next resource of the specified location. You do not need to specify this parameter when you query resources on the first page. When you query resources on subsequent pages, set this parameter to the location returned in the response body for the previous query.
-- If action is set to count, this parameter does not take effect.
- If action is set to filter, this parameter takes effect. Its value can be 0 (default) or a positive integer.
- If action is set to count, this parameter does not take effect.
- If action is set to filter, this parameter takes effect. Its value can be 0 (default) or a positive integer.
action
@@ -137,7 +137,7 @@Match condition structure array
Key-value pair to be matched
-The key can only be resource_name.
+The only supported key is resource_name.
The value will be exactly matched.
Table 1 Tags structure Parameter
+Table 1 Tags structure Parameter
Mandatory
+Mandatory
Type
+Type
Description
-Constraint
+Description
key
+key
Yes
+Yes
String
+String
Tag key
-A key can contain up to 36 Unicode characters and cannot be left blank.
+The tag key.
+values
+values
Yes
+Yes
String list
+Array of strings
Value list
-Each value can contain up to 43 Unicode characters. If a value starts with an asterisk (*), the string following the asterisk is fuzzy-matched. The values field cannot be missing, but can be an empty list. If it is empty, any value will be matched. Values are in the OR relationship.
+The list of tag values.
+- Request body when action is set to count
{ +- Request body when action is set to count
{ "action": "count", "not_tags": [ { @@ -259,11 +262,11 @@Response
- Parameter description
-
Parameter
+Parameter
Type
+Type
Description
+Description
Table 3 Resource_tag structure Parameter
+Table 3 Resource_tag structure Parameter
Type
+Type
Description
-Constraint
+Description
key
+key
String
+String
Tag key
-A key can contain up to 36 Unicode characters, including only digits, letters, hyphens (-), and underscores (_). A key cannot be left blank, be an empty string, or start or end with a space.
+The tag key.
+value
+value
String
+String
Tag value
-A value can contain up to 43 Unicode characters, including only digits, letters, hyphens (-), and underscores (_). A value can be an empty string, but it cannot start or end with a space.
+The tag value.
+Response body when action is set to count
+Response body when action is set to count
{ "total_count": 1000 }diff --git a/docs/smn/api-ref/smn_api_56002.html b/docs/smn/api-ref/smn_api_56002.html index 0b21ac3e7..17af4c22f 100644 --- a/docs/smn/api-ref/smn_api_56002.html +++ b/docs/smn/api-ref/smn_api_56002.html @@ -50,7 +50,7 @@Resource ID
Obtain a resource ID:
-- Add X-SMN-RESOURCEID-TYPE=name in the request header and set the resource ID to the topic name.
- Call the GetResourceInstances API to obtain the resource ID.
- Add X-SMN-RESOURCEID-TYPE=name in the request header and set the resource ID to the topic name.
- Call the API for querying topics by tag to obtain the resource ID.
Request
- Parameter description
-
Parameter
+-Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
Table 1 Resource_tag structure Parameter
+Table 1 Resource_tag structure Parameter
Type
+Mandatory
Description
+Type
Constraint
+Description
key
+key
String
+Yes
Tag key
+String
A key can contain up to 36 Unicode characters, including only digits, letters, hyphens (-), and underscores (_). A key cannot be left blank, be an empty string, or start or end with a space.
+The tag key.
+value
+value
String
+Yes
Tag value
+String
A value can contain up to 43 Unicode characters, including only digits, letters, hyphens (-), and underscores (_). A value can be an empty string, but it cannot start or end with a space.
+The tag value.
+Resource ID
Obtain a resource ID:
-- Add X-SMN-RESOURCEID-TYPE=name in the request header and set the resource ID to the topic name.
- Call the GetResourceInstances API to obtain the resource ID.
- Add X-SMN-RESOURCEID-TYPE=name in the request header and set the resource ID to the topic name.
- Call the API for querying topics by tag to obtain the resource ID.
Request
- Parameter description
-
Parameter
+-Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
Table 1 Resource_tag structure Parameter
+-Table 1 Resource_tag structure Parameter
Type
+Mandatory
Description
+Type
Constraint
+Description
key
+key
String
+Yes
Tag key
+String
A key can contain up to 36 Unicode characters, including only digits, letters, hyphens (-), and underscores (_). A key cannot be left blank, be an empty string, or start or end with a space.
+The tag key.
+value
+value
String
+Yes
Tag value
+String
A value can contain up to 43 Unicode characters, including only digits, letters, hyphens (-), and underscores (_). A value can be an empty string, but it cannot start or end with a space.
+The tag value.
+Resource ID
Obtain a resource ID:
-- Add X-SMN-RESOURCEID-TYPE=name in the request header and set the resource ID to the topic name.
- Call the GetResourceInstances API to obtain the resource ID.
- Add X-SMN-RESOURCEID-TYPE=name in the request header and set the resource ID to the topic name.
- Call the API for querying topics by tag to obtain the resource ID.
Resource ID
Obtain a resource ID:
-- Add X-SMN-RESOURCEID-TYPE=name in the request header and set the resource ID to the topic name.
- Call the GetResourceInstances API to obtain the resource ID.
- Add X-SMN-RESOURCEID-TYPE=name in the request header and set the resource ID to the topic name.
- Call the API for querying topics by tag to obtain the resource ID.
Table 1 Resource_tag structure Parameter
+-Table 1 Resource_tag structure Parameter
Type
+Type
Description
-Constraint
+Description
key
+key
String
+String
Tag key
-A key can contain up to 36 Unicode characters, including only digits, letters, hyphens (-), and underscores (_). A key cannot be left blank, be an empty string, or start or end with a space.
+The tag key.
+value
+value
String
+String
Tag value
-A value can contain up to 43 Unicode characters, including only digits, letters, hyphens (-), and underscores (_). A value can be an empty string, but it cannot start or end with a space.
+The tag value.
+Table 1 Tags structure Parameter
+Table 1 Tags structure Parameter
Type
+Type
Description
-Constraint
+Description
key
+key
String
+String
Tag key
-A key can contain up to 36 Unicode characters. A key cannot be left blank.
+The tag key.
+values
+values
String list
+String list
Value list
-Each value can contain up to 43 Unicode characters. If a value starts with an asterisk (*), the string following the asterisk is fuzzy-matched. The values field cannot be missing, but can be an empty list. If it is empty, any value will be matched. Values are in the OR relationship.
+The list of tag values.
+-
-
- General Request Return Code
+ - Returned Values for General Requests
- Error Codes
diff --git a/docs/smn/api-ref/smn_api_63000.html b/docs/smn/api-ref/smn_api_63000.html
index a7d5654dc..d42ba423a 100644
--- a/docs/smn/api-ref/smn_api_63000.html
+++ b/docs/smn/api-ref/smn_api_63000.html
@@ -1,6 +1,6 @@
- - Abnormal
Returned Value
Description
+Description
-Parent topic: General Request Return Code+Parent topic: Returned Values for General Requests
General Request Return Code
+Returned Values for General Requests
-
diff --git a/docs/smn/api-ref/smn_api_63001.html b/docs/smn/api-ref/smn_api_63001.html
index 68471913a..52a18a789 100644
--- a/docs/smn/api-ref/smn_api_63001.html
+++ b/docs/smn/api-ref/smn_api_63001.html
@@ -44,7 +44,7 @@
diff --git a/docs/smn/api-ref/smn_api_63002.html b/docs/smn/api-ref/smn_api_63002.html index 487d7ac07..e094e9dba 100644 --- a/docs/smn/api-ref/smn_api_63002.html +++ b/docs/smn/api-ref/smn_api_63002.html @@ -25,7 +25,7 @@-Parent topic: General Request Return Code+Parent topic: Returned Values for General Requests
- Parameter description
-
- Parameter description
-
- Parameter description
- URI format
- Parameter description
-
- Function
- Parameter description
-
- Parameter description
- Function
- Parameter description
-
- Function
- Parameter description
-
- Parameter description
- URI format
- Parameter description
-
- Parameter description