华为云用户手册

请求示例 创建一个 CSS 类型的跨源认证。 { "auth_info_name": "test", "user_name": "admin", "password": "***", "certificate_location": "obs://test/CloudSearchService.cer", "datasource_type": " CS S" }

响应示例 { "name": "test2", "body": { "auto_recovery": false, "max_retry_times": 20, }, "group": "", "description": "", "type": "SPARK", "id": "3c92c202-b17c-4ed7-b353-ea08629dd671" }

响应示例 { "is_success": true, "message": "", "templates": [ { "name": "test2", "body": { "auto_recovery": false, "max_retry_times": 20, }, "group": "", "description": "", "type": "SPARK", "id": "3c92c202-b17c-4ed7-b353-ea08629dd671" } ], "count": 1 }

响应参数 表3 响应参数 参数 参数类型 说明 is_success Boolean 执行请求是否成功。“true”表示请求执行成功。 message String 系统提示信息，执行成功时，信息可能为空。 count Integer 返回的模板个数。 templates Array of Objects 模板信息列表。请参考表4。 表4 templates参数说明 参数 参数类型 说明 type String 模板类型。 id String 模板ID。 name String 模板名字。 body Object 模板内容，请参考表5。 group String 模板所在分组名。 description String 模板描述信息。 language String 语言。 owner String 模板的创建者。 表5 body参数说明 参数 参数类型 说明 file String 用户已上传到 DLI 资源管理系统的类型为jar或pyFile的程序包名。也支持指定OBS路径，例如：obs://桶名/包名。 className String 模板的Java/Spark主类。 cluster_name String 用于指定队列，填写已创建DLI队列的队列名称。 说明： 推荐使用“queue”参数，“queue”参数与“cluster_name”参数两者不能同时存在。 args Array of Strings 传入主类的参数，即应用程序参数。 sc_type String 计算资源类型，目前可接受参数A, B, C。如果不指定，则按最小类型创建。具体资源类型请参见表3。 jars Array of Strings 用户已上传到DLI资源管理系统的类型为jar的程序包名。也支持指定OBS路径，例如：obs://桶名/包名。 pyFiles Array of Strings 用户已上传到DLI资源管理系统的类型为pyFile的资源包名。也支持指定OBS路径，例如：obs://桶名/包名。 files Array of Strings 用户已上传到DLI资源管理系统的类型为file的资源包名。也支持指定OBS路径，例如：obs://桶名/包名。 modules Array of Strings 依赖的系统资源模块名，具体模块名可通过查询组内资源包（废弃）接口查看。 DLI系统提供了用于执行跨源作业的依赖模块，各个不同的服务对应的模块列表如下： CloudTable/ MRS HBase: sys.datasource.hbase CloudTable/MRS OpenTSDB: sys.datasource.opentsdb RDS MySQL: sys.datasource.rds RDS PostGre: 不需要选 DWS: 不需要选 CSS: sys.datasource.css resources Array of Objects JSON对象列表，填写用户已上传到队列的类型为JSON的资源包名和类型。具体请见表4。 groups Array of Objects JSON对象列表，填写用户组类型资源，格式详见请求示例。如果“resources”中的“name”未进行type校验，只要此分组中存在这个名字的包即可。具体请见表5。 conf Object batch配置项，参考Spark Configuration。 name String 创建时用户指定的批处理名称，不能超过128个字符。 driverMemory String Spark应用的Driver内存，参数配置例如2G, 2048M。该配置项会替换“sc_type”中对应的默认参数，使用时必需带单位，否则会启动失败。 driverCores Integer Spark应用Driver的CPU核数。该配置项会替换sc_type中对应的默认参数。 executorMemory String Spark应用的Executor内存，参数配置例如2G, 2048M。该配置项会替换“sc_type”中对应的默认参数，使用时必需带单位，否则会启动失败。 executorCores Integer Spark应用每个Executor的CPU核数。该配置项会替换sc_type中对应的默认参数。 numExecutors Integer Spark应用Executor的个数。该配置项会替换sc_type中对应的默认参数。 obs_bucket String 保存Spark作业的obs桶，需要保存作业时配置该参数。 auto_recovery Boolean 是否开启重试功能，如果开启，可在Spark作业异常失败后自动重试。默认值为“false”。 max_retry_times Integer 最大重试次数。最大值为“100”，默认值为“20”。 feature String 作业特性。表示用户作业使用的Spark镜像类型。 basic：表示使用DLI提供的基础Spark镜像。 custom：表示使用用户自定义的Spark镜像。 ai：表示使用DLI提供的AI镜像。 spark_version String 作业使用Spark组件的版本号。 如果当前Spark组件版本为2.3.2，则不填写该参数。 如果当前Spark组件版本为2.3.3，则在“feature”为“basic”或“ai”时填写。若不填写，则使用默认的Spark组件版本号2.3.2。 image String 自定义镜像 。格式为：组织名/镜像名:镜像版本。 queue String 用于指定队列，填写已创建DLI的队列名。必须为通用类型的队列。 说明： 兼容“cluster_name”参数，即如果使用“cluster_name”指定队列仍然有效。 推荐使用“queue”参数，“queue”参数与“cluster_name”参数两者不能同时存在。 catalog_name String 访问元数据时，需要将该参数配置为dli。

URI URI格式： GET /v3/{project_id}/templates?type=spark 参数说明 表1 URI参数说明 参数 是否必选 参数类型 描述 project_id 是 String 项目编号，用于资源隔离。获取方式请参考获取项目ID。 表2 query参数说明 参数 是否必选 参数类型 说明 type 是 String 模板类型。 取值范围： SPARK：Spark模板。 当前只支持配置Spark类型的模板。 keyword 否 String 模板名过滤关键字，模糊匹配，获取模板名含有该关键字的所有模板。 page-size 否 Integer 每页显示的最大结果行数，范围: [1, 100]。默认值为：50。 current-page 否 Integer 当前页码，默认为第一页。

响应参数 表2 响应参数 参数 参数类型 说明 is_success Boolean 请求执行是否成功。“true”表示请求执行成功。 message String 系统提示信息，执行成功时，信息可能为空。 执行失败时，用于显示执行失败的原因。 sqls Array of Object 样例模板信息，具体参数说明请参见表3。 sqlCount Integer 样例模板个数。 表3 sqls参数说明 参数 参数类型 说明 lang String 语言。 name String 样例模板名称。 sql String 样例模板内容。 description String 样例模板描述。 group String 样例模板分组。

响应参数 表3 响应参数说明 名称 参数类型 说明 is_success Boolean 是否成功。 message String 系统提示信息，执行成功时，信息可能为空。执行失败时，用于显示执行失败的原因。 sql_count Int SQL模板总数。 sqls Array of Object SQL模板信息，具体参数说明请参见表4。 表4 sqls参数说明 名称 参数类型 说明 sql_id String SQL模板ID。 sql_name String SQL模板名称。 sql String SQL模板文本。 description String SQL模板描述信息。 owner String SQL模板的创建者。 group String SQL模板分组名称。

响应示例 { "is_success": true, "message": "", "sql_count": 1, "sqls": [ { "description": "use to select t1", "owner": "tenant1", "sql": "select * from t1", "sql_id": "1994b029-3f76-4281-9e35-e370cb4ee26d1501998934432", "sql_name": "sql1", "group": "" } ] }

URI URI格式： DELETE /v2.0/{project_id}/datasource/enhanced-connections/{connection_id}/routes/{name} 参数说明 表1 URI参数说明 参数 是否必选 参数类型 描述 project_id 是 String 项目编号，用于资源隔离。获取方式请参考获取项目ID。 connection_id 是 String 跨源id。 name 是 String 路由名称。

请求参数 名称 是否必选 参数类型 说明 auth_info_name 是 String 指定更新的跨源认证名称。 user_name 否 String 用户安全集群的新登录用户名。 password 否 String 用户安全集群的新登录密码。 krb5_conf 否 String krb5配置文件obs路径。 keytab 否 String keytab配置文件obs路径。 truststore_location 否 String truststore配置文件obs路径。 truststore_password 否 String truststore配置文件密码。 keystore_location 否 String keystore配置文件obs路径。 keystore_password 否 String keystore配置文件密码。

响应示例 { "count": 19, "auth_infos": [{ "auth_info_name": "lan2", "datasource_type": "Kafka_SSL", "create_time": 1578896427789, "update_time": 1578898059677, "owner": "ei_dlics_d00352221", "truststore_location": "obs://lan-1/cer/truststore.jks", "keystore_location": "obs://lan-1/cer/keystore.jks" }, { "auth_info_name": "lan3", "datasource_type": "Kafka_SSL", "create_time": 1578899029971, "update_time": 1578901678150, "owner": "ei_dlics_d00352221", "truststore_location": "obs://lan-1/cer/truststore1.jks", "keystore_location": "obs://lan-1/cer/keystore.jks" }] }

URI URI格式： GET /v2.0/{project_id}/datasource/auth-infos 参数说明 表1 URI参数说明 参数 是否必选 参数类型 描述 project_id 是 String 项目编号，用于资源隔离。获取方式请参考获取项目ID。 表2 query参数 参数名称 是否必选 参数类型 说明 limit 否 String 查询最大连接个数，默认为100。 offset 否 String 查询结果偏移量，默认为0（连接以创建时间进行排序）。 auth_info_name 是 String 认证信息名，同一个project下唯一。

响应参数 表3 响应参数 参数 参数类型 说明 is_success Boolean 请求执行是否成功。“true”表示请求执行成功。 message String 系统提示信息，执行成功时，信息可能为空。 count int 证书个数。 auth_infos List 认证信息列表。详细说明请参考表4。 表4 auth_infos参数说明 名称 参数类型 说明 auth_info_name String 用户安全集群的登录用户名。 user_name String 用户安全集群的登录密码。 certificate_location String 创建时指定的证书OBS路径。 datasource_type String 数据源的类型。 create_time Int 创建时间戳。 update_time Int 更新时间戳。 krb5_conf String krb5配置文件obs路径。 keytab String keytab配置文件obs路径。 truststore_location String truststore配置文件obs路径。 keystore_location String keystore配置文件obs路径。 owner String 所属用户名。

请求参数 表2 请求参数 名称 是否必选 参数类型 说明 auth_info_name 是 String 认证信息名，同一个project下唯一。 user_name 否 String 认证相关用户名。 password 否 String 认证相关用户密码。 certificate_location 否 String 用户安全集群的证书路径，目前只支持OBS路径，cer类型文件。 datasource_type 是 String 数据源类型，目前支持CSS,KRB,passwd,Kafka_SSL。 krb5_conf 否 String krb5配置文件obs路径。 keytab 否 String keytab配置文件obs路径。 truststore_location 否 String truststore配置文件obs路径。 truststore_password 否 String truststore配置文件密码。 keystore_location 否 String keystore配置文件obs路径。 keystore_password 否 String keystore配置文件密码。 key_password 否 String key密码。

请求示例 创建一个CSS类型的跨源认证。 { "auth_info_name": "test", "user_name": "admin", "password": "***", "certificate_location": "obs://test/CloudSearchService.cer", "datasource_type": "CSS" }

响应参数 表3 响应Body参数 参数 参数类型 描述 count Integer 返回数组长度。 items Array of arrays 数组中返回的数据。详细说明请参考表4。 表4 items参数 参数 参数类型 描述 max_cu Integer 最大CU。 min_cu Integer 最小CU。 current_cu Integer 扩缩容后CU。 origin_cu Integer 扩缩容前CU。 target_cu Integer 扩缩容预期CU record_time Long 操作完成时间。 status String 扩缩容成功或者失败的状态。 fail_reason String 失败原因。

响应示例 扩缩容历史记录查询接口查询成功 { "count" : 1, "items" : [ { "max_cu" : 64, "min_cu" : 16, "current_cu" : 16, "target_cu" : 16, "origin_cu" : 16, "record_time" : 1650784624000, "status" : "fail", "fail_reason" : "Internal error, please contact technical support." } ] }

URI GET /v3/{project_id}/elastic-resource-pools/{elastic_resource_pool_name}/scale-records 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目编号，用于资源隔离。获取方式请参考获取项目ID。 elastic_resource_pool_name 是 String 弹性资源池名称。 长度限制：1~128个字符。 表2 Query参数 参数 是否必选 参数类型 描述 start_time 否 Long start_time用于查询扩缩容历史的开始时间，该时间点需大于当前时间点减30天，必须小于end_time 。时间格式为unix时间戳，单位：毫秒。 若start_time为空，则查询end_time前七天到end_time的数据（end_time最大不能大于当前时间30天）。 查询当前时间点前15天到当前时间点的数据（start_time和end_time同时为空）。 end_time 否 Long end_time用于查询扩缩容历史的结束时间，该时间点不能小于开始时间，不能大于当前时间。时间格式为unix时间戳，单位：毫秒。 若end_time为空，则查询start_time到当前时间点的数据。 查询当前时间点前15天到当前时间的数据（start_time和end_time同时为空）。 status 否 String 弹性资源池扩缩容的状态。 枚举值： success fail offset 否 Integer 偏移量。 最小值：0 limit 否 Integer 当前分页条数。 最小值：0 最大值：100

请求示例 修改弹性资源池关联队列的扩缩容策略。 { "queue_scaling_policies" : [ { "priority" : 100, "impact_start_time" : "10:00", "impact_stop_time" : "22:00", "min_cu":"64", "max_cu":"752" }, { "priority" : 50, "impact_start_time" : "22:00", "impact_stop_time" : "10:00", "min_cu":"64", "max_cu":"752" } ] }

请求消息 表2 请求参数说明 参数 是否必选 参数类型 描述 queue_scaling_policies 是 Array of objects 该队列在该弹性资源池下的扩缩容策略信息。单条策略信息包含时间段、优先级和CU范围。每个队列至少要配置一条时间段为[00:00, 24:00]的默认扩缩容策略。详细参数说明请参考表3。 表3 queue_scaling_policies 参数 是否必选 参数类型 描述 impact_start_time 是 String 生效开始时间。 impact_stop_time 是 String 生效结束时间。 priority 是 Integer 优先级。 min_cu 是 Integer 最小CU数量。 max_cu 是 Integer 最大CU数量。

URI URI格式 PUT /v3/{project_id}/elastic-resource-pools/{elastic_resource_pool_name}/queues/{queue_name} 参数说明 表1 路径参数 参数 是否必选 参数类型 描述 elastic_resource_pool_name 是 String 弹性资源池名称。 project_id 是 String 项目编号，用于资源隔离。获取方式请参考获取项目ID。 queue_name 是 String 绑定的队列名称。

URI URI格式 POST /v3/{project_id}/elastic-resource-pools/{elastic_resource_pool_name}/queues 参数说明 表1 路径参数 参数 是否必选 参数类型 描述 elastic_resource_pool_name 是 String 弹性资源池名称。 project_id 是 String 项目编号，用于资源隔离。获取方式请参考获取项目ID。

响应示例 { "is_success": true, "message": "", "count": 1, "queues": [ { "queue_name": "lhm_sql", "enterprise_project_id": "0", "queue_type": "sql", "queue_scaling_policies": [ { "priority": 50, "impact_start_time": "00:00", "impact_stop_time": "24:00", "min_cu": 16, "max_cu": 16 }, { "priority": 100, "impact_start_time": "00:00", "impact_stop_time": "12:00", "min_cu": 32, "max_cu": 64 }, { "priority": 50, "impact_start_time": "12:00", "impact_stop_time": "24:00", "min_cu": 16, "max_cu": 32 } ] } ] }

响应消息 表3 响应参数说明 参数 是否必填 参数类型 描述 is_success 否 Boolean 执行请求是否成功。“true”表示请求执行成功。 message 否 String 系统提示信息，执行成功时，信息可能为空。 queues 否 Array of objects 该弹性资源池下所有queue的资源权重信息。详细参数说明请参考表4。 count 否 Long 该资源池下关联的队列数量。 表4 queues 参数 是否必填 参数类型 描述 queue_name 否 String 队列名称。 enterprise_project_id 否 String 企业项目ID。 queue_type 否 String 队列类型。 queue_scaling_policies 否 Array of objects 队列扩缩容策略。详细参数说明请参考priority_infos。 owner 否 String 队列所有者。 create_time 否 Long 队列创建时间。 engine 否 String 队列引擎类型。 表5 queue_scaling_policies 参数 是否必填 参数类型 描述 priority 否 Integer 策略优先级1-100，100优先级最高。 impact_start_time 否 String 生效开始时间。 impact_stop_time 否 String 生效结束时间。 min_cu 否 Integer 最小CU数量。 max_cu 否 Integer 最大CU数量。

URI URI格式 GET /v3/{project_id}/elastic-resource-pools/{elastic_resource_pool_name}/queues 参数说明 表1 路径参数 参数 是否必选 参数类型 描述 elastic_resource_pool_name 是 String 弹性资源池名称。 project_id 是 String 项目编号，用于资源隔离。获取方式请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每页的数量。默认为100。 offset 否 Integer 偏移量。默认为0。 queue_name 否 String 可以根据queueName进行过滤。

URI URI格式 DELETE /v3/{project_id}/elastic-resource-pools/{elastic_resource_pool_name} 参数说明 表1 路径参数 参数 是否必选 参数类型 描述 elastic_resource_pool_name 是 String 弹性资源池名称。 project_id 是 String 项目编号，用于资源隔离。获取方式请参考获取项目ID。

响应示例 { "is_success": true, "message": "", "count": 2, "elastic_resource_pools": [ { "owner": "ei_dlics_d00352221", "id": 1026, "elastic_resource_pool_name": "elastic_pool_0622_10", "description": "", "max_cu": 0, "min_cu": 0, "actual_cu": 0, "cidr_in_vpc": "172.16.0.0/12", "create_time": 1624366266826, "current_cu": 64, "status": "AVAILABLE", "resource_id": "ecc98d89-3fd1-4dec-b572-aa6e2ef82391", "fail_reason": "", "enterprise_project_id": "0", "prepay_cu": 0, "charging_mode": 1 }, { "owner": "ei_dlics_d00352221", "id": 1002, "elastic_resource_pool_name": "elastic_pool_0622_0", "description": "test", "max_cu": 684, "min_cu": 0, "actual_cu": 0, "cidr_in_vpc": "172.16.0.0/12", "create_time": 1624353878084, "status": "AVAILABLE", "resource_id": "ecc98d89-3fd1-4dec-b572-aa6e2ef82391", "fail_reason": "", "enterprise_project_id": "0", "prepay_cu": 0, "charging_mode": 1 } ] }

URI URI格式 GET /v3/{project_id}/elastic-resource-pools 参数说明 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目编号，用于资源隔离。获取方式请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每页的数量。默认为100。 name 否 String 通过弹性资源池名称进行模糊匹配。 offset 否 Integer 偏移量。默认为0。 status 否 String 弹性资源池状态。具体参数范围如下： AVAILABLE：可使用 SCALING：规格变更中 CREATING：创建中 FAILED：已失败 tags 否 String 查询根据标签进行过滤。

请求示例 创建一个弹性资源池，最大CU为684，最小CU为684。 { "elastic_resource_pool_name" : "elastic_pool_0623_02", "description" : "test", "cidr_in_vpc" : "172.16.0.0/14", "charging_mode" : "1", "max_cu" : 684, "min_cu" : 684 }

请求消息 表2 请求参数说明 参数 是否必选 参数类型 描述 elastic_resource_pool_name 是 String 新建的弹性资源池名称，名称只能包含数字、英文字母和下划线，但不能是纯数字，且不能以下划线开头。长度限制：1~128个字符。 说明： 若名称中包含大写字母，将会自动转换为小写字母。 description 否 String 描述信息。长度限制：256个字符以内。 cidr_in_vpc 否 String 虚拟集群关联的vpc cidr。如果不填，默认值为172.16.0.0/12。 max_cu 是 Integer 最大CU大于等于该资源池下任意一个队列的最大CU之和且大于min_cu 标准版：最小值为64CUs 基础版：最小值为16CUs，最大值为64CUs min_cu 是 Integer 最小CU大于等于该资源池下所有队列最小CU之和，最小值为64。 标准版：最小值为64CUs 基础版：最小值为16CUs，最大值为64CUs charging_mode 否 Integer 计费类型：默认值是1，表示按需计费。 enterprise_project_id 否 String 企业ID，不填默认为“0”。 tags 否 Array of Objects 队列的标签，使用标签标识云资源。包括“标签键”和“标签值”，具体请参考表3。 label 否 map 弹性资源池属性字段。 如果需要购买基础版，配置该参数值为{"spec":"basic"}。 不配置该参数时默认为标准版弹性资源池。 表3 tags参数 参数名称 是否必选 参数类型 说明 key 是 String 标签的键。 说明： 标签的键的最大长度为128个字符，标签的键可以包含任意语种字母、数字、空格和_ . : =+-@ ,但首尾不能含有空格，不能以_sys_开头。 value 是 String 标签的值。 说明： 标签值的最大长度为255个字符，标签的值可以包含任意语种字母、数字、空格和_ . : =+-@ ,但首尾不能含有空格。