CLI调用DMS API-数据管理 DMS-阿里云帮助中心

前置概念

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

当您需要使用CLI调用API完成相对复杂的任务时，建议将CLI整理成Shell脚本后再执行，以提高效率。

步骤一：安装阿里云CLI

云命令行（Cloud Shell）中预装了阿里云CLI，且自动为您配置身份凭证，无需手动操作。您可在云命令行中调试阿里云CLI命令。更多信息，请参见什么是云命令行。

步骤二：配置阿里云CLI

重要

阿里云账号（主账号）拥有所有产品OpenAPI的管理和访问权限，风险很高。强烈建议您创建RAM用户（子账号），并依据最小化权限原则授予权限，使用RAM用户身份访问OpenAPI。数据管理支持的权限策略，请参见数据管理系统权限策略参考及DMS自定义权限策略参考。

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

创建一个RAM用户，并创建AccessKey，以便后续配置身份凭证使用。具体操作，请参见创建RAM用户及创建AccessKey。
为RAM用户授权。本文示例需授予RAM用户管理数据管理资源的权限AliyunDMSFullAccess。具体操作，请参见管理RAM用户的权限。
获取可用的地域ID，以便后续配置身份凭证使用。阿里云CLI将使用您指定的地域发起OpenAPI调用。数据管理的可用地域请参见服务接入点。

说明
使用阿里云CLI过程中您可使用--region选项指定地域发起命令调用，该选项在使用时将忽略默认身份凭证配置及环境变量设置中的地域信息。详情请参见命令行选项。
使用RAM用户的AccessKey配置AK类型凭证，配置文件命名为AkProfile。具体操作，请参见配置与管理身份凭证。

步骤三：生成CLI命令示例

在OpenAPI门户中，访问UpdateUser调试地址。

单击 CLI示例 页签，在左侧参数配置区域填写 Tid（租户ID）和 Uid（待更新的用户Uid），右侧自动生成 CLI 命令 aliyun dms-enterprise UpdateUser --region cn-hangzhou，单击运行按钮执行或单击复制按钮复制该命令。
在参数配置中输入请求参数，单击CLI示例页签，查看生成的CLI示例。
复制CLI示例或在云命令行中快速执行：
- 单击运行命令按钮，可唤出云命令行并快速完成命令调试。
- 单击复制按钮，将CLI示例复制到剪贴板中，可粘贴至本地Shell工具中运行或用于编辑自动化命令行脚本。
说明
复制CLI示例到本地Shell工具中进行调试时请注意参数格式。关于阿里云CLI命令参数使用格式的详细信息，请参见理解命令行参数。

OpenAPI门户生成示例中会默认添加--region选项，复制命令到本地调用时阿里云CLI将忽略默认身份凭证配置及环境变量设置中的地域信息，优先使用指定的地域调用命令，您可根据需要对该选项进行删除或保留。

步骤四：调用数据管理OpenAPI

示例一：获取OpenAPI列表

以下示例将为您展示如何使用--help选项获取支持阿里云CLI调用的数据管理OpenAPI列表。更多信息，请参见API概览。

执行以下命令。
```
aliyun dms-enterprise --help
```

预期输出。

Product: dms-enterprise (数据管理)
Version: 2018-11-01
Available Api List:
    AddDesensitizationRule          添加脱敏规则。
    AddInstance
    AddLhMembers                   调用AddLhMembers接口，添加DMS数仓开发项目空间管理员、空间成员或任务流开发者。
    AddLogicTableRouteConfig       为逻辑表添加路由算法配置。
    AddTaskFlowEdges               为已存在的任务流节点建立有向边。
    AnalyzeSQLLineage              分析SQL语句中的表、字段之间的血缘关系（依赖和影响关系）。
    ApproveOrder                   调用ApproveOrder接口审批工单。
    BackFill                       调用BackFill接口，给任务编排补数据。
    BuyPayAsYouGoOrder             调用BuyPayAsYouGoOrder接口，购买DMS按量付费的商品。
    ChangeColumnSecLevel           调整字段敏感等级。
    ChangeColumnSecurityLevel      调整字段的安全级别。
    ChangeLhDagOwner               转交DMS数仓开发项目空间中的任务流责任人。

示例二：更新系统角色

以下代码示例将为您展示如何使用阿里云CLI调用数据管理的UpdateUser接口，更新指定用户拥有的系统角色。更多接口信息，请参见更新用户信息。

执行命令。

aliyun dms-enterprise UpdateUser --Uid 21400447956867**** --RoleNames 'ADMIN,DBA'

输出结果。
```
{
    "RequestId": "B94173EF-0AEE-5B38-84A9-E6BDEF2B84F3",
    "Success": true
}
```
说明
如果调用数据管理OpenAPI后返回错误，您需要根据返回的错误码提示检查传入的请求参数及其取值是否正确。

您可以记录下调用返回的RequestID或SDK报错信息，通过阿里云OpenAPI诊断平台进行自助诊断。