文档

CLI集成示例

更新时间:

阿里云CLI(Alibaba Cloud Command Line Interface)是基于OpenAPI构建的通用命令行工具。您可以通过阿里云CLI实现自动化管理托管在数据管理DMS的数据。本文将为您介绍使用阿里云CLI调用DMS的操作步骤和示例。

前置概念

阅读本文前,若您还不了解阿里云CLI,请参见什么是阿里云CLI

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

安装阿里云CLI

您也可使用阿里云提供的云命令行Cloud Shell调试阿里云CLI命令。关于云命令行的更多信息,请参见什么是云命令行?

配置阿里云CLI

重要

阿里云主账号拥有所有产品API的管理和访问权限,风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。

使用阿里云CLI之前,您需要在阿里云CLI中配置身份凭证、地域ID等信息。阿里云CLI支持多种身份凭证,详情请参见身份凭证类型。本文操作以AK类型凭证为例,具体操作步骤如下:

  1. 创建一个RAM用户并授予管理对应产品的权限。具体操作,请参见创建RAM用户为RAM用户授权。需要授予的权限:

    • AliyunDMSFullAccess:管理DMS资源的权限。

    • (可选)AliyunCloudShellFullAccess:管理云命令行(cloudshell)的权限。

      说明

      如果您需要使用阿里云提供的在线服务Cloud Shell,还需要添加AliyunCloudShellFullAccess权限

  2. 创建RAM用户并授权后,您需要创建RAM用户对应的AccessKey,并记录AccessKey IDAccessKey Secret,以便后续配置身份凭证使用。具体操作,请参见创建AccessKey

  3. 配置凭证需要设置地域ID,阿里云CLI将使用您指定的地域发起API调用。可用地域请参见服务接入点

  4. 使用RAM用户的AccessKey配置AK类型凭证,配置文件命名为AkProfile。具体操作,请参见配置示例

生成CLI命令

  1. 登录OpenAPI门户

  2. 在API调试界面左侧搜索框中可搜索您需要使用的API。

  3. 参数配置中根据API文档信息填写参数,单击参数配置右侧的CLI示例页签即可生成携带参数的命令示例。

    image

    • 单击运行命令按钮,快速完成命令调试。

    • 单击复制按钮,将CLI示例复制到剪贴板中,可粘贴至本地Shell工具中运行。

      说明
      • 将CLI示例复制到本地Shell工具中进行调试时,请注意参数格式。关于阿里云CLI命令参数使用格式的详细信息,请参见参数格式说明

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

调用示例

以下代码示例将为您展示如何使用阿里云CLI调用数据管理DMS中的UpdateUser命令,更新指定用户拥有的系统角色。获取更多阿里云CLI命令,请参见生成命令

  1. 执行命令。

    aliyun dms-enterprise UpdateUser --region cn-hangzhou --Uid 21400447956867**** --RoleNames 'ADMIN,DBA'
  2. 输出结果。

    {
            "RequestId": "B94173EF-0AEE-5B38-84A9-E6BDEF2B84F3",
            "Success": true
    }