华为云用户手册

请求消息 表2 请求参数 参数名称 是否必选 参数类型 说明 plan_name 是 String 队列扩缩容计划名称，名称只能包含数字、英文字母和下划线，但不能是纯数字，且不能以下划线开头。 target_cu 是 Integer 队列扩缩容计划CU的目标值。 start_hour 是 Integer 队列扩缩容计划起始小时时间。 start_minute 是 Integer 队列扩缩容计划的起始分钟时间。 repeat_day 是 Array of strings 定时扩缩容计划的重复周期，可以选择周一到周日的某一天、某几天、或者不选择。如果不选择，则会在当前时间后的start_hour：start_minute时间点执行扩缩容计划。例如： "repeat_day": ["MONDAY", "TUESDAY", "WEDNESDAY","SUNDAY"] valid_date_begin 否 Long 有效期开始时间（13位时间戳）。 valid_date_end 否 Long 有效期结束时间（13位时间戳）。 activate 否 Boolean 当前设置的扩缩容计划是否激活，默认为“true”，表示激活。

请求示例 上报IEF系统事件，事件类型deployment、事件操作类型updated。 { "data": { "event_type": "deployment", "operation": "updated", "timestamp": 1591879887, "topic": "$hw/events/deployment/+/updated", "name": "edge-cs", "attributes": {} } }

请求消息 表2 请求参数说明 参数名称 是否必选 参数类型 说明 data 是 Object 系统事件数据。具体参数内容详见表3说明。 表3 data参数说明 参数名称 是否必选 参数类型 说明 event_type 是 String 事件类型。 operation 是 String 事件的操作类型。 timestamp 是 Integer 事件产生的时间戳。 topic 是 String 消息发送的Topic。 name 是 String 资源名称。 attributes 否 String 资源的属性。

请求示例 IEF Flink作业的Action回调，Flink状态为FAILED，错误原因为“flink job submit failed”。 { "message_id": "5a3f33f7-bcd9-42bd-a8ca-9b612c36b3ase", "state": { "phase": "FAILED", "reason": "flink job submit failed," } }

请求消息 请求样例 表2 请求参数说明 参数名称 是否必选 参数类型 说明 jobs 是 Array of Objects 作业信息列表。具体请参考表3。 msg_confirm_topic 否 String 消息确认topic。 message_id 是 String 消息id。 表3 jobs参数说明 参数名称 是否必选 参数类型 说明 job_id 否 Integer 作业ID。 status 是 String 作业状态。 create_time 是 Long 时间戳。 exceptions 否 String 作业异常信息。 metrics 否 String 作业指标信息。 plan 否 String 作业执行计划。

请求示例 上报ID为99270的边缘Flink作业状态。 { "jobs": [ { "create_time": 1591104868201, "job_id": 99270, "exceptions": { "error_id": "Agent.51000", "error_type": "JOB_SUBMIT_EXCEPTION", "error_cause": "agent_submit_job_exception_error", "exception": "", "error_time": "2020-06-02 13:34:28" }, "status": "job_submit_fail" } ], "msg_confirm_topic": "hw/events/messages/dli/message/confirm", "message_id": "uuid" }

URI URI格式： GET /v1.0/{project_id}/queues/{queue_name}/connection-test/{task_id} 参数说明 表1 URI参数 参数名称 是否必选 参数类型 说明 project_id 是 String 项目编号，用于资源隔离。获取方式请参考获取项目ID。 queue_name 是 String 队列名称。 task_id 是 String 任务ID。该参数为创建指定地址连通性测试请求接口获取。

URI URI格式 GET /v1.0/{project_id}/variables 参数说明 表1 URI参数说明 参数名称 是否必选 参数类型 说明 project_id 是 String 项目编号，用于资源隔离。获取方式请参考获取项目ID。 表2 query参数说明 参数名称 是否必选 参数类型 说明 limit 否 Integer 每页显示的返回信息的个数，默认值为“100”。 offset 否 Integer 偏移量，默认值为“0”。

响应消息 表3 响应参数说明 参数名称 是否必选 参数类型 说明 is_success 否 Boolean 执行请求是否成功。“true”表示请求执行成功。 message 否 String 系统提示信息，执行成功时，信息可能为空。 count 否 Integer 全局变量数量。 global_vars 否 Array of Objects 全局变量信息。请参见表4。 表4 global_vars参数说明 参数名称 是否必选 参数类型 说明 id 否 Long 全局变量ID。 var_name 是 String 全局变量名称。 var_value 是 String 全局变量值。 project_id 否 String 项目ID。 user_id 否 String 用户ID。 user_name 否 String 用户名。 is_sensitive 否 Boolean 是否设置为敏感变量。 create_time 否 Long 创建时间。 update_time 否 Long 更新时间。

响应示例 { "is_success": true, "message": "string", "count": 0, "global_vars": [ { "id": 0, "var_name": "string", "var_value": "string", "project_id": "string", "user_id": "string" } ] }

URI URI格式 PUT /v1.0/{project_id}/variables/{var_name} 参数说明 表1 URI参数说明 参数名称 是否必选 参数类型 说明 project_id 是 String 项目编号，用于资源隔离。获取方式请参考获取项目ID。 var_name 是 String 全局变量名，名称只能包含数字、英文字母和下划线，但不能是纯数字，不能以下划线开头，且不能超过128字符。

URI URI格式 DELETE /v1.0/{project_id}/variables/{var_name} 参数说明 表1 URI参数说明 参数名称 是否必选 参数类型 说明 project_id 是 String 项目编号，用于资源隔离。获取方式请参考获取项目ID。 var_name 是 String 全局变量名，名称只能包含数字、英文字母和下划线，但不能是纯数字，不能以下划线开头，且不能超过128字符。

响应示例 { "is_success": true, "message": "", "privileges": [ { "object": "edsconnections.503fc86a-5e60-4349-92c2-7e399404fa8a", "applicant_project_id": "330e068af1334c9782f4226acc00a2e2", "privileges": ["BIND_QUEUE"] } ], "connection_id": "503fc86a-5e60-4349-92c2-7e399404fa8a" }

URI URI格式 GET /v2.0/{project_id}/datasource/enhanced-connections/{connection_id}/privileges 参数说明 表1 URI参数 参数名称 是否必选 参数类型 说明 project_id 是 String 项目编号，用于资源隔离。获取方式请参考获取项目ID。 connection_id 是 String 连接ID，用于标识跨源连接的UUID。

响应消息 表2 响应参数 参数名称 是否必选 参数类型 说明 is_success 否 Boolean 执行请求是否成功。“true”表示请求执行成功。 message 否 String 系统提示信息，执行成功时，信息可能为空。 connection_id 否 String 增强型跨源连接ID，用于标识跨源连接的UUID。 privileges 否 Array of Object 跨源连接各个授权项目的信息。具体参数请参考表3。 表3 privileges参数 参数名称 是否必选 参数类型 说明 object 否 String 授权时object的信息。 applicant_project_id 否 String 授权的项目ID。 privileges 否 Array of Strings 授权操作信息。

响应示例 { "is_success": true, "message": "导入作业成功", "job_mapping": [ { "old_job_id": "100", "new_job_id": "200", "remark": "Job successfully created" } ] }

响应消息 表3 响应参数说明 参数名称 是否必选 参数类型 说明 is_success 否 String 执行请求是否成功。“true”表示请求执行成功。 message 否 String 系统提示信息，执行成功时，信息可能为空。 job_mapping 否 Array of Objects 导入作业的信息。具体请参考表4。 表4 job_mapping参数说明 参数名称 是否必选 参数类型 说明 old_job_id 否 Long 导入的作业ID。 new_job_id 否 Long 导入后的作业ID，如果“is_cover”为“false”，服务中有同名的作业，则该参数返回值为“-1”。 remark 否 String 导入作业的结果信息。

请求消息 表2 请求参数说明 参数名称 是否必选 参数类型 说明 obs_dir 是 String OBS路径，用于保存导出的作业文件。 is_selected 是 Boolean 是否导出指定的作业。 job_selected 否 Array of Longs 当“is_selected”为“true”时，该参数是待导出作业的ID集合。 说明： 当“is_selected”为“true”时，该参数为必选。

请求消息 表2 请求参数 参数名称 是否必选 参数类型 说明 new_owner 是 String 新用户名。名称只能包含数字、英文字母、下划线和中划线且不能以数字开头，长度在5-32字符之间。 group_name 是 String 组名。名称只能包含数字、英文字母、点、下划线和中划线，长度不能超过64字符。 resource_name 否 String 包名。名称只能包含数字字母，下划线，感叹号，中划线，点，但是不能以点开头，长度（包含文件后缀）不能超过128个字符。 修改组下的资源包拥有者，则该参数为必选参数。 “group_name”和“resource_name”可以单独使用，也可以组合使用。 修改组的拥有者：使用“group_name”。 修改资源包拥有者：使用“resource_name”。 修改组下的资源包的拥有者：同时使用“group_name”和“resource_name”。

响应消息 表3 响应参数 参数名称 是否必选 参数类型 说明 is_success 是 Boolean 执行请求是否成功。“true”表示请求执行成功。 message 是 String 系统提示信息。执行成功时，信息可能为空。 object_name 否 String 对象名称。 object_type 否 String 对象类型。 privileges 否 Array of Object 权限信息。具体内容请参考表4。 count 否 Integer 权限总数量。 表4 privileges参数 参数名称 是否必选 参数类型 说明 object 否 String 授权对象，和赋权API中的“object”对应。 is_admin 否 Boolean 判断用户是否为管理员。 user_name 否 String 用户名称，即该用户在当前数据库上有权限。 privileges 否 Array of Strings 该用户在数据库上的权限。

响应示例 { "is_success": true, "message": "", "object_name": "9561", "object_type": "flink", "count": 2, "privileges": [ { "user_name": "testuser1", "is_admin": true, "privileges": [ "ALL" ] }, { "user_name": "user1", "is_admin": false, "privileges": [ "GET" ] } ] }

响应示例 { "is_success": true, "message": "list partitions succeed", "partitions": { "total_count": 5, "partition_infos": [ { "partition_name": "name=test", "create_time": 1579520179000, "last_access_time": 1579520179000, "locations": [ "obs://test/partition" ] }, { "partition_name": "name=test1", "create_time": 1579521406000, "last_access_time": 1579521406000, "locations": [ "obs://test/partition" ] }, { "partition_name": "name=test2", "create_time": 1579521884000, "last_access_time": 1579521884000, "locations": [ "obs://test/partition" ] }, { "partition_name": "name=test3", "create_time": 1579522085000, "last_access_time": 1579522085000, "locations": [ "obs://test/partition" ] }, { "partition_name": "name=name1/age=age1", "create_time": 1581409182000, "last_access_time": 1581409182000, "locations": [ "obs://test/0117" ], "last_ddl_time": 1581409182, "total_size": 2130, "num_rows": -1, "num_files": 2 } ] } }

URI URI格式： GET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}/partitions 参数说明 表1 URI 参数 参数名称 是否必选 参数类型 说明 project_id 是 String 项目编号，用于资源隔离。获取方式请参考获取项目ID。 database_name 是 String 数据库名称。 table_name 是 String 表名称。 表2 query参数 参数名称 是否必选 参数类型 说明 limit 否 Integer 每页显示的返回信息的个数，默认值为100。 offset 否 Integer 偏移量。 filter 否 String 筛选条件，目前只支持“=”条件筛选，例如：name=name1，表示筛选出分区中name=name1的数据，name为分区列名称，name1为分区列的值。key和value不区分大小写。 例如：GET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}/partitions?part=part2

响应消息 表3 响应参数 参数名称 是否必选 参数类型 说明 is_success 否 Boolean 执行请求是否成功。“true”表示请求执行成功。 message 否 String 系统提示信息，执行成功时，信息可能为空。 partitions 否 Object 分区信息。请参考表4。 表4 partitions参数说明 参数名称 是否必选 参数类型 说明 total_count 是 Long 总个数。 partition_infos 是 Array of Objects 分区信息列表。请参考表5。 表5 partition_infos参数说明 参数名称 是否必选 参数类型 说明 partition_name 是 String 分区名。 create_time 是 Long 创建时间。 last_access_time 是 Long 最后改动时间。 locations 否 Array of Strings 路径，非 DLI 表显示，DLI表不显示。 last_ddl_time 否 Long 最后一个ddl语句执行时间，（单位：秒（s））。 num_rows 否 Long 该分区数据总行数。 num_files 否 Long 分区文件数。 total_size 否 Long 该分区总的数据大小（单位：字节）。

错误码 调用接口出错后，将不会返回上述结果，而是返回错误码和错误信息，更多介绍请参见错误码。 表5 错误码 错误码 错误信息 DLI.0015 Token info for token is null, return. DLI.0013 X-Auth-Token is not defined in request. It is mandatory. Please define and send the request.

响应消息 表3 响应参数 参数名称 是否必选 参数类型 说明 is_success 否 Boolean 请求执行是否成功。“true”表示请求执行成功。 message 否 String 系统提示信息，执行成功时，信息可能为空。 job_id 否 String 当“force”为“true”时返回的job_id。 queue_name 否 String 扩缩容的队列名称。 result 否 Boolean 扩缩容结果。

请求消息 表2 请求参数 参数名称 是否必选 参数类型 说明 action 是 String 执行动作： restart：重启。只有SQL类型的队列支持重启。 scale_out：扩容 scale_in：缩容 说明： 目前只支持restart、scale_out、scale_in。 force 否 Boolean 是否强制重启，“action”为“restart”时可选择配置，默认为“false”。 cu_count 否 Integer 扩容或者缩容的cu数。“action”为“scale_out”或者“scale_in”时可选择配置。“cu_count”必须是16的倍数。

响应示例 “force”为“false” { "is_success": true, "message": "Restart success" } “force”为“true” { "is_success": true, "message": "Submit restart job success, it need some time to cancel jobs, please wait for a while and check job status", "job_id": "d90396c7-3a25-4944-ad1e-99c764d902e7" } 扩缩容 { "queue_name": "myQueue", "result": true }

URI URI格式 GET /v1.0/{project_id}/streaming/job-templates 参数说明 表1 URI参数说明 参数名称 是否必选 参数类型 说明 project_id 是 String 项目编号，用于资源隔离。获取方式请参考获取项目ID。 表2 query参数说明 参数名称 是否必选 参数类型 描述 name 否 String 模板名称。支持根据name进行模糊查询。 tags 否 String 标签名列表。单个标签为k=v，多个标签以“，”分隔。示例tag1=v1,tag2=v2。 offset 否 Long 作业偏移量。 limit 否 Integer 返回的数据条数。默认为“10”。 order 否 String 查询结果排序。 asc：升序 desc：降序 默认为“desc”。

响应示例 { "is_success": "true", "message": "获取模板列表成功", "template_list": { "total_count": 2, "templates": [ { "template_id": 2, "name": "updatetest", "desc": "快速上手示例", "create_time": 1578748092000, "update_time": 1578748092000, "sql_body": "select * from source_table", "job_type": "flink_sql_job" }, { "template_id": 1, "name": "we", "desc": "qwe", "create_time": 1577951045000, "update_time": 1577951045000, "sql_body": "" } ] } }