Updated on 2025-09-08 GMT+08:00

Adding Accounts in Batches

Function

This API is used to add accounts in batches.

Calling Method

For details, see Calling APIs.

URI

POST /v5/setting/account/accounts

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

ID of the enterprise project that a server belongs.

An enterprise project can be configured only after the enterprise project function is enabled.

Enterprise project ID. The value 0 indicates the default enterprise project. To query servers in all enterprise projects, set this parameter to all_granted_eps. If you have only the permission on an enterprise project, you need to transfer the enterprise project ID to query the server in the enterprise project. Otherwise, an error is reported due to insufficient permission.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Security-Token

No

String

Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

region

No

String

Region ID

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

data_list

No

Array of AddAccountsRequestInfo objects

Account list details.

Table 4 AddAccountsRequestInfo

Parameter

Mandatory

Type

Description

organization_id

Yes

String

Organization ID.

account_id

Yes

String

Account ID.

account_name

Yes

String

Account name.

Response Parameters

Status code: 200

Table 5 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID used for task tracing. The value format is request_uuid-timestamp-hostname.

Table 6 Response body parameters

Parameter

Type

Description

is_all_legal_count

Boolean

Result of adding accounts in batches. Its value can be:

  • true: success

  • false: failure

Example Requests

Set an account whose account_name is test_name, organization_id is o-jbg8sokerqszi0zdo6vvaulwdsenonxz, and account_id is 6a321faa6e6c4a18b5bf19dd954377b5.

POST https://{endpoint}/v5/setting/account/accounts?enterprise_project_id=all_granted_eps

{
  "account_id" : "6a321faa6e6c4a18b5bf19dd954377b5",
  "organization_id" : "o-jbg8sokerqszi0zdo6vvaulwdsenonxz",
  "account_name" : "test_name"
}

Example Responses

Status code: 200

Request succeeded.

{
  "is_all_legal_count" : true
}

SDK Sample Code

The SDK sample code is as follows.

Set an account whose account_name is test_name, organization_id is o-jbg8sokerqszi0zdo6vvaulwdsenonxz, and account_id is 6a321faa6e6c4a18b5bf19dd954377b5.

 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.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.hss.v5.region.HssRegion;
import com.huaweicloud.sdk.hss.v5.*;
import com.huaweicloud.sdk.hss.v5.model.*;


public class BatchAddAccountsSolution {

    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 BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        HssClient client = HssClient.newBuilder()
                .withCredential(auth)
                .withRegion(HssRegion.valueOf("<YOUR REGION>"))
                .build();
        BatchAddAccountsRequest request = new BatchAddAccountsRequest();
        body.withBatchAddAccountsRequestInfo("{\"account_id\":\"6a321faa6e6c4a18b5bf19dd954377b5\",\"organization_id\":\"o-jbg8sokerqszi0zdo6vvaulwdsenonxz\",\"account_name\":\"test_name\"}");
        request.withBody(listBatchAddAccountsRequestInfoBatchAddAccountsRequestInfo);
        try {
            BatchAddAccountsResponse response = client.batchAddAccounts(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());
        }
    }
}

Set an account whose account_name is test_name, organization_id is o-jbg8sokerqszi0zdo6vvaulwdsenonxz, and account_id is 6a321faa6e6c4a18b5bf19dd954377b5.

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkhss.v5.region.hss_region import HssRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkhss.v5 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 = BasicCredentials(ak, sk)

    client = HssClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(HssRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = BatchAddAccountsRequest()
        request.body = listBatchAddAccountsRequestInfoBatchAddAccountsRequestInfo
        response = client.batch_add_accounts(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Set an account whose account_name is test_name, organization_id is o-jbg8sokerqszi0zdo6vvaulwdsenonxz, and account_id is 6a321faa6e6c4a18b5bf19dd954377b5.

 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/basic"
    hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := hss.NewHssClient(
        hss.HssClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.BatchAddAccountsRequest{}
	var batchAddAccountsRequestInfoBatchAddAccountsRequestInfo interface{} = "{\"account_id\":\"6a321faa6e6c4a18b5bf19dd954377b5\",\"organization_id\":\"o-jbg8sokerqszi0zdo6vvaulwdsenonxz\",\"account_name\":\"test_name\"}"
	request.Body = listBatchAddAccountsRequestInfoBatchAddAccountsRequestInfo
	response, err := client.BatchAddAccounts(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

Request succeeded.

Error Codes

See Error Codes.