华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM TOKEN 最小长度：1 最大长度：1024 表3 请求Body参数 参数 是否必选 参数类型 描述 change_mode 是 Integer 规格变更类型：10：升配；30：降配；40：续费；60：扩容；70：切换操作系统 最小值：10 最大值：70 resource_id 是 String 资源id(即实例id) resource_spec_code 是 String 产品规格编码(即实例类型编码)，例如dayu.starter，dayu.basic，dayu.advanced等。可通过查询其他实例信息进行获取。 product_id 否 String 产品id promotion_info 否 String 促销信息 最小长度：1 最大长度：1024

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最小长度：1 最大长度：1024 error_code String dayu异常码 最小长度：1 最大长度：1024 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最小长度：1 最大长度：1024 error_code String dayu异常码 最小长度：1 最大长度：1024

概述 欢迎使用数据治理中心DataArts Studio服务。DataArts Studio是针对企业数字化运营诉求提供的数据全生命周期管理、具有智能数据管理能力的一站式治理运营平台，包含数据集成、数据架构、数据开发、数据质量、数据目录、数据服务等功能，支持行业知识库智能化建设，支持大数据存储、大数据计算分析引擎等数据底座，帮助企业快速构建从数据接入到数据分析的端到端智能数据系统，消除数据孤岛，统一数据标准，加快数据变现，实现数字化转型。 您可以使用本文档提供的API对数据治理中心的各组件进行相关操作，如创建集群、创建连接等。支持的全部操作请参见API概览。 在调用数据治理中心API之前，请确保已经充分了解数据治理中心相关概念，详细信息请参见产品介绍。 父主题： 使用前必读

基本概念 帐号 用户的帐号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。为了确保帐号安全，建议您不要直接使用帐号进行日常管理工作，而是创建用户并使用用户进行日常管理工作。 用户 由帐号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在项目ID和帐号ID下，您可以查看帐号ID和用户ID。通常在调用API的鉴权过程中，您需要用到帐号、用户和密码等信息。 项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您帐号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中创建资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 图1 项目隔离模型 父主题： 使用前必读

获取终端节点 终端节点（Endpoint）即调用API的请求地址，不同服务不同区域的终端节点不同。 数据治理中心的终端节点Endpoint构造规则如下，请您根据业务需要选择对应区域的终端节点。 CDM数据集成：cdm.{region_id}.myhuaweicloud.com，具体如表1所示。 DLF数据开发：dayu-dlf.{region_id}.myhuaweicloud.com，具体如表2所示。 DataArts Studio其他组件（如管理中心、数据架构、数据质量、数据目录、数据服务等）：dayu.{region_id}.myhuaweicloud.com，具体如表3所示。 表1 CDM数据集成Endpoint 区域名称 区域ID 终端节点（Endpoint） 协议类型 华北-北京一 cn-north-1 cdm.cn-north-1.myhuaweicloud.com HTTPS 华北-北京二 cn-north-2 cdm.cn-north-2.myhuaweicloud.com HTTPS 华北-北京四 cn-north-4 cdm.cn-north-4.myhuaweicloud.com HTTPS 华北-乌兰察布一 cn-north-9 cdm.cn-north-9.myhuaweicloud.com HTTPS 华东-上海一 cn-east-3 cdm.cn-east-3.myhuaweicloud.com HTTPS 华东-上海二 cn-east-2 cdm.cn-east-2.myhuaweicloud.com HTTPS 华南-广州 cn-south-1 cdm.cn-south-1.myhuaweicloud.com HTTPS 西南-贵阳一 cn-southwest-2 cdm.cn-southwest-2.myhuaweicloud.com HTTPS 表2 数据开发Endpoint 区域名称 区域ID 终端节点（Endpoint） 协议类型 华北-北京一 cn-north-1 dayu-dlf.cn-north-1.myhuaweicloud.com HTTPS 华北-北京二 cn-north-2 dayu-dlf.cn-north-2.myhuaweicloud.com HTTPS 华北-北京四 cn-north-4 dayu-dlf.cn-north-4.myhuaweicloud.com HTTPS 华北-乌兰察布一 cn-north-9 dayu-dlf.cn-north-9.myhuaweicloud.com HTTPS 华东-上海一 cn-east-3 dayu-dlf.cn-east-3.myhuaweicloud.com HTTPS 华东-上海二 cn-east-2 dayu-dlf.cn-east-2.myhuaweicloud.com HTTPS 华南-广州 cn-south-1 dayu-dlf.cn-south-1.myhuaweicloud.com HTTPS 西南-贵阳一 cn-southwest-2 dayu-dlf.cn-southwest-2.myhuaweicloud.com HTTPS 表3 其他组件Endpoint 区域名称 区域ID 终端节点（Endpoint） 协议类型 华北-北京一 cn-north-1 dayu.cn-north-1.myhuaweicloud.com HTTPS 华北-北京二 cn-north-2 dayu.cn-north-2.myhuaweicloud.com HTTPS 华北-北京四 cn-north-4 dayu.cn-north-4.myhuaweicloud.com HTTPS 华北-乌兰察布一 cn-north-9 dayu.cn-north-9.myhuaweicloud.com HTTPS 华东-上海一 cn-east-3 dayu.cn-east-3.myhuaweicloud.com HTTPS 华东-上海二 cn-east-2 dayu.cn-east-2.myhuaweicloud.com HTTPS 华南-广州 cn-south-1 dayu.cn-south-1.myhuaweicloud.com HTTPS 西南-贵阳一 cn-southwest-2 dayu.cn-southwest-2.myhuaweicloud.com HTTPS

创建DLI SQL脚本 您还可以创建DLI SQL脚本，示例如下。 {"name":"dlisql1","type":"DLISQL","content":"show tables","connectionName":"dliCon1","database":"testDatabase1","queueName":"queue1"} name：脚本的名称，由您自行定义，例如取名为dlisql1。 type：脚本类型。 content：脚本的内容。 connectionName：脚本关联的连接名称。 database：脚本执行的时候，关联的数据库名称。 queueName：sql执行的时候，运行在dli的队列名称。

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "id": "xxxxxxxxxxxxxxxxxx" } } } } 获取Token后，再调用其他接口时（以数据开发组件的“查询连接列表”接口为例），您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 GET https://iam.cn-north-4.myhuaweicloud.com/v1/{project_id}/connectionsContent-Type: application/jsonX-Auth-Token: ABCDEFJ....

创建Shell脚本 如下示例是创建shell脚本的配置。 {"name":"echoTimeShell","type":"Shell","content":"echo a","connectionName":"con"} name：脚本的名称，由您自行定义，例如取名为echoTimeShell。 type：脚本类型。 content：脚本的内容。 connectionName：脚本关联的连接名称。

请求URI 请求URI由如下部分组成： {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同。 终端节点（Endpoint）即调用API的请求地址，不同服务不同区域的终端节点不同。本服务的Endpoint您可以从终端节点Endpoint获取。 例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径，也即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京四”区域的Token，则需使用“华北-北京四”区域的Endpoint（iam.cn-north-4.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Content-Type 消息体的类型（格式），默认取值为“application/json”。 如果请求消息体中含有中文字符，则还需要通过charset=utf8指定中文字符集。 是 application/json;charset=utf8 Content-Length 请求body长度，单位为Byte。 否 3495 X-Language 请求语言 否 en_us X-Project-Id project id，项目编号。请参考项目ID和帐号ID章节获取项目编号。 否 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值，因此调用该接口时，不用填写本字段。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 使用Token认证时该字段必选。 注：以下仅为Token示例片段 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ X-Sdk-Date 请求的发生时间，格式为(YYYYMMDD'T'HHMMSS'Z')。 取值为当前系统的GMT时间。 使用AK/SK认证时必选。 20150907T101459Z Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 使用AK/SK认证时必选。 code.test.com or code.test.com:443 Authorization 签名认证信息。 该值来源于请求签名结果。 使用AK/SK认证时必选。 - workspace 工作空间id，获取方式请参见DataArts Studio实例ID和工作空间ID。 调用批量数据迁移或实时数据接入API时，仅支持default工作空间，无需配置。 调用数据开发API时，默认查询default工作空间数据。如需查询其他工作空间需要带上该消息头。 调用其他组件API时必选，否则会调用失败。 d1cd7861478748a6925bc02f47c69279 X-Dlm-Type 数据服务版本类型，用于请求数据服务时，指定共享版/专享版 调用数据服务接口时必选 共享版: SHARED 专享版: EXCLUSIVE API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokensContent-Type: application/json

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 在IAM的获取用户Token接口的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens

请求消息体 该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的帐号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的ID，获取方法请参见项目ID和帐号ID。 scope参数定义了Token的作用域，上面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个帐号下所有资源或帐号的某个project下的资源，详细定义请参见获取用户Token。 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokensContent-Type: application/json{ "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "id": "xxxxxxxxxxxxxxxxxx" } } }} 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求示例 创建一个名称为“sfs-turbo-test”的SFS Turbo标准型文件系统，共享协议为NFS，容量为500GB，文件系统所在的可用区编码是az1。安全组ID为“8c4ebbd0-6edf-4aae-8353-81ce6d06e1f4”，子网的网络ID为“b8884abe-f47b-4917-9f6c-f64825c365db”，VPC ID为“d651ea2b-2b20-4c6d-8bbf-2adcec18dac9”。 POST HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares{ "share" : { "availability_zone" : "az1", "metadata" : { "crypt_key_id" : "015bf4b8-73cc-4235-8595-46931de7dfd0", "dedicated_flavor" : "c3.large.4", "dedicated_storage_id" : "198f0704-63fc-4d85-b15d-c25caa4d3264" }, "name" : "sfs-turbo-test", "security_group_id" : "8c4ebbd0-6edf-4aae-8353-81ce6d06e1f4", "share_proto" : "NFS", "share_type" : "STANDARD", "size" : 500, "subnet_id" : "b8884abe-f47b-4917-9f6c-f64825c365db", "vpc_id" : "d651ea2b-2b20-4c6d-8bbf-2adcec18dac9" }}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 帐号的token Content-Type 是 String MIME类型 表3 请求Body参数 参数 是否必选 参数类型 描述 extend 是 Extend object extend对象。 表4 Extend 参数 是否必选 参数类型 描述 new_size 是 Integer 扩容后文件系统的新容量，以GB为单位。扩容步长大于等于100GB。 普通文件系统容量，取值范围500~32768。 带宽型文件系统，容量范围是10240~327680 最小值：500 最大值：327680 new_bandwidth 否 Long 扩缩带宽后文件系统的新带宽，以 GB 为单位。仅支持 hpc cache 型文件系统 bss_param 否 BssInfoExtend object 包周期扩容计费详情 表5 BssInfoExtend 参数 是否必选 参数类型 描述 is_auto_pay 否 Long 是否自动付款 枚举值： 0 1

请求消息 参数说明 参数 是否必选 参数类型 描述 metadata 是 Object 设置共享的起始容量参数。 metadata字段说明： 参数 是否必选 参数类型 描述 #sfs_min_capacity 是 Integer 起始容量，用户预设置的共享最小使用容量，基于该容量进行Qos控制，该值越大，文件读写带宽越大。取值范围[40, 512000]，单位GB。 请求样例 修改共享Qos参数，设置共享的起始容量为50GB。 { "metadata" : { "#sfs_min_capacity" : 50 }} { "metadata" : { "#sfs_min_capacity" : 50 }}

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 id String 告警订阅ID。 name String 告警订阅名称。 enable Integer 是否开启订阅 ： 1为开启 0为关闭 alarm_level String 告警级别。其中包括： urgent：紧急 important：重要 minor：次要 prompt：提示 project_id String 项目ID。 name_space String 所属服务。 notification_target String 消息主题地址。 notification_target_name String 消息主题名称。 notification_target_type String 消息主题类型。 language String 语言。 time_zone String 时区。

响应示例 状态码： 200 { "id" : "273ce506-dad8-411c-92f9-be5004739b40", "name" : "zrf-test-13", "enable" : 1, "language" : "zh-cn", "alarm_level" : "urgent,important,minor", "project_id" : "4cf650fd46704908aa071b4df2453e1e", "name_space" : "dws", "notification_target" : "urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete", "notification_target_name" : "dws-test-nodelete", "notification_target_type" : "SMN", "time_zone" : "GMT+08:00"}

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 availability_zones Array of AvailabilityZone objects 可用区列表对象。 count Integer 可用区数量。 表3 AvailabilityZone 参数 参数类型 描述 code String 可用区唯一编码。 name String 可用区名称。 status String 可用区状态。 available：正常。 unavailable：不可用。 public_border_group String 可用区组，如：center。

URI DELETE /v1.0/{project_id}/clusters/{cluster_id}/dns 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法，请参见获取项目ID。 cluster_id 是 String 集群的ID。获取方法，请参见获取集群ID。 表2 Query参数 参数 是否必选 参数类型 描述 type 是 String 域名类型，支持删除公网域名。

请求示例 申请公网域名demo，默认生成的SOA记录中有效缓存时间为300s： POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/b5c45780-1006-49e3-b2d5-b3229975bbc7/dns{ "name" : "demo", "type" : "public", "ttl" : 300}

请求示例 修改集群公网域名demo默认生成的SOA记录中有效缓存时间为300s： PUT https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/b5c45780-1006-49e3-b2d5-b3229975bbc7/dns{ "name" : "demo", "type" : "public", "ttl" : 300}

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 待创建的域名。 说明： 域名可以包含中划线-，但不允许包含下划线_。 type 是 String 域名类型。 public：公网域名。 private：内网域名。 ttl 是 Integer 用于填写默认生成的SOA记录中有效缓存时间，以秒为单位。 取值范围：300~2147483647。 默认值为300s。

URI DELETE /v2/{project_id}/clusters/{cluster_id}/elbs/{elb_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法，请参见获取项目ID。 cluster_id 是 String 集群ID。获取方法，请参见获取集群ID。 elb_id 是 String 集群已绑定的弹性负载均衡ID。

响应示例 状态码： 200 弹性负载均衡列表 { "elbs" : [ { "id" : "1e6e0b66-6223-4523-bfd9-033c88b4ce9f", "name" : "loadbalancer5", "description" : "simple lb", "bandwidth" : 0, "vip_address" : "192.168.0.222", "admin_state_up" : true, "vpc_id" : "c9f1171e-dc90-4ae9-bf22-f9736983ce2d" } ]}

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 elbs Array of ClusterElbInfo objects 弹性负载均衡列表。 表3 ClusterElbInfo 参数 参数类型 描述 id String 弹性负载均衡ID。 cluster_id String 集群ID。 name String 弹性负载均衡名称。 description String 弹性负载均衡描述。 vip_address String 弹性负载均衡地址。 vip_subnet_id String 子网ID。 tenant_id String 租户ID。 type String 弹性负载均衡类型。其中包括： Internal External admin_state_up Boolean 弹性负载均衡的管理状态。其中包括： ACTIVE PENDING_CREATE ERROR bandwidth Integer 绑定状态： 0为未绑定 1为已绑定 vpc_id String 虚拟私有云ID。

响应示例 状态码： 200 数据库对象权限信息 { "authorities" : [ { "name" : "table1", "role_authority" : [ { "role" : "role1", "right_list" : [ "SELECT", "UPDATE" ] }, { "role" : "role2", "right_list" : [ "SELECT", "UPDATE" ] } ] } ]}

URI GET /v1/{project_id}/clusters/{cluster_id}/db-manager/authority 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法，请参见获取项目ID。 cluster_id 是 String 集群ID。获取方法，请参见获取集群ID。 表2 Query参数 参数 是否必选 参数类型 描述 type 是 String 对象类型。 name 是 Array of strings 对象名称。 database 是 String 数据库名。 schema 否 String 模式名。 table 否 String 表名。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 authorities Array of ObjectAuthority objects 对象权限集合。 表4 ObjectAuthority 参数 参数类型 描述 name String 对象名称。 role_authority Array of RoleAuthority objects 角色权限集合。 表5 RoleAuthority 参数 参数类型 描述 role String 角色名称。 right_list Array of strings 权限列表。

请求示例 修改集群ID为“a89aea88-7ea2-40bd-8ac8-8b93e169e5d6”下的用户user1的用户信息，即可以登录数据库并拥有创建角色、创建数据库、访问外表权限，但不赋予给用户系统管理员和审计管理员权限，并不限制连接数等： POST https://{Endpoint}/v1/0536cdee2200d5912f7cc00b877980f1/clusters/a89aea88-7ea2-40bd-8ac8-8b93e169e5d6/db-manager/users/user1{ "login" : true, "createrole" : true, "createdb" : true, "systemadmin" : false, "auditadmin" : false, "inherit" : false, "useft" : true, "conn_limit" : -1, "replication" : false, "valid_begin" : "2023-04-03T12:23:01", "valid_until" : "2023-04-18T12:23:01", "lock" : false}

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 login 否 Boolean 是否可以登录。 createrole 否 Boolean 创建角色权限。 createdb 否 Boolean 创建数据库权限。 systemadmin 否 Boolean 系统管理员。 auditadmin 否 Boolean 审计管理员 inherit 否 Boolean 继承所在组权限。 useft 否 Boolean 访问外表权限。 conn_limit 否 Integer 连接数限制。 replication 否 Boolean 是否允许流复制。 valid_begin 否 String 角色生效时间 yyyy-MM-ddTHH:mm:ssZ。 valid_until 否 String 角色过期时间 yyyy-MM-ddTHH:mm:ssZ。 lock 否 Boolean 是否锁定。