华为云用户手册

创建 IAM 自定义策略并为用户组IAM项目授权 参考创建自定义策略中的“JSON视图配置自定义策略”，创建IAM自定义策略“ SMS Custom Policy For EPS At IAM”。 JSON视图策略内容如下：（将如下内容复制到策略内容中） { "Version": "1.1", "Statement": [ { "Action": [ "ecs:availabilityZones:list", "ecs:servers:list", "ecs:servers:unlock", "ecs:servers:lock", "ecs:servers:reboot", "ecs:serverPasswords:manage", "ecs:diskConfigs:use", "ecs:servers:setMetadata", "ecs:serverVolumes:use", "ecs:serverKeypairs:create", "ecs:serverKeypairs:get", "ecs:serverKeypairs:delete", "ecs:serverInterfaces:use", "ecs:serverGroups:manage", "ecs:securityGroups:use", "vpc:securityGroupRules:create", "vpc:securityGroupRules:delete", "vpc:securityGroupRules:get", "vpc:securityGroupRules:update", "vpc:networks:get", "vpc:ports:get", "vpc:vpcTags:get", "vpc:subnetTags:get", "vpc:routers:get", "vpc:securityGroups:get", "evs:volumes:list", "evs:types:get" ], "Effect": "Allow" } ] } 在 统一身份认证 服务，左侧导航窗格中，选择“用户组”，进入用户组列表页面。 单击创建的用户组“Test_EPS”名称，进入“授权记录”页签。 单击“授权”，勾选“SMS Custom Policy For EPS At IAM”策略，单击“下一步”。 授权范围选择“所有资源”，单击“确定”。

创建IAM自定义策略并为用户组企业项目授权 参考创建自定义策略中的“JSON视图配置自定义策略”，创建IAM自定义策略“SMS Custom Policy For EPS”。 JSON视图策略内容如下：（将如下内容复制到策略内容中） { "Version": "1.1", "Statement": [ { "Action": [ "vpc:securityGroups:create", "vpc:securityGroups:delete", "vpc:vpcs:create", "vpc:vpcs:delete", "vpc:publicIps:create", "vpc:publicIps:delete", "vpc:subnets:create", "vpc:subnets:delete", "ecs:cloudServers:create", "ecs:cloudServers:attach", "ecs:cloudServers:detachVolume", "ecs:cloudServers:start", "ecs:cloudServers:stop", "ecs:cloudServers:delete", "ecs:cloudServers:reboot", "ecs:cloudServers:updateMetadata", "ecs:cloudServers:vnc", "ecs:serverPasswords:manage", "ecs:serverKeypairs:delete", "ecs:diskConfigs:use", "ecs:CloudServers:create", "ecs:servers:setMetadata", "ecs:serverVolumes:use", "ecs:serverKeypairs:create", "ecs:serverInterfaces:use", "ecs:serverGroups:manage", "ecs:securityGroups:use", "ecs:servers:unlock", "ecs:servers:rebuild", "ecs:servers:lock", "evs:volumes:use", "evs:volumes:create", "evs:volumes:update", "evs:volumes:delete", "evs:snapshots:create", "evs:snapshots:delete", "evs:snapshots:rollback", "ecs:*:get*", "ecs:*:list*", "evs:*:get*", "evs:*:list*", "vpc:*:list*", "vpc:*:get*", "ims:*:get*", "ims:*:list*" ], "Effect": "Allow" } ] } 在统一身份认证服务，左侧导航窗格中，选择“用户组”，进入用户组列表页面。 单击创建的用户组“Test_EPS”名称，进入“授权记录”页签。 单击“授权”，勾选”SMS FullAccess” 和“SMS Custom Policy For EPS”策略，单击“下一步”。 授权范围选择“指定企业项目资源”，在项目资源列表中选择开通并创建企业项目所创建的企业项目，单击“确定”。

创建企业项目 请参考企业管理快速入门，完成创建用户组“Test_EPS”、创建IAM用户“Test_EPS_User”、为用户组“Test_EPS”添加IAM用户“Test_EPS_User”、创建企业项目“Test_EPS_Project”等操作。 本文中出现的“Test_EPS”、“Test_EPS_User”、“Test_EPS_Project”名称均为举例，在实际的创建中，需要您自定义名称。

操作步骤 获取目的端服务器所在账号的AK/SK。 如果您需要直接使用账号来进行 主机迁移 ，具体步骤请参见获取AK/SK（账号）。 如果您在此账号中创建了IAM用户，授予此IAM用户对应的权限后使用此IAM用户创建AK/SK，具体步骤请参见获取AK/SK（IAM用户）。 在源端服务器上安装迁移Agent，具体步骤请参见在源端上安装迁移Agent。 安装完成后，进入Agent安装目录，如C:\SMS-Agent-Py?\config，按如下所示修改配置文件disk.cfg。 [vol_mount_modify] D=2 E=2 D=2，E=2说明是将D盘和E盘都迁移到E CS 的第2块磁盘，即ECS的数据盘。 双击SMS-Agent，打开迁移Agent，在迁移Agent中填写1中获取的AK/SK，并启动迁移Agent。 迁移Agent启动成功后会自动收集源端服务器信息并发送给 主机迁移服务 ，主机迁移服务会自动校验源端服务器信息合法性以及是否可迁移。 迁移Agent启动成功后，使用目的端服务器所在的账号，登录主机迁移管理控制台，在“迁移服务器”页面的服务器列表中，查看源端服务器信息。 创建并启动迁移任务，具体步骤请参见设置迁移目的端，开始服务器复制并启动目的端。 迁移任务完成后，目的端ECS会有一个单独系统盘和数据盘。 迁移完成后目的端服务器的登录方式与源端服务器的登录方式保持一致。 （可选）启动目的端后，如果您的源端服务器有增量数据，您可以使用同步功能，同步源端增量数据。单击操作列的“同步”，单击“是”，开始进行增量数据同步。

操作步骤 获取目的端服务器所在账号的AK/SK。 如果您需要直接使用账号来进行主机迁移，具体步骤请参见获取AK/SK（账号）。 如果您在此账号中创建了IAM用户，授予此IAM用户对应的权限后使用此IAM用户创建AK/SK，具体步骤请参见获取AK/SK（IAM用户）。 在源端服务器上安装迁移Agent，具体步骤请参见在源端上安装迁移Agent。 安装完成后，双击SMS-Agent，打开迁移Agent，在迁移Agent中填写1中获取的AK/SK，并启动迁移Agent。 迁移Agent启动成功后会自动收集源端服务器信息并发送给主机迁移服务，主机迁移服务会自动校验源端服务器信息合法性以及是否可迁移。 迁移Agent启动成功后，使用目的端服务器所在的账号，登录主机迁移管理控制台，在“迁移服务器”页面的服务器列表中，查看源端服务器信息。 创建并启动迁移任务，具体步骤请参见设置迁移目的端，开始服务器复制并启动目的端。 迁移完成后目的端服务器的登录方式与源端服务器的登录方式保持一致。 （可选）启动目的端后，如果您的源端服务器有增量数据，您可以使用同步功能，同步源端增量数据。单击操作列的“同步”，单击“是”，开始进行增量数据同步。

操作步骤 获取目的端服务器所在账号的AK/SK。 如果您需要直接使用账号来进行主机迁移，具体步骤请参见获取AK/SK（账号）。 如果您在此账号中创建了IAM用户，授予此IAM用户对应的权限后使用此IAM用户创建AK/SK，具体步骤请参见获取AK/SK（IAM用户）。 在源端服务器上安装迁移Agent，具体步骤请参见在源端上安装迁移Agent。 安装完成后，双击SMS-Agent，打开迁移Agent，在迁移Agent中填写1中获取的AK/SK，并启动迁移Agent。 迁移Agent启动成功后会自动收集源端服务器信息并发送给主机迁移服务，主机迁移服务会自动校验源端服务器信息合法性以及是否可迁移。 迁移Agent启动成功后，使用目的端服务器所在的账号，登录主机迁移管理控制台，在“迁移服务器”页面的服务器列表中，查看源端服务器信息。 创建并启动迁移任务，具体步骤请参见设置迁移目的端，开始服务器复制并启动目的端。 如果源端和目的端在华为云的同一个VPC里面，“网络类型”可以私网，迁移时会使用目的端的私有IP建立数据连接，目的端不需要配置弹性IP。迁移完成后目的端服务器的登录方式与源端服务器的登录方式保持一致。 源端和目的端处于同一账号、同一region、不同VPC下时，需要创建同一账户下的对等连接，然后“迁移网络类型”可以选择私网 源端和目的端处于不同账号、同一region、不同VPC下时，需要创建不同账户下的对等连接，然后“迁移网络类型”可以选择私网。 （可选）启动目的端后，如果您的源端服务器有增量数据，您可以使用同步功能，同步源端增量数据。单击操作列的“同步”，单击“是”，开始进行增量数据同步。

安全加固（可选） 修改sshd_config文件。 MaxAuthTries 6 LoginGraceTime 60 PasswordAuthentication no 禁用history。 打开终端，输入以下命令 sudo nano ~/.bashrc 在文件末尾添加以下内容 unset HISTFILE 保存并退出后输入以下命令生效 source ~/.bashrc 防止暴力破解。 可以在/etc/pam.d/password-auth中设置，HCE系统中默认设置为 auth sufficient pam_faillock.so authsucc audit deny=3 even_deny_root unlock_time=60 表示使用pam_faillocl模块，如果登录失败3次，即使是root用户，锁定30s。 设置密码复杂度。 在/etc/pam.d/system-auth中找到password requisite pam_pwquality.so try_first_pass~~~~，在后面添加enforce_for_root minlen=8 ucredit=-1 lcredit=-1 dcredit=-1 ocredit=-1，如下： password requisite pam_pwquality.so try_first_pass local_users_only enforce_for_root minlen=8 ucredit=-1 lcredit=-1 dcredit=-1 ocredit=-1 修改umask。umask是一个用于设置文件和目录默认权限的命令，umask中的值需要修改成027。 打开终端并输入以下命令打开.bashrc文件 nano ~/.bashrc 在文件的末尾添加 umask 027 保存并关闭文件，然后输入以下命令使更改生效。 source ~/.bashrc 删除系统残留工具，系统残留工具会增加系统的攻击面，并误导安全软件。 在操作系统中查看是否存在如下应用（包括但不限于）： tcpdump，sniffer，wireshark，Netcat，基于winPcap开发的其他嗅探工具等。 gdb，strace，readelf，cpp，gcc，dexdump，mirror，JDK等开发和调试工具及其他仅在调试阶段使用的自研工具或脚本。

Linux部分： 需要创建~\smsMetadataAgent目录，目录中包含bin，Python，smsAgent 文件夹。 名称 作用 位置 bin 存放开机自启动脚本和peagent目录 ~\smsMetadataAgent\bin smsAgent 利用python获取元数据的目录 ~\smsMetadataAgent\smsAgent 同样需要注入公私钥，可以参考Windows部分从metedata中进行获取。 名称 作用 作用于的文件 sms_rsa_part（待弃用） ssh公钥（主机认证，身份认证) root/.ssh/authorized_keys，/etc/ssh/ssh_host_rsa_key.pub sms_rsa_pri_part（待弃用） ssh私钥（主机认证，身份认证) /etc/ssh/ssh_host_rsa_key sms_rsa_host_old 新ssh公钥（主机认证) /etc/ssh/ssh_host_rsa_key.pub sms_rsa_host_old_pri 新ssh私钥（主机认证) /etc/ssh/ssh_host_rsa_key sms_rsa_identity ssh公钥证书（身份认证） /root/.ssh/authorized_keys cert_part（待弃用） TSL1.2认证公钥 /home/config/cert.pem prikey_part（待弃用） TSL1.2认证私钥 /home/config/prikey.pem Linux开机自动运行脚本，将对应值写入对应文件即可。

Windows部分： 创建C:\smsWindowesAgent文件夹，在该文件夹下创建bin，Python，smsAgent等文件夹。 名称 作用 位置 bin 存放开机自启动脚本和peagent目录 C:\smsWiondowesAgent\bin python 安装python的目录 C:\smsWiondowesAgent\python smsAgent 利用python获取元数据的目录 C:\smsWiondowesAgent\smsAgent peagent 存放源端传输到目的端的迁移组件 C:\smsWiondowesAgent\bin\peagnet smsAgent文件夹中包含所有的获取证书的逻辑。 sms-agent将ssh公钥和私钥，上传到ECS的metedata中，需要编写脚本，从metedata中获取该数据，元数据中主要分为三个部分。 名称 作用 作用于的文件 sms_rsa_part（待弃用） ssh公钥（主机认证，身份认证) C:\Users\Administrator\.ssh\authorized_keys,C:\ProgramData\ssh\ssh_host_rsa_key.pub sms_rsa_pri_part（待弃用） ssh私钥（主机认证，身份认证) C:\ProgramData\ssh\ssh_host_rsa_key sms_rsa_host_old 新ssh公钥（主机认证) C:\ProgramData\ssh\ssh_host_rsa_key.pub sms_rsa_host_old_pri 新ssh私钥（主机认证) C:\ProgramData\ssh\ssh_host_rsa_key sms_rsa_identity ssh公钥证书（身份认证） C:\Users\Administrator.ssh\authorized_keys cert_part（待弃用） TSL1.2认证公钥 C:\smsWindowesAgent\bin\peAgent\config\cert.pem prikey_part（待弃用） TSL1.2认证私钥 C:\smsWindowesAgent\bin\peAgent\config\prikey.pem sms_rsa_part和sms_rsa_pri_part为通信用的ssh公钥和私钥。需要从目的端metedata中获取sms_rsa_part中的公钥和私钥，写入作用的文件。 bin目录下包含开机自启动需要包含的脚本，检测是否有peagent.exe程序在运行。 'tasklist /nh /fi "imagename eq peAgent.exe' 如果没有则持续开始启动peAgent.exe文件 start cmd /k "C:\smsWindowesAgent\bin\peAgent\peAgent.exe" 如果有则结束该脚本 注意该部分需要在smsAgent执行结束后，再执行该部分逻辑。

Windows Py2版本： 登录SMS控制台，在左侧导航树，单击“迁移Agent"，进入"迁移Agent"页面。 下载Windows Py2版本Agent，并上传源端服务器，双击“SMS-Agent-Py2.exe”文件，安装SMS-Agent。安装完成后，进入SMS-Agent命令行页面。 输入AK/SK，sms_domain成功启动SMS-Agent后。 进入SMS-Agent安装目录，如C:\SMS-Agent-Py2\config目录下，修改cloud-region.json文件。 查找cloud-region.json文件中关键字“windows_ssh_image_id"，将图中箭头处的镜像id，替换成用户自制镜像的镜像id。

Linux 版本 登录SMS控制台，在左侧导航树，单击“迁移Agent"，进入"迁移Agent"页面 下载Linux版本Agent，并上传源端服务器。 执行以下命令，解压Agent软件包。 tar -zxvf SMS-Agent.tar.gz 执行以下命令，启动迁移Agent。 ./startup.sh 输入AK/SK，sms_domain成功启动SMS-Agent后。 进入SMS-Agent安装目录，如~\SMS-Agent\agent\config\cloud-region.json目录下，修改cloud-region.json文件。 查找cloud-region.json文件中关键字“linux_image_id"，将图中箭头处的镜像id，替换成用户自制镜像的镜像id。

WindowsPy3版本： 登录SMS控制台，在左侧导航树，单击“迁移Agent"，进入"迁移Agent"页面。 下载Windows Py3版本Agent，并上传源端服务器，双击“SMS-Agent-P3.exe”文件，安装SMS-Agent。安装完成后，进入SMS-Agent图形界面。 输入AK/SK，sms_domain成功启动SMS-Agent后。 进入SMS-Agent安装目录，如C:\SMS-Agent-Py3\config目录下，修改cloud-region.json文件。 查找cloud-region.json文件中关键字“windows_ssh_image_id"，将图中箭头处的镜像id，替换成用户自制镜像的镜像id。

Git客户端推送（以Git Bash为例） 在进行Git Bash客户端推送之前请确保已在 代码托管服务 中配置SSH密钥或HTTPS密码。 进入目标代码托管服务。 将本地仓库初始化为Git仓库，用于与代码托管仓库进行关联。 在您的仓库中打开Git Bash客户端，执行以下命令： git init 初始化成功如下图，此时当前文件夹已经是本地Git仓库了。 将本地仓库与代码托管仓库进行绑定。 进入代码托管仓库，获取仓库地址。 在本地使用remote命令，将本地仓库与代码托管仓库进行绑定。 git remote add 仓库别名 仓库地址 示例为： git remote add origin git@*****/java-remote.git #复制使用时注意换成您自己的仓库地址 一般用origin作为仓库别名，因为当您从远程仓库clone到本地时，默认产生的别名就是origin，您也可以使用任意别名。 如果提示仓库名重复，更换一个即可。 无回显即为绑定成功。 将代码托管仓库master分支拉取到本地仓库。 此步骤主要是避免冲突。 git fetch origin master #复制使用时 注意是否需要将origin替换为您仓库的别名 将本地代码文件提交到master分支。 依次执行： git add . git commit -m "您的提交备注" 下图为成功的执行。 将本地master分支与代码托管master分支进行绑定。 git branch --set-upstream-to=origin/master master #复制使用时 注意是否需要将origin替换为您仓库的别名 成功执行如下图所示，提示您已经将合并后的仓库放在工作区与版本库。 合并代码托管仓库与本地仓库的文件，并存储在本地。 git pull --rebase origin master #复制使用时 注意是否需要将origin替换为您仓库的别名 成功执行如下图所示，提示您已经将合并后的仓库放在工作区与版本库。 将本地仓库推送覆盖代码托管仓库。 因为之前已经进行了绑定，直接push即可。 git push 成功后，再直接拉取pull，验证代码托管仓库与本地仓库版本相同，如下图。

实现原理 代码托管服务（CodeArts Repo）结合仓库的存储方式提供以下迁移方案： HTTP在线导入 通过HTTP协议直接将您的远程仓库导入到代码托管中，全程线上操作，但导入仓库的时长会受到网络条件及仓库容量的影响。 仓库容量相对较大的云端仓库推荐使用Git客户端推送的方式进行迁移。 Git客户端推送 通过使用Git客户端将本地仓库中的代码文件推送至代码托管服务。 将项目文件存放在本地计算机的用户，建议先将本地项目文件初始化成Git仓库，再使用Git客户端进行迁移。 新建仓库对于仓库容量相对较大的云端仓库，建议先将云端仓库克隆或下载到本地，再使用Git客户端进行迁移。

创建IAM用户 IAM用户由账号创建并管理，可以确保账号及资源的安全性，有关IAM的详细介绍请参见IAM用户。此处介绍如何创建一个具有MgC使用权限的IAM用户。若您不需要使用IAM用户，可以略过此部分内容。 访问华为云，单击页面右上角的“控制台”，使用注册账号登录控制台。 在“控制台”页面，将鼠标移动至右上方的用户名，在下拉列表中选择“统一身份认证”。 创建用户组并授权 创建用户组，单击用户组操作列的“授权”。在用户组选择策略页面中，选择“迁移中心（MgC）”，勾选需要授予用户组的权限。MgC权限说明参见权限管理。 最多可以创建20个用户组。 创建用户并加入用户组 创建用户时选择步骤3创建的具有MgC权限的用户组。

修订记录 发布日期 修订记录 2024-08-12 更新迁移其他云平台存储数据至华为云 2024-07-31 新增归档存储（冷存储）数据迁移 2024-07-30 新增通过HTTP迁移Ceph存储数据到华为云OBS 2024-07-29 新增迁移后主机私有IP保持不变 2024-07-26 新增通过HTTP迁移MinIO存储数据到华为云OBS 2024-06-24 新增OBS多前缀批量迁移 2024-06-05 新增采集Azure容器AKS资源 2024-05-14 第三次发布。 新增阿里云主机迁移至华为云 新增SFS1.0迁移至SFS 3.0 新增将主机迁移至Flexus云服务器X实例（原云耀云服务器X实例） 2024-03-14 第二次发布。 新增目的端主机磁盘缩容 新增调整目的端磁盘分区 2023-10-30 第一次发布

资源包抵扣顺序 抵扣顺序原则 当购买了多个相同属性的资源包，会按照资源包过期时间顺序进行抵扣，优先抵扣过期时间近的资源包。 示例 场景 某客户分别购买了两个“华北-北京四”区域的直播CDN流量包。 资源包A：规格500GB，2022年10月1日生效，购买时长1年，即2023年10月1日过期。 资源包B：规格1TB，2022年10月10日生效，购买时长1年，即2023年10月10日过期。 抵扣顺序 2022年10月1日~10月9日 只有资源包A生效。 使用资源包A抵扣，超出500GB部分按需计费。 2022年10月10日~2023年9月30日 资源包A、B同时生效，叠加使用。 优先使用资源包A抵扣，超出500GB部分使用资源包B抵扣，超出1TB部分按需计费。 2023年10月1日~10月9日 资源包A过期，只有资源包B生效。 使用资源包B抵扣，超出1TB部分按需计费。 2023年10月10日及以后 资源包A、B均已过期，此时为按需计费。

资源包说明 视频直播 为按需计费，您也可以通过预付费资源包的方式，提前购买使用额度，获取更多的优惠。套餐包的有效期为1年，超出资源包的部分自动转按需计费。如何购买资源包？ 视频直播服务暂不支持退订资源包，建议您在购买资源包前提前规划资源的使用额度。 资源包仅支持实名认证用户购买，且限本账号使用。 资源包购买后生效时间为北京时间当日零点，有效期为1年。 购买的资源包只能在绑定的区域使用。如果您购买“华北-北京四”区域的转码资源包，那么在“亚太-新加坡”区域使用视频转码功能时，无法通过该资源包抵扣转码费用。 计费时优先使用资源包中的额度，该额度使用完后，自动转为从余额扣费。 资源包超过有效期自动失效，失效后剩余资源将作废，自动转为从余额扣费。 视频直播提供的资源包如表1所示，各资源包在不同规格下的具体价格，请参见产品价格详情。您可以通过视频直播提供的价格计算器，根据您的业务诉求，快速计算出购买视频直播的参考价格。 表1 资源包说明 资源包 作用 使用限制 云直播转码套餐包 H.264标清转码包：用于抵扣直播H.264 SD，未开启高清低码产生的转码时长费用。 H.264高清低码包：用于抵扣直播H.264 SD，且开启了高清低码产生的转码时长费用。 说明： 转码费用由使用的转码模板决定，建议您在购买转码套餐包前，先了解下视频直播的转码功能和配置。 4K/2K/FHD/HD转码暂只支持按需计费。 只适用于直播H.264 SD转码产生的转码计费，且只能用于资源包所属区域。 直播CDN出流包 用于抵扣直播CDN产生的流量费用。 除了在视频直播控制台首页购买套餐包，还可以单击直播CDN活动产品页面，购买如下类型的流量包： 全时流量包：仅适用于流量计费方式。全时流量包可用于所有时间使用的流量计费。 闲时流量包：仅使用于流量计费方式。闲时时间段（北京时间08:00-18:00）产生的费用会从闲时流量包扣除。 闲时时间段，请以活动界面实际公布的为准，这里仅为示例。 如果用户同时购买了全时流量包和闲时流量包，闲时时间段内，费用优先从闲时流量包中扣除。 说明： 不支持抵扣直播源站产生的流量费用。 只适用于直播CDN产生的流量计费，且只能用于资源包所属区域。 如果从流量计费变更为其他计费方式，资源包将无法抵扣，直至切换回流量计费后方可使用。 低时延直播流量包 用于抵扣低时延直播产生的流量费用。 说明： 该流量包适用于中国大陆通用可用区，即低时延直播服务的中国大陆所有区域均可使用此套餐包进行计费。 只适用于低时延直播产生的流量计费，且只能用于中国大陆通用可用区。 如果从流量计费变更为其他计费方式，资源包将无法抵扣，直至切换回流量计费后方可使用。

响应示例 { "count" : 17, "page_data" : [ { "configs" : { "mode": "0", "worksAuthorized": "0", "worksPublic": "1", "onlyAdminCreateDatasource": "0", "isPin": "1", "fieldShowType": "0", "worksView": "0" }, "create_time" : 1676984980510, "create_user" : "xxxxxx", "description" : "Description workspace information", "domain_id" : "xxxxxxx", "eps_id" : "xxxxxxxxxx", "id" : "xxxxxxxxxxxxx", "instance_id" : "xxxx7d17c41c414dabaa08f47c7dxxxx", "is_default" : 1, "name" : "Example workspace name", "owner_name" : "xxxxxx", "project_id" : "xxxxxxxb4dac4055888643b3xxxxxx", "update_time" : 1687167926377, "update_user" : "xxxxxxxx" } ] }

URI GET /v1/{project_id}/instances/{instance_id}/workspaces 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String 实例ID。 project_id 是 String 项目ID。获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 工作空间名称。支持模糊查询。 取值范围：[0,100] offset 否 Integer 返回条目的起始offset。 取值范围：[0,2147483647] 默认值：0 limit 否 Integer 返回条目数。不传该参数时，默认查询前10条信息。 取值范围：[0,2147483647] 默认值：10

API概览 本章节介绍了目前DataArts Insight所提供的API列表。 表1 DataArts Insight API列表 类型 说明 协同授权API 获取指定的数据源、数据集、仪表板、大屏的资源的详细信息。并对资源协同授权。 工作空间API 查询工作空间详情、创建工作空间、修改和删除工作空间的API操作指导。 用户标签API 创建用户标签、编辑用户标签、删除用户标签、保存用户标签内容、获取用户标签值和获取用户标签头的API操作指导。 数据集权限API 获取数据集权限列表、配置数据集权限、打开/关闭数据集权限、删除权限和获取数据集权限配置信息的API操作指导。 数据集API 查询数据集和目录列表、获取数据集详情、删除数据集和保存或修改数据集的API操作指导。 嵌入分析API 获取分享的嵌入分析信息的API操作指导。 导入导出参数API 配置导入导出参数的API操作指导。 产品实例API 查询用户已开通产品实例列表的API操作指导。 资源迁移API API导出资源包、获取导入任务详情和API导入资源包文件的API操作指导。 资源公共查询API 查询仪表板或者大屏列表的API操作指导。 数据源API 数据源更新、获取数据源详情、删除数据源、获取数据源列表和数据源新增的API操作指导。 通行证管理API 获取用户列表、更新用户通行证状态、增加配额关联用户、获取已分配通行证的用户列表和删除用户分配信息的API操作指导。 仪表板API 新建仪表板、更新仪表板、批量发布仪表板、批量下线仪表板和批量删除仪表板的API操作指导。 智能分析助手API 查询智能分析助手列表和自然语言查数的API操作指导。 大屏API 获取大屏组件列表和获取大屏指定组件数据的API操作指导。

支持的授权项 策略包含系统策略和自定义策略，如果系统策略不满足授权要求，管理员可以创建自定义策略，并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应，授权项列表说明如下： 权限：允许或拒绝对指定资源在特定条件下进行某项操作。 对应API接口：自定义策略实际调用的API接口。 授权项：自定义策略中支持的Action，在自定义策略中的Action中写入授权项，可以实现授权项对应的权限功能。 依赖的授权项：部分Action存在对其他Action的依赖，需要将依赖的Action同时写入授权项，才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project)：自定义策略的授权范围，包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目，表示此授权项对应的自定义策略，可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目，不支持企业项目，表示仅能在IAM中给用户组授权并生效，如果在企业管理中授权，则该自定义策略不生效。 关于IAM项目与企业项目的区别，详情请参见：IAM与企业管理的区别。 “√”表示支持，“x”表示暂不支持。 DataArts Insight支持自定义策略授权项如下表所示。 表1 API授权项列表 权限 对应API接口 授权项 依赖的授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 保存或修改资源属性值。 POST /v1/{project_id}/authorization/cooperate-authorization/properties dataartsinsight:resource:auth - √ × 获取资源属性值 GET /v1/{project_id}/authorization/cooperate-authorization/properties dataartsinsight:resource:auth - √ × 获取协同授权规则列表 GET /v1/{project_id}/authorization/cooperate-authorization/rules dataartsinsight:resource:auth - √ × 批量保存、修改、删除指定自研的协同授权规则。 POST /v1/{project_id}/authorization/cooperate-authorization/rules/batch-save dataartsinsight:resource:auth - √ × 创建工作空间 POST /v1/{project_id}/instances/{instance_id}/workspaces dataartsinsight:workspace:create - √ × 删除工作空间 DELETE /v1/{project_id}/instances/{instance_id}/workspaces/{workspace_id} dataartsinsight:workspace:delete - √ × 修改工作空间。 PUT /v1/{project_id}/instances/{instance_id}/workspaces/{workspace_id} dataartsinsight:workspace:update - √ ×

响应示例 状态码： 200 组件返回数据。 { "cell_data" : [ [ { "caption" : "create_time(year)", "data_type" : "DATETIME", "level_type" : "yearLevel", "cell_raw_value" : null, "cell_value" : "create_time(year)", "model_type" : "dimension" } ], [ { "caption" : "create_time(year)", "data_type" : "DATETIME", "level_type" : "yearLevel", "cell_raw_value" : "2020", "cell_value" : "2020", "model_type" : "dimension" } ] ], "record_count" : 1 }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID，即控制台的项目ID。 最小长度：0 最大长度：128 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 最小长度：0 最大长度：8192 表3 请求Body参数 参数 是否必选 参数类型 描述 node_id 是 String 组件ID。 最小长度：0 最大长度：128 selectors 否 Array of selectors objects 筛选器列表。 数组长度：0 - 100 表4 selectors 参数 是否必选 参数类型 描述 selector_node_id 否 String 筛选器组件ID。 最小长度：0 最大长度：128 field_id 否 String 筛选器字段ID。 最小长度：0 最大长度：128 values 否 Array of objects 筛选器值。 数组长度：0 - 100

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 cell_data Array of OpenApiCellInfoList objects 返回数据列表。 cell_data默认第一行为字段名称。 数组长度：0 - 1000 record_count Integer 返回数据条数。 最小值：0 最大值：1000 表6 OpenApiCellInfoList 参数 参数类型 描述 cell_info_list Array of OpenApiCellInfo objects 数据列表。 数组长度：0 - 100 表7 OpenApiCellInfo 参数 参数类型 描述 caption String 字段名称。 最小长度：0 最大长度：128 data_type String 数据类型： DATETIME：时间类型。 STRING：字符类型。 NUMBER：数值类型。 最小长度：0 最大长度：128 level_type String 日期下的子类型，比如年、月、日等。 最小长度：0 最大长度：128 cell_raw_value Object 字段原始值。 cell_value Object 字段格式化后的值。 model_type String 字段类型。 dimension：维度。 measure：度量。 metric：指标。 最小长度：0 最大长度：128

请求示例 获取大屏指定组件数据。 https://{endpoint}/v1/{project_id}/screens/{screen_id}/query-data { "node_id" : "9f7ff361-xxxx-482d-xxxx-57dd19bda14e", "selectors" : [ { "selector_node_id" : "d1e4b677-xxxx-4016-xxxx-dbd9a4bf2f20", "field_id" : "cca5cb5e-xxxx-4614-xxxx-8a4f90447ae0.field", "values" : [ "value1" ] } ] }

请求示例 创建嵌入分析。 POST https://{endpoint}/v1/{project_id}/embeddings { "id" : "6cb08a50xxxxxxxxxxxxxxxxxxxxxx", "name" : "新建嵌入分析", "resource_type" : "dashboard", "resource_id" : "866a519fxxxxxxxxxxxxxxxx", "root_resource_id" : "866a519fxxxxxxxxxxxxxxxx", "config" : "ticket=ec85f874axxxxxxxxxxxxxxxxxxxxxxxxxxxx", "auth_type" : 1 }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 最小长度：0 最大长度：8192 表3 请求Body参数 参数 是否必选 参数类型 描述 id 否 String 嵌入分析id。传入该参数则使用传入的id，否则生成新id。 最小长度：0 最大长度：100 name 是 String 嵌入分析名称。 最小长度：0 最大长度：100 resource_type 是 String 嵌入分析对应的资源类型。可填入dashboard、screen。 最小长度：0 最大长度：100 resource_id 是 String 嵌入分析对应的资源id，如仪表板或者大屏的id。 最小长度：0 最大长度：100 root_resource_id 是 String 嵌入分析对应的根资源id。仪表板或者大屏的根资源id为其本身id。 最小长度：0 最大长度：100 auth_type 否 String 嵌入分析的访问类型。0：登录访问；1：ticket认证。默认取值为0。 config 否 String 嵌入分析配置参数。如'ticket=xxxx'，则指定嵌入分析链接里对应的ticket值。 最小长度：0 最大长度：500

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 数据总条数。 page_data Array of 表7-9 objects 当前页的分页数据。 表5 TicketVo 参数 参数类型 描述 ticket String ticket。 embed_id String ticket绑定的嵌入分析id。 expire_time String ticket过期时间。 left_num String ticket剩余使用次数。 user_id String ticket绑定的用户id。 user_name String ticket绑定的用户的用户名。 user_type String ticket绑定的用户的用户类型。 group_ids Array of strings ticket绑定的用户组id。

URI GET /v1/{project_id}/tickets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参考获取项目ID。 最小长度：0 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 user_id 否 String 用户id。 最小长度：0 最大长度：100 user_name 否 String 用户名。 最小长度：0 最大长度：100 user_type 否 Integer 用户类型。 embed_id 否 String 嵌入分析id。 最小长度：0 最大长度：100 limit 否 Integer 返回条目数。不传该参数时，默认查询前10条信息。取值范围：[0,1000] 默认值：10。 最小值：0 最大值：1000 offset 否 Integer 返回条目的起始offset。取值范围：[0,1000] 默认值：0。 最小值：0 最大值：1000 sort_dir 否 String 是否降序。 最小长度：0 最大长度：128 sort_key 否 String 排序字段。 最小长度：0 最大长度：128