更新时间:2025-08-05 GMT+08:00

创建ACL账号

功能介绍

为redis4.0/5.0实例创建权限访问账号,包含读写和只读权限。

如果实例默认账号已开启免密访问,您创建的普通账号不能使用,如需使用普通账号请先关闭默认账号的免密访问。

单机、主备实例默认账号的密码不能带有冒号(:),否则无法创建普通账号。

调用方法

请参见如何调用API

URI

POST /v2/{project_id}/instances/{instance_id}/accounts

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID。获取方法请参见获取项目ID

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

instance_id

String

参数解释

实例ID。可通过DCS控制台进入实例详情界面查看。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

account_name

String

参数解释

ACL账号名称。

约束限制

  • 以字母开头。

  • 内容由字母、数字、中划线、下划线组成。

  • 长度范围[1~64]个字符。

取值范围

不涉及。

默认取值

不涉及。

account_role

String

参数解释

ACL账号权限。

约束限制

不涉及。

取值范围

  • read:只读账号

  • write:读写账号

默认取值

不涉及。

account_password

String

参数解释

ACL账号密码。

约束限制

  • 输入长度为8到64位的字符串。

  • 不能使用正序或逆序用户名作为密码。

  • 必须包含如下四种字符中的三种组合(不允许包含冒号):

    • 小写字母

    • 大写字母

    • 数字

    • 特殊字符包括(`~!@#$%^&*()-_=+\|{}'",<.>/?)

取值范围

不涉及。

默认取值

不涉及。

description

String

参数解释

ACL账号描述。

约束限制

长度不超过1024的字符串。

取值范围

不涉及。

默认取值

不涉及。

account_read_policy

String

参数解释

指定账号的读请求转发到主节点或备节点。

约束限制

  • 仅proxy集群和读写分离实例支持,proxy集群未开启读写分离不支持设置。

  • 读写分离配置参考“用户指南>管理实例>修改DCS实例配置参数”中backend-master-only参数说明。

取值范围

  • master:读请求转发到主节点。

  • replica:读请求转发到备节点。

  • master-replica:读请求转发到主备节点。

默认取值

默认不设置。不设置时,读请求按照实例读写分离配置进行转发。

  • 完全读写分离配置参考 “用户指南>管理实例>修改DCS实例配置参数”中read-only-slave-when-wr-split参数说明。

  • proxy集群实例

    • 默认未开启读写分离,读请求转发到主节点。

    • 开启读写分离

      • 默认开启完全读写分离,读请求转发到备节点。

      • 未开启完全读写分离,读请求随机转发到主备节点。

  • 读写分离实例

    • 默认支持读写分离

      • 默认开启完全读写分离,读请求转发到备节点。

      • 未开启完全读写分离,读请求随机转发到主备节点。

响应参数

状态码:200

参数解释

ACL账号创建任务下发成功。

状态码:400

表3 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

扩展错误信息(暂未使用,赋值为null)。

取值范围

不涉及。

状态码:401

表4 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

扩展错误信息(暂未使用,赋值为null)。

取值范围

不涉及。

状态码:403

表5 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

扩展错误信息(暂未使用,赋值为null)。

取值范围

不涉及。

状态码:404

表6 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

扩展错误信息(暂未使用,赋值为null)。

取值范围

不涉及。

状态码:500

表7 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

扩展错误信息(暂未使用,赋值为null)。

取值范围

不涉及。

请求示例

创建ACL只读权限账号,账号名为user。

POST https:///{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/accounts

{
  "account_name" : "user",
  "account_role" : "read",
  "account_password" : "xxxxx"
}

响应示例

状态码:400

参数解释

非法请求。

{
  "error_code" : "DCS.4961",
  "error_msg" : "Acl account request param invalid."
}

SDK代码示例

SDK代码示例如下。

创建ACL只读权限账号,账号名为user。

 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
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.dcs.v2.region.DcsRegion;
import com.huaweicloud.sdk.dcs.v2.*;
import com.huaweicloud.sdk.dcs.v2.model.*;


public class CreateAclAccountSolution {

    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);

        DcsClient client = DcsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DcsRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateAclAccountRequest request = new CreateAclAccountRequest();
        request.withInstanceId("{instance_id}");
        CreateAclAccountRequestBody body = new CreateAclAccountRequestBody();
        body.withAccountPassword("xxxxx");
        body.withAccountRole(CreateAclAccountRequestBody.AccountRoleEnum.fromValue("read"));
        body.withAccountName("user");
        request.withBody(body);
        try {
            CreateAclAccountResponse response = client.createAclAccount(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());
        }
    }
}

创建ACL只读权限账号,账号名为user。

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

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdcs.v2.region.dcs_region import DcsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdcs.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 = DcsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DcsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateAclAccountRequest()
        request.instance_id = "{instance_id}"
        request.body = CreateAclAccountRequestBody(
            account_password="xxxxx",
            account_role="read",
            account_name="user"
        )
        response = client.create_acl_account(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

创建ACL只读权限账号,账号名为user。

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dcs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/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 := dcs.NewDcsClient(
        dcs.DcsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateAclAccountRequest{}
	request.InstanceId = "{instance_id}"
	request.Body = &model.CreateAclAccountRequestBody{
		AccountPassword: "xxxxx",
		AccountRole: model.GetCreateAclAccountRequestBodyAccountRoleEnum().READ,
		AccountName: "user",
	}
	response, err := client.CreateAclAccount(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

参数解释

ACL账号创建任务下发成功。

400

参数解释

非法请求。

401

参数解释

认证失败。

403

参数解释

请求被拒绝。

404

参数解释

路径错误。

500

参数解释

内部错误。

错误码

请参见错误码