Importing Subscribers
Function
This API is used to add a subscriber to a specified topic. The subscriber is already in the subscriber list.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/notifications/topics/{topic_urn}/subscriptions/from-subscription-users
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID.For details about how to obtain the project ID, see Obtaining the Project ID. |
topic_urn |
Yes |
String |
Specifies the unique resource identifier of the topic. To obtain the resource identifier, see Querying Topics. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Specifies a user token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
ids |
Yes |
Array of strings |
Specifies the ID list of subscribers. |
Response Parameters
Status code: 201
Parameter |
Type |
Description |
---|---|---|
subscriptions_result |
Array of AddSubscriptionFromSubscriptionUserResponseItem objects |
Specifies the subscription adding result. |
Parameter |
Type |
Description |
---|---|---|
http_code |
Integer |
Specifies the HTTP code. |
request_id |
String |
Specifies the unique request ID. |
subscription_urn |
String |
Specifies the resource identifier of a subscription, which is unique. |
error_code |
String |
Specifies the error code. |
error_msg |
String |
Specifies the error message. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Specifies the unique ID of a request. |
error_code |
String |
Specifies the error code. |
error_msg |
String |
Specifies the error message. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Specifies the unique ID of a request. |
error_code |
String |
Specifies the error code. |
error_msg |
String |
Specifies the error message. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Specifies the unique ID of a request. |
error_code |
String |
Specifies the error code. |
error_msg |
String |
Specifies the error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Specifies the unique ID of a request. |
error_code |
String |
Specifies the error code. |
error_msg |
String |
Specifies the error message. |
Example Requests
Importing a subscriber to topic test_topic_v1
POST https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:762bdb3251034f268af0e395c53ea09b:test_topic_v1/subscriptions/from-subscription-users
{
"ids" : [ "e08d1d82a57a4772b353d85445cefd7b" ]
}
Example Responses
Status code: 201
OK
{
"subscriptions_result" : [ {
"http_code" : 201,
"request_id" : "6a63a18b8bab40ffb71ebd9cb80d0085",
"subscription_urn" : "urn:smn:regionId:762bdb3251034f268af0e395c53ea09b:test_topic_v1:2e778e84408e44058e6cbc6d3c377837"
} ]
}
SDK Sample Code
The SDK sample code is as follows.
Importing a subscriber to topic test_topic_v1
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
package com.huaweicloud.sdk.test;
import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.smn.v2.region.SmnRegion;
import com.huaweicloud.sdk.smn.v2.*;
import com.huaweicloud.sdk.smn.v2.model.*;
import java.util.List;
import java.util.ArrayList;
public class AddSubscriptionFromSubscriptionUserSolution {
public static void main(String[] args) {
// The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
// In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
String ak = System.getenv("CLOUD_SDK_AK");
String sk = System.getenv("CLOUD_SDK_SK");
String projectId = "{project_id}";
ICredential auth = new BasicCredentials()
.withProjectId(projectId)
.withAk(ak)
.withSk(sk);
SmnClient client = SmnClient.newBuilder()
.withCredential(auth)
.withRegion(SmnRegion.valueOf("<YOUR REGION>"))
.build();
AddSubscriptionFromSubscriptionUserRequest request = new AddSubscriptionFromSubscriptionUserRequest();
request.withTopicUrn("{topic_urn}");
AddSubscriptionFromSubscriptionUserRequestBody body = new AddSubscriptionFromSubscriptionUserRequestBody();
List<String> listbodyIds = new ArrayList<>();
listbodyIds.add("e08d1d82a57a4772b353d85445cefd7b");
body.withIds(listbodyIds);
request.withBody(body);
try {
AddSubscriptionFromSubscriptionUserResponse response = client.addSubscriptionFromSubscriptionUser(request);
System.out.println(response.toString());
} catch (ConnectionException e) {
e.printStackTrace();
} catch (RequestTimeoutException e) {
e.printStackTrace();
} catch (ServiceResponseException e) {
e.printStackTrace();
System.out.println(e.getHttpStatusCode());
System.out.println(e.getRequestId());
System.out.println(e.getErrorCode());
System.out.println(e.getErrorMsg());
}
}
}
|
Importing a subscriber to topic test_topic_v1
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
# coding: utf-8
import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdksmn.v2.region.smn_region import SmnRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksmn.v2 import *
if __name__ == "__main__":
# The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
# In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
ak = os.environ["CLOUD_SDK_AK"]
sk = os.environ["CLOUD_SDK_SK"]
projectId = "{project_id}"
credentials = BasicCredentials(ak, sk, projectId)
client = SmnClient.new_builder() \
.with_credentials(credentials) \
.with_region(SmnRegion.value_of("<YOUR REGION>")) \
.build()
try:
request = AddSubscriptionFromSubscriptionUserRequest()
request.topic_urn = "{topic_urn}"
listIdsbody = [
"e08d1d82a57a4772b353d85445cefd7b"
]
request.body = AddSubscriptionFromSubscriptionUserRequestBody(
ids=listIdsbody
)
response = client.add_subscription_from_subscription_user(request)
print(response)
except exceptions.ClientRequestException as e:
print(e.status_code)
print(e.request_id)
print(e.error_code)
print(e.error_msg)
|
Importing a subscriber to topic test_topic_v1
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 |
package main
import (
"fmt"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
smn "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smn/v2"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smn/v2/model"
region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smn/v2/region"
)
func main() {
// The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
// In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
ak := os.Getenv("CLOUD_SDK_AK")
sk := os.Getenv("CLOUD_SDK_SK")
projectId := "{project_id}"
auth := basic.NewCredentialsBuilder().
WithAk(ak).
WithSk(sk).
WithProjectId(projectId).
Build()
client := smn.NewSmnClient(
smn.SmnClientBuilder().
WithRegion(region.ValueOf("<YOUR REGION>")).
WithCredential(auth).
Build())
request := &model.AddSubscriptionFromSubscriptionUserRequest{}
request.TopicUrn = "{topic_urn}"
var listIdsbody = []string{
"e08d1d82a57a4772b353d85445cefd7b",
}
request.Body = &model.AddSubscriptionFromSubscriptionUserRequestBody{
Ids: listIdsbody,
}
response, err := client.AddSubscriptionFromSubscriptionUser(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Importing a subscriber to topic test_topic_v1
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
package com.huaweicloud.sdk.test;
import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.smn.v2.region.SmnRegion;
import com.huaweicloud.sdk.smn.v2.*;
import com.huaweicloud.sdk.smn.v2.model.*;
import java.util.List;
import java.util.ArrayList;
public class AddSubscriptionFromSubscriptionUserSolution {
public static void main(String[] args) {
// The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
// In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
String ak = System.getenv("CLOUD_SDK_AK");
String sk = System.getenv("CLOUD_SDK_SK");
String projectId = "{project_id}";
ICredential auth = new BasicCredentials()
.withProjectId(projectId)
.withAk(ak)
.withSk(sk);
SmnClient client = SmnClient.newBuilder()
.withCredential(auth)
.withRegion(SmnRegion.valueOf("<YOUR REGION>"))
.build();
AddSubscriptionFromSubscriptionUserRequest request = new AddSubscriptionFromSubscriptionUserRequest();
request.withTopicUrn("{topic_urn}");
AddSubscriptionFromSubscriptionUserRequestBody body = new AddSubscriptionFromSubscriptionUserRequestBody();
List<String> listbodyIds = new ArrayList<>();
listbodyIds.add("e08d1d82a57a4772b353d85445cefd7b");
body.withIds(listbodyIds);
request.withBody(body);
try {
AddSubscriptionFromSubscriptionUserResponse response = client.addSubscriptionFromSubscriptionUser(request);
System.out.println(response.toString());
} catch (ConnectionException e) {
e.printStackTrace();
} catch (RequestTimeoutException e) {
e.printStackTrace();
} catch (ServiceResponseException e) {
e.printStackTrace();
System.out.println(e.getHttpStatusCode());
System.out.println(e.getRequestId());
System.out.println(e.getErrorCode());
System.out.println(e.getErrorMsg());
}
}
}
|
Importing a subscriber to topic test_topic_v1
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
# coding: utf-8
import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdksmn.v2.region.smn_region import SmnRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksmn.v2 import *
if __name__ == "__main__":
# The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
# In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
ak = os.environ["CLOUD_SDK_AK"]
sk = os.environ["CLOUD_SDK_SK"]
projectId = "{project_id}"
credentials = BasicCredentials(ak, sk, projectId)
client = SmnClient.new_builder() \
.with_credentials(credentials) \
.with_region(SmnRegion.value_of("<YOUR REGION>")) \
.build()
try:
request = AddSubscriptionFromSubscriptionUserRequest()
request.topic_urn = "{topic_urn}"
listIdsbody = [
"e08d1d82a57a4772b353d85445cefd7b"
]
request.body = AddSubscriptionFromSubscriptionUserRequestBody(
ids=listIdsbody
)
response = client.add_subscription_from_subscription_user(request)
print(response)
except exceptions.ClientRequestException as e:
print(e.status_code)
print(e.request_id)
print(e.error_code)
print(e.error_msg)
|
Importing a subscriber to topic test_topic_v1
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 |
package main
import (
"fmt"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
smn "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smn/v2"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smn/v2/model"
region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smn/v2/region"
)
func main() {
// The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
// In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
ak := os.Getenv("CLOUD_SDK_AK")
sk := os.Getenv("CLOUD_SDK_SK")
projectId := "{project_id}"
auth := basic.NewCredentialsBuilder().
WithAk(ak).
WithSk(sk).
WithProjectId(projectId).
Build()
client := smn.NewSmnClient(
smn.SmnClientBuilder().
WithRegion(region.ValueOf("<YOUR REGION>")).
WithCredential(auth).
Build())
request := &model.AddSubscriptionFromSubscriptionUserRequest{}
request.TopicUrn = "{topic_urn}"
var listIdsbody = []string{
"e08d1d82a57a4772b353d85445cefd7b",
}
request.Body = &model.AddSubscriptionFromSubscriptionUserRequestBody{
Ids: listIdsbody,
}
response, err := client.AddSubscriptionFromSubscriptionUser(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
201 |
OK |
400 |
Bad Request |
403 |
Unauthorized |
404 |
Not Found |
500 |
Internal Server Error |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot