添加订阅用户
功能介绍
添加订阅用户。如果订阅用户的状态为未确认,则会向订阅用户发送一条确认订阅消息。订阅用户点击订阅链接确认订阅后,则订阅用户的状态变更为已确认,同时会向订阅用户发送一条取消订阅消息,便于订阅用户随时可以取消订阅。订阅用户点击取消订阅链接后,则订阅用户的状态变更为已取消,同时会向订阅用户发送一条重新订阅消息,便于订阅用户可以重新订阅。
调用方法
请参见如何调用API。
URI
POST /v2/{domain_id}/subscription-users
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
domain_id |
是 |
String |
租户账号ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
订阅用户名称。 |
group |
否 |
Array of strings |
订阅用户分组。每个订阅分组只能包含中英文、数字([0-9])、下划线(_),下划线不能出现在开始或结尾,下划线不能连续出现,长度为1到32个字符。 |
http |
否 |
http协议订阅用户终端地址。 |
|
https |
否 |
https协议订阅用户终端地址。 |
|
sms |
否 |
sms协议订阅用户终端地址。 |
|
|
否 |
email协议订阅用户终端地址。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
endpoint |
是 |
String |
终端地址。必须以“http://”开头。 |
header |
否 |
Map<String,String> |
http协议订阅用户的自定义请求头。http协议订阅用户可以自定义请求头。 |
响应参数
状态码:201
参数 |
参数类型 |
描述 |
---|---|---|
request_id |
String |
请求的唯一标识ID。 |
id |
String |
订阅用户ID。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
request_id |
String |
请求的唯一标识ID。 |
error_code |
String |
返回信息对应的代码。 |
error_msg |
String |
服务异常错误信息描述。 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
request_id |
String |
请求的唯一标识ID。 |
error_code |
String |
返回信息对应的代码。 |
error_msg |
String |
服务异常错误信息描述。 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
request_id |
String |
请求的唯一标识ID。 |
error_code |
String |
返回信息对应的代码。 |
error_msg |
String |
服务异常错误信息描述。 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
request_id |
String |
请求的唯一标识ID。 |
error_code |
String |
返回信息对应的代码。 |
error_msg |
String |
服务异常错误信息描述。 |
请求示例
无
响应示例
无
SDK代码示例
SDK代码示例如下。
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 |
package com.huaweicloud.sdk.test;
import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
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.smnglobal.v2.region.SmnglobalRegion;
import com.huaweicloud.sdk.smnglobal.v2.*;
import com.huaweicloud.sdk.smnglobal.v2.model.*;
public class CreateSubscriptionUserSolution {
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");
ICredential auth = new GlobalCredentials()
.withAk(ak)
.withSk(sk);
SmnglobalClient client = SmnglobalClient.newBuilder()
.withCredential(auth)
.withRegion(SmnglobalRegion.valueOf("<YOUR REGION>"))
.build();
CreateSubscriptionUserRequest request = new CreateSubscriptionUserRequest();
CreateSubscriptionUserRequestBody body = new CreateSubscriptionUserRequestBody();
request.withBody(body);
try {
CreateSubscriptionUserResponse response = client.createSubscriptionUser(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());
}
}
}
|
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 |
# coding: utf-8
import os
from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdksmnglobal.v2.region.smnglobal_region import SmnglobalRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksmnglobal.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"]
credentials = GlobalCredentials(ak, sk)
client = SmnglobalClient.new_builder() \
.with_credentials(credentials) \
.with_region(SmnglobalRegion.value_of("<YOUR REGION>")) \
.build()
try:
request = CreateSubscriptionUserRequest()
request.body = CreateSubscriptionUserRequestBody(
)
response = client.create_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)
|
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 |
package main
import (
"fmt"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
smnglobal "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smnglobal/v2"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smnglobal/v2/model"
region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smnglobal/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")
auth := global.NewCredentialsBuilder().
WithAk(ak).
WithSk(sk).
Build()
client := smnglobal.NewSmnglobalClient(
smnglobal.SmnglobalClientBuilder().
WithRegion(region.ValueOf("<YOUR REGION>")).
WithCredential(auth).
Build())
request := &model.CreateSubscriptionUserRequest{}
request.Body = &model.CreateSubscriptionUserRequestBody{
}
response, err := client.CreateSubscriptionUser(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
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 |
package com.huaweicloud.sdk.test;
import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
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.smnglobal.v2.region.SmnglobalRegion;
import com.huaweicloud.sdk.smnglobal.v2.*;
import com.huaweicloud.sdk.smnglobal.v2.model.*;
public class CreateSubscriptionUserSolution {
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");
ICredential auth = new GlobalCredentials()
.withAk(ak)
.withSk(sk);
SmnglobalClient client = SmnglobalClient.newBuilder()
.withCredential(auth)
.withRegion(SmnglobalRegion.valueOf("<YOUR REGION>"))
.build();
CreateSubscriptionUserRequest request = new CreateSubscriptionUserRequest();
CreateSubscriptionUserRequestBody body = new CreateSubscriptionUserRequestBody();
request.withBody(body);
try {
CreateSubscriptionUserResponse response = client.createSubscriptionUser(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());
}
}
}
|
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 |
# coding: utf-8
import os
from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdksmnglobal.v2.region.smnglobal_region import SmnglobalRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksmnglobal.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"]
credentials = GlobalCredentials(ak, sk)
client = SmnglobalClient.new_builder() \
.with_credentials(credentials) \
.with_region(SmnglobalRegion.value_of("<YOUR REGION>")) \
.build()
try:
request = CreateSubscriptionUserRequest()
request.body = CreateSubscriptionUserRequestBody(
)
response = client.create_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)
|
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 |
package main
import (
"fmt"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
smnglobal "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smnglobal/v2"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smnglobal/v2/model"
region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smnglobal/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")
auth := global.NewCredentialsBuilder().
WithAk(ak).
WithSk(sk).
Build()
client := smnglobal.NewSmnglobalClient(
smnglobal.SmnglobalClientBuilder().
WithRegion(region.ValueOf("<YOUR REGION>")).
WithCredential(auth).
Build())
request := &model.CreateSubscriptionUserRequest{}
request.Body = &model.CreateSubscriptionUserRequestBody{
}
response, err := client.CreateSubscriptionUser(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
201 |
OK |
400 |
Bad Request |
403 |
Unauthorized |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。