更新时间:2024-08-14 GMT+08:00

ma-cli configure鉴权命令

鉴权信息说明

  • 在虚拟机及个人PC场景,需要配置鉴权信息,目前支持用户名密码鉴权(默认)和AK/SK鉴权;
  • 在使用账号认证时,需要指定username和password;在使用IAM用户认证时,需要指定account、username和password;
  • 在ModelArts Notebook中可以不用执行鉴权命令,默认使用委托信息,不需要手动进行鉴权操作;
  • 如果用户在ModelArts Notebook中也配置了鉴权信息,那么将会优先使用用户指定的鉴权信息。

    在鉴权时,注意您的敏感信息数据保护,避免敏感信息泄露。

命令参数总览

$ ma-cli configure -h
Usage: ma-cli configure [OPTIONS]

Options:
  -auth, --auth [PWD|AKSK|ROMA]  Authentication type.
  -rp, --region-profile PATH     ModelArts region file path.
  -a, --account TEXT             Account of an IAM user.
  -u, --username TEXT            Username of an IAM user.
  -p, --password TEXT            Password of an IAM user
  -ak, --access-key TEXT         User access key.
  -sk, --secret-key TEXT         User secret key.
  -r, --region TEXT              The region you want to visit.
  -pi, --project-id TEXT         User project id.
  -C, --config-file TEXT         Configure file path for authorization.
  -D, --debug                    Debug Mode. Shows full stack trace when error occurs.
  -P, --profile TEXT             CLI connection profile to use. The default profile is "DEFAULT".
  -h, -H, --help                 Show this message and exit.
表1 鉴权命令参数说明

参数名

参数类型

是否必选

参数说明

-auth / --auth

String

鉴权方式,支持PWD(用户名密码)、AKSK(access key和secret key),默认是PWD。

-rp / --region-profile

String

指定ModelArts region配置文件信息。

-a / --account

String

IAM租户账号,在使用IAM用户认证场景时需要指定,属于PWD鉴权的一部分。

-u / --username

String

用户名,在使用账号认证时表示账号名,IAM认证时表示IAM用户名,在云星账号场景不需要指定,属于PWD鉴权的一部分。

-p / --password

String

密码,属于PWD鉴权的一部分。

-ak / --access-key

String

access key,属于AKSK鉴权的一部分。

-sk / --secret-key

String

secret key,属于AKSK鉴权的一部分。

-r / --region

String

region名称,如果不填会默认使用REGION_NAME环境变量的值。

-pi / --project-id

String

项目ID,如果不填会默认使用对应region的值,或者使用PROJECT_ID环境变量。

-P / --profile

String

鉴权配置项,默认是DEFAULT。

-C / --config-file

String

配置文件本地路径,默认路径为~/.modelarts/ma-cli-profile.yaml。

配置用户名密码鉴权

以在虚拟机上使用ma-cli configure为例,介绍如何配置用户名密码进行鉴权。

以下样例中所有以${}装饰的字符串都代表一个变量,用户可以根据实际情况指定对应的值。

比如${your_password}表示输入用户自己的密码信息。

# 默认使用DEFAULT鉴权配置项,默认提示账号、用户名及密码(其中账号和用户名如果不需要填写可以使用Enter跳过)
$ ma-cli configure --auth PWD --region ${your_region}
account: ${your_account}
username: ${your_username}
password: ${your_password}  # 输入在控制台不会回显

AKSK鉴权

如下命令表示使用AKSK进行鉴权,需要交互式输入AK及SK信息。默认提示AK和SK,且输入在控制台不会回显。

以下样例中所有以${}装饰的字符串都代表一个变量,用户可以根据实际情况指定对应的值。

比如${access key}表示输入用户自己的access key。

ma-cli configure --auth AKSK
access key [***]: ${access key}
secret key [***]: ${secret key}

执行完鉴权命令后,将会在~/.modelarts/ma-cli-profile.yaml配置文件中保存相应的鉴权信息。