Querying Subscribers
Function
This API is used to query subscribers.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{domain_id}/subscription-users
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Specifies the tenant's account ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
No |
String |
Specifies the subscriber's name. |
protocol |
No |
String |
Specifies the protocol. The value can be one of the following: http https sms |
status |
No |
String |
Specifies the subscriber's status. The value can be one of the following: UNCONFIRMED CONFIRMED CANCELLED |
group |
No |
String |
Specifies the subscriber's group. |
offset |
No |
Integer |
Specifies the offset. 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 |
Integer |
Specifies the maximum number of records in each query, that is, the number of resources returned on each page. The number ranges from 1 to 100 and is generally 10, 20, or 50. The default number is 100. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Specifies the user token. It can be obtained by calling the corresponding IAM API (value of X-Subject-Token in the response header). |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Specifies the unique request ID. |
count |
Integer |
Specifies the number of subscribers. |
subscription_users |
Array of ListSubscriptionUserResponseItemInfo objects |
Specifies the list of subscribers' information. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the subscriber ID. |
domain_id |
String |
Specifies the tenant's account ID. |
name |
String |
Specifies the subscriber's name. |
status |
String |
Specifies the subscriber's status. The value can be one of the following: UNCONFIRMED CONFIRMED CANCELLED |
group |
Array of strings |
Specifies the subscriber's group. |
create_time |
String |
Specifies the creation time. The UTC time is in YYYY-MM-DDTHH:MM:SSZ format. |
update_time |
String |
Specifies the update time. The UTC time is in YYYY-MM-DDTHH:MM:SSZ format. |
http |
Specifies the endpoint address of the user who subscribes over the HTTP protocol. |
|
https |
Specifies the endpoint address of the user who subscribes over the HTTPS protocol. |
|
sms |
Specifies the endpoint address of the user who subscribes over the SMS protocol. |
|
|
Specifies the endpoint address of the user who subscribes over the email protocol. |
Parameter |
Type |
Description |
---|---|---|
endpoint |
String |
Specifies the endpoint address. |
header |
Map<String,String> |
Specifies the user-defined request header of the HTTP subscriber. |
Parameter |
Type |
Description |
---|---|---|
endpoint |
String |
Specifies the endpoint address. |
header |
Map<String,String> |
Specifies the user-defined request header of the HTTPS subscriber. |
Parameter |
Type |
Description |
---|---|---|
endpoint |
String |
Specifies the endpoint address. |
Parameter |
Type |
Description |
---|---|---|
endpoint |
String |
Specifies the endpoint address. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Unique ID of the request. |
error_code |
String |
Specifies the error code. |
error_msg |
String |
Specifies the error message. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Unique ID of the request. |
error_code |
String |
Specifies the error code. |
error_msg |
String |
Specifies the error message. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Unique ID of the request. |
error_code |
String |
Specifies the error code. |
error_msg |
String |
Specifies the error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Unique ID of the request. |
error_code |
String |
Specifies the error code. |
error_msg |
String |
Specifies the error message. |
Example Requests
This API is used to list subscribers.
GET https://{SMNGLOBAL_Endpoint}/v2/{domain_id}/subscription-users?name=test&protocol=email&status=UNCONFIRMED&group=test_group1&offset=0&limit=100
Example Responses
Status code: 200
OK
{ "request_id" : "922a1e7af7ad49e5b3ad455306bbddef", "count" : 1, "subscription_users" : [ { "id" : "e08d1d82a57a4772b353d85445cefd7b", "domain_id" : "f7c690ceb6ef4846b897fde2af08befa", "name" : "test", "status" : "UNCONFIRMED", "group" : [ "test_group1" ], "create_time" : "2025-01-01T00:00:00Z", "update_time" : "2025-01-01T00:00:00Z", "email" : { "endpoint" : "xxx@example.com" } } ] }
SDK Sample Code
The SDK sample code is as follows.
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 |
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 ListSubscriptionUserSolution { 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(); ListSubscriptionUserRequest request = new ListSubscriptionUserRequest(); try { ListSubscriptionUserResponse response = client.listSubscriptionUser(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 |
# 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 = ListSubscriptionUserRequest() response = client.list_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 |
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.ListSubscriptionUserRequest{} response, err := client.ListSubscriptionUser(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 |
---|---|
200 |
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