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 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.
For details about how to use APIs, see API Usage Guidelines.
Permissions Policies and Supported Actions
+ +Permissions Policies and Supported Actions
+This section describes fine-grained permissions management for your SMN resources. If your account does not need individual IAM users, you can 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: A type of coarse-grained authorization mechanism that defines service-level permissions based on user responsibilities. There are only a limited number of roles for granting permissions to users. Policies: A type of fine-grained authorization mechanism that defines permissions required to perform operations on specific cloud resources under certain conditions. This mechanism allows for more flexible policy-based authorization and secure access control.
+
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 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.
+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 take effect 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, including actions supported by direct application messaging management API, such as the API for sending an application message
Topic Operations
+Permission + |
+API + |
+Action + |
+IAM Project + |
+Enterprise Project + |
+
|---|---|---|---|---|
Creating a topic + |
+POST /v2/{project_id}/notifications/topics + |
+smn:topic:create + |
+√ + |
+√ + |
+
Querying a topic + |
+GET /v2/{project_id}/notifications/topics + |
+smn:topic:list + |
+√ + |
+√ + |
+
Updating a topic + |
+PUT /v2/{project_id}/notifications/topics/{topic_urn} + |
+smn:topic:update + |
+√ + |
+√ + |
+
Deleting a topic + |
+DELETE /v2/{project_id}/notifications/topics/{topic_urn} + |
+smn:topic:delete + |
+√ + |
+√ + |
+
Template Operations
+Permission + |
+API + |
+Action + |
+IAM Project + |
+Enterprise Project + |
+
|---|---|---|---|---|
Creating a message template + |
+POST /v2/{project_id}/notifications/message_template + |
+smn:template:create + |
+√ + |
+× + |
+
Querying a message template + |
+GET /v2/{project_id}/notifications/message_template + |
+smn:template:list + |
+√ + |
+× + |
+
Modifying a message template + |
+PUT /v2/{project_id}/notifications/message_template/{message_template_id} + |
+smn:template:update + |
+√ + |
+× + |
+
Deleting a message template + |
+DELETE /v2/{project_id}/notifications/message_template/{message_template_id} + |
+smn:template:delete + |
+√ + |
+× + |
+
Message Publishing
+Permission + |
+API + |
+Action + |
+IAM Project + |
+Enterprise Project + |
+
|---|---|---|---|---|
Publishing a message + |
+POST /v2/{project_id}/notifications/topics/{topic_urn}/publish + |
+smn:topic:publish + |
+√ + |
+× + |
+
Tag Operations
+Permission + |
+API + |
+Action + |
+IAM Project + |
+Enterprise Project + |
+
|---|---|---|---|---|
Adding a resource tag + |
+POST /v2/{project_id}/{resource_type}/{resource_id}/tags + |
+smn:tag:create + |
+√ + |
+√ + |
+
Updating a tag + |
+- + |
+smn:tag:update + |
+√ + |
+√ + |
+
Deleting a resource tag + |
+DELETE /v2/{project_id}/{resource_type}/{resource_id}/tags/{key} + |
+smn:tag:delete + |
+√ + |
+√ + |
+
Querying resource tags + |
+GET /v2/{project_id}/{resource_type}/{resource_id}/tags + |
+smn:tag:list + |
+√ + |
+√ + |
+
Sending an Application Message
+Permission + |
+API + |
+Action + |
+IAM Project + |
+Enterprise Project + |
+
|---|---|---|---|---|
Sending an application message + |
+POST /v2/{project_id}/notifications/endpoints/{endpoint_urn}/publish + |
+smn:application:publish + + |
+√ + |
+√ + |
+
+
-
diff --git a/docs/smn/api-ref/smn_api_51000.html b/docs/smn/api-ref/smn_api_51000.html index 594cc7f1..80f99d91 100644 --- a/docs/smn/api-ref/smn_api_51000.html +++ b/docs/smn/api-ref/smn_api_51000.html @@ -4,23 +4,23 @@
-
-
- Creating a Topic
+ - Creating a Topic
- - Modifying a Topic
+ - Updating a Topic
+
+ - Querying Topics
+
+ - Querying Details of a Topic
+
+ - Querying a Topic Policy
+
+ - Updating a Topic Policy
- Deleting a Topic
- - Querying Topics
+ - Deleting a Specified Topic Policy
- - Querying Topic Details
-
- - Querying Topic Attributes
-
- - Modifying Topic Attributes
-
- - Deleting a Specified Topic Attribute
-
- - Deleting All Topic Attributes
+ - Deleting All Topic Policies
Listing All SMN API Versions
-Description
- API name
QueryApiSupportVersions
- - Function
List all SMN API versions.
+-URI
- URI format
GET /
+ -Request
- Request example
GET https://{SMN_Endpoint}/+Request
- Example request
GET https://{SMN_Endpoint}/
Response
- Parameter description
@@ -58,7 +58,7 @@
String
Version status, which can be the following:
-- CURRENT: widely used version
- SUPPORTED: earlier version, which is still supported
- DEPRECATED: deprecated version, which may be deleted later
- CURRENT: widely used version
- SUPPORTED: earlier version that is still supported
- DEPRECATED: deprecated version that may be deleted later
updated
@@ -111,7 +111,7 @@ -- Response example
{ +- Example response
-{ "versions": [ { "id": "v2", @@ -130,9 +130,9 @@ }Returned Value
See section Returned Value.
+-Returned Value
See Returned Value.
diff --git a/docs/smn/api-ref/smn_api_510002.html b/docs/smn/api-ref/smn_api_510002.html index 3ce39576..8a87a6d8 100644 --- a/docs/smn/api-ref/smn_api_510002.html +++ b/docs/smn/api-ref/smn_api_510002.html @@ -1,11 +1,11 @@Querying the SMN API v2 Version
-Description
- API name
QueryV2ApiInfo
- - Function
Query the SMN API v2 version information.
+-URI
- URI format
GET /{api_version}
+-URI
- URI format
- Parameter description
-
Parameter
Request
- Request example
GET https://{SMN_Endpoint}/v2+Request
- Example request
GET https://{SMN_Endpoint}/v2
Response
- Parameter description
@@ -41,7 +41,7 @@
Type
Description
+Description
- Example request
Object
Version object
+Version information
String
Version status, which can be the following:
-- CURRENT: widely used version
- SUPPORTED: earlier version which is still supported
- DEPRECATED: deprecated version which may be deleted later
- CURRENT: widely used version
- SUPPORTED: earlier version that is still supported
- DEPRECATED: deprecated version that may be deleted later
updated
@@ -136,7 +136,7 @@ - Request example
- Response example
{ + - Example response
{ "version": { "id": "v2", @@ -154,9 +154,9 @@ }
Returned Value
See section Returned Value.
+-Returned Value
See Returned Value.
diff --git a/docs/smn/api-ref/smn_api_51001.html b/docs/smn/api-ref/smn_api_51001.html deleted file mode 100644 index 580c3f1f..00000000 --- a/docs/smn/api-ref/smn_api_51001.html +++ /dev/null @@ -1,124 +0,0 @@ - - -Creating a Topic
---Description
- API name
CreateTopic
-
- Function
Create a topic. Each user can create 3000 topics at most. In the high-concurrent scenario, a user may create a few topics more than 3000.
-The API is idempotent. It returns a successful result after creating a topic. If a topic of the same name already exists, the status code is 200. Otherwise, the status code is 201.
-
-URI
- URI format
POST /v2/{project_id}/notifications/topics
-
- Parameter description
--
-Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Project ID
- -
-Request
- Parameter description
--
-Parameter
-Mandatory
-Type
-Description
-name
-Yes
-String
-Name of the topic to be created
-The topic name is a string of 1 to 255 characters. It must contain letters, digits, hyphens (-), and underscores (_), and must start with a letter or digit.
-display_name
-No
-String
-Topic display name, which is presented as the name of the email sender in email messages
-The display name cannot exceed 192 bytes.
-The value is left blank by default.
-
- Request example
POST https://{SMN_Endpoint}/v2/{project_id}/notifications/topics-{ - "name": "test_topic_v2", - "display_name": "testtest" -}-
-Response
- Parameter description
--
-Parameter
-Type
-Description
-request_id
-String
-Request ID, which is unique
-topic_urn
-String
-Unique resource ID of a topic. You can obtain it based on Querying Topics.
-
- Response example
{ - "request_id": "6a63a18b8bab40ffb71ebd9cb80d0085", - "topic_urn": "urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_topic_v2" -}-
-Returned Value
See Returned Value.
--Error Codes
See Error Code.
--- diff --git a/docs/smn/api-ref/smn_api_51002.html b/docs/smn/api-ref/smn_api_51002.html deleted file mode 100644 index 1714608b..00000000 --- a/docs/smn/api-ref/smn_api_51002.html +++ /dev/null @@ -1,110 +0,0 @@ - - ---Parent topic: Topic Operations-Modifying a Topic
---Description
- API name
UpdateTopic
-
- Function
Update the topic display name.
-
-URI
- URI format
PUT /v2/{project_id}/notifications/topics/{topic_urn}
-
- Parameter description
--
-Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Project ID
- -topic_urn
-Yes
-String
-Unique resource ID of a topic. You can obtain it according to Querying Topics.
-
-Request
- Parameter description
--
-Parameter
-Mandatory
-Type
-Description
-display_name
-No
-String
-Topic display name, which is presented as the name of the email sender in email messages
-The display name cannot exceed 192 bytes.
- - Request example
PUT https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_topic_v2 -{ - "display_name":"testtest222" -}-
-Response
- Parameter description
--
-Parameter
-Type
-Description
-request_id
-String
-Request ID, which is unique
- - Response example
{ - "request_id": "6a63a18b8bab40ffb71ebd9cb80d0085" -}-
-Returned Value
See section Returned Value.
--Error Code
See section Error Code.
--- diff --git a/docs/smn/api-ref/smn_api_51003.html b/docs/smn/api-ref/smn_api_51003.html index 3af76a75..e2a875fc 100644 --- a/docs/smn/api-ref/smn_api_51003.html +++ b/docs/smn/api-ref/smn_api_51003.html @@ -1,12 +1,12 @@--Parent topic: Topic Operations-Deleting a Topic
-Description
- API name
DeleteTopic
+-Description
-URI
- URI format
DELETE /v2/{project_id}/notifications/topics/{topic_urn}
+URI
- Parameter description
Parameter
@@ -35,7 +35,7 @@String
Unique resource ID of a topic. You can obtain it according to Querying Topics.
+Unique resource ID of a topic. You can obtain it by referring to Querying Topics.
Request
Request exampleDELETE https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_topic_v2+Request
Example requestDELETE https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_topic_v2Response
- Parameter description
-
Parameter
+-Parameter
Type
+Type
Description
+Description
- Response example
{ - "request_id": " 5fcba32bd2814ea39431829c22bda94b", +- Example response
-{ + "request_id": "5fcba32bd2814ea39431829c22bda94b" }Returned Value
See section Returned Value.
+-Returned Value
See Returned Value.
diff --git a/docs/smn/api-ref/smn_api_51004.html b/docs/smn/api-ref/smn_api_51004.html deleted file mode 100644 index 679b0fd3..00000000 --- a/docs/smn/api-ref/smn_api_51004.html +++ /dev/null @@ -1,162 +0,0 @@ - - -Querying Topics
---Description
- API name
ListTopics
-
- Function
Query the topic list by page. The list is sorted by the topic creation time in descending order. If no topic has been created, an empty list is returned.
-
-URI
- URI format
GET /v2/{project_id}/notifications/topics?offset={offset}&limit={limit}
-
- Parameter description
--
-Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Project ID
- -offset
-No
-int
-Offset
-If the value is an integer greater than 0 but less than the number of resources, all resources after this offset will be queried. The default value is 0.
-limit
-No
-int
-- Number of resources returned on each page
- Value range: 1–100
Commonly used values are 10, 20, and 50.
-The default value is 100.
-
-Request
Request example-GET https://{SMN_Endpoint}/v2/{project_id}/notifications/topics?offset=0&limit=100--Response
- Parameter description
-- -
-Parameter
-Type
-Description
-request_id
-String
-Request ID, which is unique
-topic_count
-int
-Number of topics in your account
-NOTE:-No matter what offset and limit values you have set in the request, this parameter always returns the total number of topics.
-topics
-Topic structure array
-Topic details
-See Table 1.
--
-Table 1 Topic structure Parameter
-Type
-Description
-topic_urn
-String
-Resource identifier of a topic, which is unique
-name
-String
-Topic name
-display_name
-String
-Topic display name, which is presented as the name of the email sender in email messages
-push_policy
-Int
-Message push policy
-- 0: Failed messages will be saved in message queues.
- 1: Failed messages will be discarded.
- Response example
{ - "request_id": "70bb40bef50e4a14b116a5a527fd7432", - "topic_count": 1, - "topics": [ - { - "topic_urn": "urn:smn:regionId:8bad8a40e0f7462f8c1676e3f93a8183:test_topic_v2", - "display_name": "testtest", - "name": "test_topic_v1", - "push_policy": 0 - } - ] -}-
-Returned Value
See section Returned Value.
--Error Code
See section Error Code.
--- diff --git a/docs/smn/api-ref/smn_api_51005.html b/docs/smn/api-ref/smn_api_51005.html index 9bd8ca39..6be9f416 100644 --- a/docs/smn/api-ref/smn_api_51005.html +++ b/docs/smn/api-ref/smn_api_51005.html @@ -1,12 +1,12 @@ ---Parent topic: Topic Operations-Querying Topic Details
-Description
- API name
QueryTopicDetail
+Querying Details of a Topic
+-Description
-URI
- URI format
GET /v2/{project_id}/notifications/topics/{topic_urn}
+URI
- Parameter description
Parameter
@@ -35,7 +35,7 @@String
Unique resource ID of a topic. You can obtain it according to Querying Topics.
+Unique resource ID of a topic. You can obtain it by referring to Querying Topics.
Request
Request exampleGET https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:8bad8a40e0f7462f8c1676e3f93a8183:test_create_topic_v2+Request
Example requestGET https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:8bad8a40e0f7462f8c1676e3f93a8183:test_create_topic_v2Response
- Parameter description
-
Parameter
+-Parameter
Type
+Type
Description
+Description
String
Unique resource ID of a topic. You can obtain it according to Querying Topics.
+Unique resource ID of a topic. You can obtain it by referring to Querying Topics.
display_name
@@ -85,7 +85,7 @@push_policy
int
+Integer
Message pushing policy
0 indicates that the message sending fails and the message is cached in the queue. 1 indicates that the failed message is discarded.
@@ -107,23 +107,31 @@The UTC time is in YYYY-MM-DDTHH:MM:SSZ format.
enterprise_project_id
+String
+Enterprise project ID
+- Response example
{ - "update_time":"2016-08-01T02:16:38Z", - "push_policy":0, - "create_time":"2016-08-01T02:16:38Z", - "name":"test_create_topic_v2", - "topic_urn":"urn:smn:regionId:8bad8a40e0f7462f8c1676e3f93a8183:test_create_topic_v2", - "display_name":"test create topic v2", - "request_id":"6837531fd3f54550927b930180a706bf" +- Example response
-{ + "update_time": "2016-08-01T02:16:38Z", + "push_policy": 0, + "create_time": "2016-08-01T02:16:38Z", + "name": "test_create_topic_v2", + "topic_urn": "urn:smn:regionId:8bad8a40e0f7462f8c1676e3f93a8183:test_create_topic_v2", + "display_name": "test create topic v2", + "request_id": "6837531fd3f54550927b930180a706bf", + "enterprise_project_id" : "0" }Returned Value
See section Returned Value.
+-Returned Value
See Returned Value.
diff --git a/docs/smn/api-ref/smn_api_51006.html b/docs/smn/api-ref/smn_api_51006.html index f33f214f..bf370f07 100644 --- a/docs/smn/api-ref/smn_api_51006.html +++ b/docs/smn/api-ref/smn_api_51006.html @@ -1,12 +1,12 @@ -Querying Topic Attributes
-Description
- API name
ListTopicAttributes
+Querying a Topic Policy
+-Description
-URI
- URI format
GET /v2/{project_id}/notifications/topics/{topic_urn}/attributes?name={name}
+URI
- Parameter description
-
Parameter
@@ -35,7 +35,7 @@String
Unique resource ID of a topic. You can obtain it according to Querying Topics.
+Unique resource ID of a topic. You can obtain it by referring to Querying Topics.
name
@@ -44,26 +44,26 @@String
Attribute name
-Only specified attribute names are supported. For details, see section Topic Attribute List.
+Specifies the policy name.
+Only specified policy names are supported. For details, see Topic Attribute List.
-If the name parameter is not specified, all attribute values of the topic are queried. The supported attribute values are provided in section Topic Attribute List.
+ If name is not specified, all attribute values of the topic are queried. The supported attribute values are provided in Topic Attribute List.
Request
Request exampleGET https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:8bad8a40e0f7462f8c1676e3f93a8183:test_create_topic_v2/attributes?name=access_policy+Request
Example requestGET https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:8bad8a40e0f7462f8c1676e3f93a8183:test_create_topic_v2/attributes?name=access_policyResponse
- Parameter description
-
Parameter
+-Parameter
Type
+Type
Description
+Description
- Response example
{ - "request_id":"6837531fd3f54550927b930180a706bf", +- Example response
{ + "request_id": "6837531fd3f54550927b930180a706bf", "attributes": { "access_policy": "{ "Version": "2016-09-07", @@ -117,13 +117,13 @@ }" } }- -The value of access_policy is a JSON character string, which requires escape characters. While in the preceding example, the characters are not escaped. You need to escape them before using the policy.
+ The value of access_policy is a JSON character string, which requires escape characters. While in the preceding example, the characters are not escaped. Escape them before using the policy.
Returned Value
See section Returned Value.
+-Returned Value
See Returned Value.
diff --git a/docs/smn/api-ref/smn_api_51007.html b/docs/smn/api-ref/smn_api_51007.html index 5bc113d2..c49a7fb1 100644 --- a/docs/smn/api-ref/smn_api_51007.html +++ b/docs/smn/api-ref/smn_api_51007.html @@ -1,12 +1,12 @@ -Modifying Topic Attributes
-Description
- API name
UpdateTopicAttribute
+Updating a Topic Policy
+-Description
-URI
- URI format
PUT /v2/{project_id}/notifications/topics/{topic_urn}/attributes/{name}
+URI
- Parameter description
Parameter
@@ -35,7 +35,7 @@String
Unique resource ID of a topic. You can obtain it according to Querying Topics.
+Unique resource ID of a topic. You can obtain it by referring to Querying Topics.
name
@@ -44,8 +44,8 @@String
Attribute name
-Only specified attribute names are supported. For details, see Topic Attribute List.
+Specifies the policy name.
+Only specified policy names are supported. For details, see Topic Attribute List.
Request
- Parameter description
-
Parameter
+-Parameter
Mandatory
Type
+Type
Description
+Description
String
Topic attribute value
-The value cannot exceed 30 KB. For details, see Table 1.
+- If you set name to access_policy, value is the topic attributes, and the maximum length of value is 30 KB.
- If you set name to introduction, value is the topic introduction, and the maximum length of value is 120 bytes.
For details, see Table 1.
Table 1 Topic attribute values Name
+@@ -197,17 +205,17 @@ ] }" } -Table 1 Topic attribute values Parameter
Description
Restriction
+Constraint
Policy specification version
Currently, only 2016-09-07 is supported.
+Only 2016-09-07 is supported.
Id
Policy ID, which uniquely identifies a policy
The value cannot be empty.
+Id must be specified.
Statement
@@ -115,7 +116,7 @@Description
Restriction
+Constraint
Statement effect
The value can be Allow or Deny.
+The effect can be Allow or Deny.
Principal
NotPrincipal
- Principal: object to which the statement applies
- NotPrincipal: object to which the statement does not apply
There are currently two supported values:
+- Principal: object to which the statement applies
- NotPrincipal: object to which the statement does not apply
The following two types of objects are supported:
- CSP: one or more cloud users
- Service: one or more cloud services
Either the Principal or NotPrincipal element must be configured.
-- If you enter CSP, you must specify user information in the format urn:csp:iam::domainId:root. You need to obtain the domain ID of each user you specify.
- If you enter Service, you must specify the cloud service names in lower case.
- If you enter CSP, you must specify user information in the format urn:csp:iam::domainId:root. Obtain the domain ID of each user you specify.
- If you enter Service, you must specify the cloud service names in lower case.
Action
@@ -151,20 +152,27 @@- NotAction: statement action not allowed
You can use a wildcard character to configure a set of actions, for example, SMN:Update* and SMN:Delete*. If you only enter a wildcard character (*) in a statement, all supported actions are allowed.
Either the Action or NotAction element must be configured.
+Either Action or NotAction must be configured.
The following actions are supported:
- SMN:UpdateTopic
- SMN:DeleteTopic
- SMN:QueryTopicDetail
- SMN:ListTopicAttributes
- SMN:UpdateTopicAttribute
- SMN:DeleteTopicAttributes
- SMN:DeleteTopicAttributeByName
- SMN:ListSubscriptionsByTopic
- SMN:Subscribe
- SMN:Unsubscribe
- SMN:Publish
Resource
-NotResource
- Resource: topic to which a statement applies
- NotResource: topic to which a statement does not apply
Specifies the topic the statement applies to.
Either the Resource or NotResource element must be configured.
+Either Resource or NotResource must be configured.
You need to enter a topic URN.
NotResource
+Specifies the topic the statement does not apply to.
+Either Resource or NotResource must be configured.
+You need to enter a topic URN.
+ You need to replace {project_id}, {domainID}, and {topic_urn} with the actual values.
-domainID indicates the user's domain ID. To obtain it, log in to the SMN console, click My Credential in the username drop-down list on the upper right.
+ Replace {project_id}, {domainID}, and {topic_urn} with the actual values.
+domainID indicates the user's account ID. To obtain it, log in to the SMN console, click My Credentials in the username drop-down list on the upper right.
Response
- Parameter description
-
Parameter
+Parameter
Type
+Type
Description
+Description
-Returned Value
See Returned Value.
diff --git a/docs/smn/api-ref/smn_api_51008.html b/docs/smn/api-ref/smn_api_51008.html index 007fb940..5b2b649d 100644 --- a/docs/smn/api-ref/smn_api_51008.html +++ b/docs/smn/api-ref/smn_api_51008.html @@ -1,12 +1,12 @@ -Deleting a Specified Topic Attribute
-Description
- API name
DeleteTopicAttributeByName
+Deleting a Specified Topic Policy
+-Description
-URI
- URI format
DELETE /v2/{project_id}/notifications/topics/{topic_urn}/attributes/{name}
+URI
- Parameter description
Parameter
@@ -35,7 +35,7 @@String
Unique resource ID of a topic. You can obtain it according to Querying Topics.
+Unique resource ID of a topic. You can obtain it by referring to Querying Topics.
name
@@ -45,7 +45,7 @@String
Attribute name
-Only specified attribute names are supported. For details, see section Topic Attribute List.
+Only specified attribute names are supported. For details, see Topic Attribute List.
Response
- Parameter description
-
Parameter
+Parameter
Type
+Type
Description
+Description
- Example response
{ - "request_id":"6837531fd3f54550927b930180a706bf" + "request_id": "6837531fd3f54550927b930180a706bf" }-Returned Value
See Returned Value.
diff --git a/docs/smn/api-ref/smn_api_51009.html b/docs/smn/api-ref/smn_api_51009.html index bd289731..263fb656 100644 --- a/docs/smn/api-ref/smn_api_51009.html +++ b/docs/smn/api-ref/smn_api_51009.html @@ -1,12 +1,12 @@ -Deleting All Topic Attributes
-Description
- API name
DeleteTopicAttributes
+Deleting All Topic Policies
+-Description
-URI
- URI format
DELETE /v2/{project_id}/notifications/topics/{topic_urn}/attributes
+URI
- Parameter description
Parameter
@@ -35,7 +35,7 @@String
Unique resource ID of a topic. You can obtain it according to Querying Topics.
+Unique resource ID of a topic. You can obtain it by referring to Querying Topics.
Response
- Parameter description
-
Parameter
+Parameter
Type
+Type
Description
+Description
- Example response
-{ - "request_id":"6837531fd3f54550927b930180a706bf" + "request_id": "6837531fd3f54550927b930180a706bf" }Returned Value
See section Returned Value.
+-Returned Value
See Returned Value.
diff --git a/docs/smn/api-ref/smn_api_52000.html b/docs/smn/api-ref/smn_api_52000.html index 24172ad3..2e3a13b1 100644 --- a/docs/smn/api-ref/smn_api_52000.html +++ b/docs/smn/api-ref/smn_api_52000.html @@ -4,12 +4,12 @@-
+
- Adding a Subscription
+ - Querying Subscriptions
- Querying Subscriptions of a Specified Topic
- - Adding a Subscription
- - Deleting a Subscription
Querying Subscriptions
-Description
- API name
ListSubscriptions
+-Description
-- Function
Query the list of all subscriptions by page. The list is sorted by the subscription adding time in ascending order. If no subscription has been added, an empty list is returned.
+
URI
- URI format
GET /v2/{project_id}/notifications/subscriptions?offset={offset}&limit={limit}
+URI
- URI format
GET /v2/{project_id}/notifications/subscriptions?offset={offset}&limit={limit}
- Parameter description
Parameter
No
int
+Integer
Offset
-If the value is an integer greater than 0 but less than the number of resources, all resources after this offset will be queried. The default value is 0.
+If the offset is an integer greater than 0 but less than the number of resources, all resources after this offset will be queried. The default offset is 0.
limit
No
int
+Integer
Response
- Parameter description
-
Parameter
+Parameter
Type
+Type
Description
+Description
subscription_count
int
+Integer
Number of subscriptions
subscriptions
Subscription structure array
+Array of Table 1 objects
See Table 1.
+Subscription structure
Table 1 Subscription structure Parameter
Type
+Type
Description
String
Subscription protocol (Different protocols indicate different types of endpoints to receive messages.)
-Currently, the following protocols are supported:
+The following protocols are supported:
- email: The endpoints are email address.
- sms: The endpoints are phone numbers.
- http and https: The endpoints are URLs.
status
Int
+Integer
Subscription status
- 0: unconfirmed
- 1: confirmed
- 3: canceled
Returned Value
See section Returned Value.
+-Returned Value
See Returned Value.
diff --git a/docs/smn/api-ref/smn_api_52002.html b/docs/smn/api-ref/smn_api_52002.html index 472b0980..1b656ad0 100644 --- a/docs/smn/api-ref/smn_api_52002.html +++ b/docs/smn/api-ref/smn_api_52002.html @@ -1,12 +1,12 @@Querying Subscriptions of a Specified Topic
-Description
- API name
ListSubscriptionsByTopic
+-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. 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
- URI format
GET /v2/{project_id}/notifications/topics/{topic_urn}/subscriptions?offset={offset}&limit={limit}
- Parameter description
Parameter
@@ -35,27 +35,27 @@String
Unique resource ID of a topic. You can obtain it according to Querying Topics.
+Unique resource ID of a topic. You can obtain it by referring to Querying Topics.
offset
No
int
+Integer
Offset
-If the value is an integer greater than 0 but less than the number of resources, all resources after this offset will be queried. The default value is 0.
+If the offset is an integer greater than 0 but less than the number of resources, all resources after this offset will be queried. The default offset is 0.
limit
No
int
+Integer
Response
- Parameter description
-
Parameter
+
- Parameter description
-
- URI format
- Function
- Parameter description
-
- URI format
- Function
- Example response
- Parameter description
-
- Parameter description
- URI format
- Example response
- Parameter description
-
- Parameter description
- URI format
- API name
- Parameter description
-
- Parameter description
- URI format
- Response example
- Parameter description
-
- Parameter description
- URI format
- Response example
- Parameter description
-
- Parameter description
- URI format
- Response example
- Parameter description
-
- Parameter description
- URI format
- URI format
- Example request
- Request example
- URI format