Updated on 2025-06-20 GMT+08:00

Updating a Subscriber

Function

This API is used to update a subscriber.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/{domain_id}/subscription-users/{id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Specifies the tenant's account ID.

id

Yes

String

Specifies the subscriber ID.

Request Parameters

Table 2 Request header 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).

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

No

String

Specifies the subscriber's name.

group

No

Array of strings

Specifies the subscriber's group. group can contain 1 to 32 characters, including only lowercase letters, digits, and underscores (_). group cannot start or end with an underscore, nor contain consecutive underscores.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the unique request ID.

Status code: 400

Table 5 Response body parameters

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

Table 6 Response body parameters

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

Table 7 Response body parameters

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

Table 8 Response body parameters

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 update the subscriber name and group.

PUT https://{SMNGLOBAL_Endpoint}/v2/{domain_id}/subscription-users/e08d1d82a57a4772b353d85445cefd7b

{
  "name" : "test_update",
  "group" : [ "test_group_update1" ]
}

Example Responses

Status code: 200

OK

{
  "request_id" : "d143bb992f4e489ca847db86a6bc02f9"
}

SDK Sample Code

The SDK sample code is as follows.

This API is used to update the subscriber name and group.

 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
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.*;

import java.util.List;
import java.util.ArrayList;

public class UpdateSubscriptionUserSolution {

    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();
        UpdateSubscriptionUserRequest request = new UpdateSubscriptionUserRequest();
        request.withId("{id}");
        UpdateSubscriptionUserRequestBody body = new UpdateSubscriptionUserRequestBody();
        List<String> listbodyGroup = new ArrayList<>();
        listbodyGroup.add("test_group_update1");
        body.withGroup(listbodyGroup);
        body.withName("test_update");
        request.withBody(body);
        try {
            UpdateSubscriptionUserResponse response = client.updateSubscriptionUser(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());
        }
    }
}

This API is used to update the subscriber name and group.

 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 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 = UpdateSubscriptionUserRequest()
        request.id = "{id}"
        listGroupbody = [
            "test_group_update1"
        ]
        request.body = UpdateSubscriptionUserRequestBody(
            group=listGroupbody,
            name="test_update"
        )
        response = client.update_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)

This API is used to update the subscriber name and group.

 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/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.UpdateSubscriptionUserRequest{}
	request.Id = "{id}"
	var listGroupbody = []string{
        "test_group_update1",
    }
	nameUpdateSubscriptionUserRequestBody:= "test_update"
	request.Body = &model.UpdateSubscriptionUserRequestBody{
		Group: &listGroupbody,
		Name: &nameUpdateSubscriptionUserRequestBody,
	}
	response, err := client.UpdateSubscriptionUser(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.