使用阿里云CLI管理人工智能平台PAI_人工智能平台 PAI(PAI)-阿里云帮助中心

本文以调用人工智能平台PAI - AI工作空间ListWorkspaces接口，获取工作空间列表为例，为您介绍使用阿里云CLI调用人工智能平台 PAI（Platform for AI） OpenAPI的操作步骤。

前置概念

阿里云CLI（Alibaba Cloud Command Line Interface）是基于OpenAPI构建的通用命令行工具，您可以通过阿里云CLI实现自动化管理和维护人工智能平台 PAI。更多信息，请参见什么是阿里云CLI。

阿里云CLI支持调用以下人工智能平台 PAI OpenAPI：

子产品OpenAPI	子产品Code
PAI-AI WorkSpace	`aiworkspace`
PAI-iTAG API	`openitag`
PAI-FeatureStore API	`paifeaturestore`
PAI-DSW API	`pai-dsw`
PAI-Resource Service API	`paistudio`
PAI-EAS API	`eas`
PAI-Flow API	`paiflow`
PAI-Designer API	`paistudio`
PAI-DatasetAcc API	`paielasticdatasetaccelerator`

步骤一：安装阿里云CLI

使用阿里云CLI前，您需要先安装阿里云CLI。阿里云CLI为用户提供了Windows、Linux和macOS三种操作系统下的安装服务，请根据您使用设备的操作系统选择对应的安装服务。

云命令行（Cloud Shell）中预装了阿里云CLI，且会定期更新软件版本。您可以在云命令行中调试阿里云CLI命令。更多信息，请参见什么是云命令行。

步骤二：配置阿里云CLI

重要

阿里云账号（主账号）拥有所有产品OpenAPI的管理和访问权限，风险很高。强烈建议您创建RAM用户（子账号），并依据最小化权限原则授予权限，使用RAM用户身份访问OpenAPI。人工智能平台 PAI支持的权限策略，请参见管理权限。

使用阿里云CLI之前，您需要在阿里云CLI中配置身份凭证、地域ID等信息。阿里云CLI支持使用RAM用户的AccessKey信息配置AK类型身份凭证，具体操作步骤如下：

创建一个RAM用户，并创建AccessKey，以便后续配置身份凭证使用。具体操作，请参见创建RAM用户及创建AccessKey。
为RAM用户授权。本文示例需授予RAM用户管理人工智能平台 PAI的权限策略AliyunPAIFullAccess。具体操作，请参见为RAM用户授权。
获取可用的地域ID，以便后续配置身份凭证使用。阿里云CLI将使用您指定的地域发起OpenAPI调用，人工智能平台PAI - AI工作空间的可用地域请参见服务接入点。
说明
使用阿里云CLI过程中，您可使用--region选项指定地域发起命令调用，该选项在使用时将忽略默认身份凭证配置及环境变量设置中的地域信息。更多信息，请参见API命令可用选项。
使用RAM用户的AccessKey配置AK类型凭证，配置文件命名为AkProfile。具体操作，请参见配置示例。

步骤三：生成CLI命令示例

在OpenAPI门户中，访问ListWorkspaces调试地址。
在参数配置中输入请求参数，单击CLI示例页签，查看生成的CLI示例。
复制CLI示例或在云命令行中快速执行：
- 单击运行命令按钮，可唤出云命令行并快速完成命令调试。
- 单击复制按钮，将CLI示例复制到剪贴板中，可粘贴至本地Shell工具中运行或用于编写命令行脚本。
说明
- 复制CLI示例到本地Shell工具中进行调试时请注意参数格式。关于阿里云CLI命令参数使用格式的详细信息，请参见参数格式说明。
- OpenAPI门户生成示例中会默认添加--region选项，复制命令到本地调用时阿里云CLI将忽略默认身份凭证配置及环境变量设置中的地域信息，优先使用指定的地域调用命令，您可根据需要对该选项进行删除或保留。

步骤四：调用OpenAPI

示例一：获取支持阿里云CLI调用的OpenAPI列表

以下示例将为您展示如何使用--help选项获取支持阿里云CLI调用的人工智能平台PAI - AI工作空间OpenAPI列表。更多信息，请参见API概览。

执行以下命令。
```
aliyun aiworkspace --help
```
预期输出。

示例二：获取工作空间列表

以下示例将为您展示如何使用阿里云CLI调用人工智能平台PAI - AI工作空间ListWorkspaces接口，获取运行状态正常的工作空间列表，查询结果按创建时间降序排列。

执行以下命令。

aliyun aiworkspace GET /api/v1/workspaces --Status ENABLED --Order DESC --SortBy GmtCreateTime

预期输出。

{
  "RequestId": "8D7B2E70-F770-505B-A672-09F1D8F2EC1E",
  "Workspaces": [
    {
      "WorkspaceId": "123",
      "WorkspaceName": "workspace-example",
      "GmtCreateTime": "2021-01-21T17:12:35.232Z",
      "GmtModifiedTime": "2021-01-21T17:12:35.232Z",
      "Description": "workspace description example",
      "Creator": "122424353535",
      "EnvTypes": [
        "prod"
      ],
      "Status": "ENABLED",
      "AdminNames": [
        "demo_test@***.aliyunid.com"
      ],
      "IsDefault": false,
      "ExtraInfos": {
        "TenantId": "4286******98"
      }
    }
  ],
  "TotalCount": 1,
  "ResourceLimits": {
    "MaxCompute_share": 1,
    "MaxCompute_isolate": 1,
    "DLC_share": 1
  }
}

说明

如果调用人工智能平台PAI - AI工作空间OpenAPI后返回错误，您需要根据返回的错误码提示检查传入的请求参数及其取值是否正确。
您可以记录下调用返回的RequestID或SDK报错信息，通过阿里云OpenAPI诊断平台进行自助诊断。