华为云用户手册

  • 响应示例 状态码: 200 ok { "content" : [ { "builtin_rule_id" : null, "category_id" : "0cce38e7c28547828905ae9e4f10a4bf", "column_expression" : null, "commit_expression" : null, "content_expression" : ".*", "created_at" : 1698633124002, "created_by" : "chenxiaoyu", "description" : "", "enable" : true, "groups" : null, "guid" : null, "instance_id" : "dd97167b873d4a79b2aad54d4370a3bc", "match_type" : null, "method" : "REGULAR", "name" : "matchRules", "project_id" : "0833a5737480d53b2f25c010dc1a7b88", "rule_type" : "CUSTOM", "secrecy_level" : "asd", "secrecy_level_num" : 1, "updated_at" : 1698633124002, "updated_by" : "chenxiaoyu", "uuid" : "8a94800e8b753a35018b7e6be6950023" } ], "total" : 1 }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 content Array of DataClassificationRuleQueryDTO objects 查询到的所有数据识别规则 数组长度:0 - 100 total Integer 数据识别规则总数 最小值:0 最大值:2147483647 表5 DataClassificationRuleQueryDTO 参数 参数类型 描述 uuid String 规则ID 最小长度:1 最大长度:128 rule_type String 规则类型, CUSTOM, BUILTIN 枚举值: CUSTOM BUILTIN secrecy_level String 密级 最小长度:1 最大长度:128 secrecy_level_num Long 密级层级 最小值:1 最大值:128 name String 规则名称 最小长度:1 最大长度:128 guid String guid 最小长度:1 最大长度:128 groups Array of DataClassificationGroupQueryDTO objects 规则组 数组长度:0 - 100 enable Boolean 规则是否开启 method String 规则方式, REGULAR, NONE, DEFAULT 枚举值: REGULAR NONE DEFAULT content_expression String 内容表达式 最小长度:1 最大长度:4096 column_expression String 列表达式 最小长度:1 最大长度:4096 commit_expression String 备注表达式 最小长度:1 最大长度:4096 project_id String 项目ID 最小长度:1 最大长度:128 description String 规则描述 最小长度:0 最大长度:4096 created_by String 策略创建人 最小长度:1 最大长度:128 created_at Long 策略创建时间 最小值:0 最大值:2147483647 updated_by String 策略更新人 最小长度:1 最大长度:128 updated_at Long 策略更新时间 最小值:0 最大值:2147483647 builtin_rule_id String 内置规则ID 最小长度:1 最大长度:128 category_id String 分类ID 最小长度:1 最大长度:128 instance_id String 实例ID 最小长度:1 最大长度:64 match_type String 匹配类型 最小长度:1 最大长度:128 表6 DataClassificationGroupQueryDTO 参数 参数类型 描述 uuid String 规则组ID 最小长度:1 最大长度:128 name String 规则组名称 最小长度:1 最大长度:128 rules Array of DataClassificationRuleQueryDTO objects 规则实体 数组长度:0 - 100 description String 规则组描述 最小长度:0 最大长度:4096 created_by String 规则组创建人 最小长度:1 最大长度:128 created_at Long 规则组创建时间 最小值:0 最大值:2147483647 updated_by String 规则组更新人 最小长度:1 最大长度:128 updated_at Long 规则组更新时间 最小值:0 最大值:2147483647 project_id String 项目ID 最小长度:1 最大长度:128 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:128 error_msg String 错误描述 最小长度:1 最大长度:10240
  • URI GET /v1/{project_id}/security/data-classification/rule 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String project id 最小长度:1 最大长度:128 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer limit 最小值:0 最大值:100 offset 否 Integer offset 最小值:0 最大值:99999 secrecy_level 否 String 密级 最小长度:1 最大长度:128 name 否 String 规则名称 最小长度:1 最大长度:128 creator 否 String 规则创建者 最小长度:1 最大长度:128 enable 否 Boolean 规则是否开启 start_time 否 Long 开始日期 最小值:0 最大值:2147483647 end_time 否 Long 结束日期 最小值:0 最大值:2147483647 desc 否 Boolean 排序规则 缺省值:true order_by 否 String 排序字段, createdAt, createdBy, updatedAt, updatedBy, name, description 枚举值: createdAt createdBy updatedAt updatedBy name description
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 rule_id String 识别规则id 最小长度:1 最大长度:128 rule_name String 识别规则名称 最小长度:1 最大长度:128 enabled Boolean 识别规则是否开启 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:128 error_msg String 错误描述 最小长度:1 最大长度:10240
  • 响应示例 状态码: 200 OK { "rule_groups" : [ { "created_at" : 1697600262611, "created_by" : "ei_dayu_test_01", "description" : "test", "name" : "test_rule_group", "project_id" : "0833a5737480d512fa51w010dc1a7b88", "rules" : null, "updated_at" : 1697600262611, "updated_by" : "ei_dayu_test_01", "uuid" : "8a125fdsesa0b421012saed35c770004" } ], "total" : 1 }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 rule_groups Array of DataClassificationGroupQueryDTO objects 规则组列表 数组长度:0 - 100 total Long 规则组总数 最小值:0 最大值:2147483647 表5 DataClassificationGroupQueryDTO 参数 参数类型 描述 uuid String 规则组ID 最小长度:1 最大长度:128 name String 规则组名称 最小长度:1 最大长度:128 rules Array of DataClassificationRuleQueryDTO objects 规则实体 数组长度:0 - 100 description String 规则组描述 最小长度:0 最大长度:4096 created_by String 规则组创建人 最小长度:1 最大长度:128 created_at Long 规则组创建时间 最小值:0 最大值:2147483647 updated_by String 规则组更新人 最小长度:1 最大长度:128 updated_at Long 规则组更新时间 最小值:0 最大值:2147483647 project_id String 项目ID 最小长度:1 最大长度:128 表6 DataClassificationRuleQueryDTO 参数 参数类型 描述 uuid String 规则ID 最小长度:1 最大长度:128 rule_type String 规则类型, CUSTOM, BUILTIN 枚举值: CUSTOM BUILTIN secrecy_level String 密级 最小长度:1 最大长度:128 secrecy_level_num Long 密级层级 最小值:1 最大值:128 name String 规则名称 最小长度:1 最大长度:128 guid String guid 最小长度:1 最大长度:128 groups Array of DataClassificationGroupQueryDTO objects 规则组 数组长度:0 - 100 enable Boolean 规则是否开启 method String 规则方式, REGULAR, NONE, DEFAULT 枚举值: REGULAR NONE DEFAULT content_expression String 内容表达式 最小长度:1 最大长度:4096 column_expression String 列表达式 最小长度:1 最大长度:4096 commit_expression String 备注表达式 最小长度:1 最大长度:4096 project_id String 项目ID 最小长度:1 最大长度:128 description String 规则描述 最小长度:0 最大长度:4096 created_by String 策略创建人 最小长度:1 最大长度:128 created_at Long 策略创建时间 最小值:0 最大值:2147483647 updated_by String 策略更新人 最小长度:1 最大长度:128 updated_at Long 策略更新时间 最小值:0 最大值:2147483647 builtin_rule_id String 内置规则ID 最小长度:1 最大长度:128 category_id String 分类ID 最小长度:1 最大长度:128 instance_id String 实例ID 最小长度:1 最大长度:64 match_type String 匹配类型 最小长度:1 最大长度:128 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:128 error_msg String 错误描述 最小长度:1 最大长度:10240
  • URI GET /v1/{project_id}/security/data-classification/rule/group 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String project id 最小长度:1 最大长度:128 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer limit 最小值:0 最大值:100 offset 否 Integer offset 最小值:0 最大值:99999 name 否 String 规则组名称 最小长度:1 最大长度:128 creator 否 String 规则组创建者 最小长度:1 最大长度:128 desc 否 Boolean 排序规则 缺省值:true order_by 否 String 排序字段, createdAt, createdBy, updatedAt, updatedBy, name, description 枚举值: createdAt createdBy updatedAt updatedBy name description
  • 概述 心跳函数用于检测用户函数运行时的异常,例如以下场景: 用户函数死锁,无法正常运行。 用户函数内存溢出,无法正常运行。 用户函数网络异常,无法正常运行。 在配置了自定义心跳函数后,当用户函数运行时,FunctionGraph每隔5s向函数实例发送一次心跳请求,触发心跳函数。如果心跳请求返回异常,FunctionGraph会认为函数实例异常,终止此函数实例。 FunctionGraph心跳请求的超时时间是3s,如果连续6次心跳请求未响应,函数实例将被终止。
  • 响应示例 状态码: 200 Success { "slow_logs" : [ { "node_name" : "test_replica_node_1", "node_id" : "dfe41edcb2a1483c96ddf61cc0cee237no10", "database" : "testDB", "collection" : "testCollection", "whole_message" : "{\\\"responseLength\\\": 230, \\\"ts\\\": {\\\"$date\\\": 1605480486800}, \\\"ninserted\\\": 1, \\\"locks\\\": {\\\"oplog\\\": {\\\"acquireCount\\\": {\\\"w\\\": 1}}, \\\"Global\\\": {\\\"acquireCount\\\": {\\\"r\\\": 3, \\\"w\\\": 2}}, \\\"Collection\\\": {\\\"acquireCount\\\": {\\\"w\\\": 2}}, \\\"Database\\\": {\\\"acquireCount\\\": {\\\"w\\\": 3}}}, \\\"numYield\\\": 0, \\\"ns\\\": \\\"geographySpace.tiles\\\"}", "operate_type" : "query", "cost_time" : 60, "lock_time" : 10, "docs_returned" : 0, "docs_scanned" : 0, "log_time" : "2023-01-09T06:42:32.000+0000", "line_num" : "1595659490239433659" } ] }
  • 请求示例 POST https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/mongodb/instances/916de02c35fe4abaa3e707ebd916d3f8in10/slow-logs { "start_time" : "2021-01-06T10:41:14+0800", "end_time" : "2023-01-10T10:41:14+0800", "limit" : 100, "line_num" : "1595659490239433658", "operate_type" : "query", "node_id" : "dfe41edcb2a1483c96ddf61cc0cee237no10", "keywords" : [ "response", "oplog" ], "database_keywords" : [ "testDB", "system_auth" ], "collection_keywords" : [ "testCollection" ], "max_cost_time" : 100, "min_cost_time" : 50 }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 slow_logs Array of objects 慢日志具体信息。详情请参考表5。 表5 MongodbSlowLogDetail 参数 参数类型 描述 node_name String 节点名称。 node_id String 节点ID。 whole_message String 执行语句。 operate_type String 语句类型。 cost_time Integer 执行时间。单位:ms。 lock_time Integer 等待锁时间。单位:us。 docs_returned Integer 慢查询返回的文档数。 docs_scanned Integer 慢查询扫描的文档数。 database String 数据库库名。 collection String 数据库集合名称。 log_time String 日志产生时间,UTC时间。格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 line_num String 日志单行序列号。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 start_time 是 String 开始时间,格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。注:开始时间不得早于当前时间30天。 end_time 是 String 结束时间,格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。注:结束时间不能晚于当前时间。 limit 是 Integer 表示每次查询的日志条数,最大限制100条。 line_num 否 String 日志单行序列号,第一次查询时不需要此参数,下一次查询时需要使用,可从上一次查询的返回信息中获取。说明:当次查询从line_num的下一条日志开始查询,不包含当前line_num日志。 operate_type 否 String 语句类型,取空值,表示查询所有语句类型。 枚举值: insert query update remove getmore command killcursors node_id 否 String 节点ID,取空值,表示查询实例下所有允许查询的节点。具体取值请参考表10中的“id”。 keywords 否 Array of strings 根据多个关键字搜索日志全文,表示同时匹配所有关键字。 最多支持10个关键字。 每个关键字最大长度不超过512个字符。 database_keywords 否 Array of strings 根据多个数据库库名关键字模糊搜索日志,表示匹配至少一个关键字。 只支持关键字前缀模糊搜索,最多支持10个关键字。 每个关键字最大长度不超过64个字符。 collection_keywords 否 Array of strings 根据多个数据库集合名称关键字模糊搜索日志,表示匹配至少一个关键字。 只支持关键字前缀模糊搜索,最多支持10个关键字。 每个关键字最大长度不超过128个字符。 max_cost_time 否 Integer 支持根据最大执行时间范围查找日志。单位:ms。 min_cost_time 否 Integer 支持根据最小执行时间范围查找日志。单位:ms。
  • 响应示例 状态码: 200 Success { "slow_logs" : [ { "node_name" : "test_priam_node_1", "node_id" : "8b76c35e91eb4c9d82fe25417d750cb5no06", "keyspace" : "system", "table" : "test", "whole_message" : "GqKc6_S", "operate_type" : "select", "cost_time" : 60, "log_time" : "2023-01-09T05:42:32.000+0000", "line_num" : "1595659490239433659" } ] }
  • 请求示例 POST https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/cassandra/instances/853f97101a9a4f618202f281cda82e92in06/slow-logs { "start_time" : "2023-01-06T10:41:14+0800", "end_time" : "2023-01-10T10:41:14+0800", "limit" : 100, "line_num" : "1595659490239433658", "operate_type" : "select", "node_id" : "8b76c35e91eb4c9d82fe25417d750cb5no06", "keywords" : [ "log", "test" ], "keyspace_keywords" : [ "system", "system_auth" ], "table_keywords" : [ "test" ], "max_cost_time" : 100, "min_cost_time" : 50 }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 start_time 是 String 开始时间,格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。注:开始时间不得早于当前时间30天。 end_time 是 String 结束时间,格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。注:结束时间不能晚于当前时间。 limit 是 Integer 表示每次查询的日志条数,最大限制100条。 line_num 否 String 日志单行序列号,第一次查询时不需要此参数,下一次查询时需要使用,可从上一次查询的返回信息中获取。说明:当次查询从line_num的下一条日志开始查询,不包含当前line_num日志。 operate_type 否 String 语句类型,取空值,表示查询所有语句类型。取值:select node_id 否 String 节点ID,取空值,表示查询实例下所有允许查询的节点。具体取值请参考表10中的“id”。 keywords 否 Array of strings 根据多个关键字搜索日志全文,表示同时匹配所有关键字。 最多支持10个关键字。 每个关键字最大长度不超过512个字符。 keyspace_keywords 否 Array of strings 根据多个键空间关键字模糊搜索日志,表示匹配至少一个关键字。 只支持关键字前缀模糊搜索,最多支持10个关键字。 每个关键字最大长度不超过48个字符。 table_keywords 否 Array of strings 根据多个数据库表名关键字模糊搜索日志,表示匹配至少一个关键字。 只支持关键字前缀模糊搜索,最多支持10个关键字。 每个关键字最大长度不超过48个字符。 max_cost_time 否 Integer 支持根据最大执行时间范围查找日志。单位:ms。 min_cost_time 否 Integer 支持根据最小执行时间范围查找日志。单位:ms。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 slow_logs Array of objects 慢日志具体信息。详情请参考表5。 表5 CassandraSlowLogDetail 参数 参数类型 描述 node_name String 节点名称。 node_id String 节点ID。 whole_message String 执行语句。 operate_type String 语句类型。 cost_time Integer 执行时间。单位:ms keyspace String 数据库键空间。 table String 数据库表名。 log_time String 日志产生时间,UTC时间。格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 line_num String 日志单行序列号。
  • 响应示例 状态码: 200 Success { "error_logs" : [ { "node_name" : "test_replica_node_1", "node_id" : "dfe41edcb2a1483c96ddf61cc0cee237no10", "raw_message" : "W TEST [test001] test error log", "severity" : "Warning", "log_time" : "2023-01-09T12:55:39.398+0000", "line_num" : "1595659490239433659" } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 error_logs Array of objects 错误日志具体信息。详情请参考表5。 表5 MongodbErrorLogDetail 参数 参数类型 描述 node_name String 节点名称。 node_id String 节点ID。 raw_message String 描述信息。 severity String 日志级别。 log_time String 日志产生时间,UTC时间。格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 line_num String 日志单行序列号。
  • 请求示例 POST https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/mongodb/instances/916de02c35fe4abaa3e707ebd916d3f8in10/error-logs { "start_time" : "2023-01-06T10:41:14+0800", "end_time" : "2023-01-10T10:41:14+0800", "limit" : 100, "line_num" : "1595659490239433658", "severity" : "Warning", "node_id" : "dfe41edcb2a1483c96ddf61cc0cee237no10", "keywords" : [ "error" ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 start_time 是 String 开始时间,格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 注:开始时间不得早于当前时间30天。 end_time 是 String 结束时间,格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 注:结束时间不能晚于当前时间。 limit 是 Integer 表示每次查询的日志条数,最大限制100条。 line_num 否 String 日志单行序列号,第一次查询时不需要此参数,下一次查询时需要使用,可从上一次查询的返回信息中获取。说明:当次查询从line_num的下一条日志开始查询,不包含当前line_num日志。 severity 否 String 日志级别,取空值,表示查询所有日志级别的日志。 枚举值: Warning Error node_id 否 String 节点ID,取空值,表示查询实例下所有允许查询的节点。具体取值请参考表10中的“id”。 keywords 否 Array of strings 根据多个关键字搜索日志全文,表示同时匹配所有关键字。 最多支持10个关键字。 每个关键字最大长度不超过512个字符。
  • URI GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/databases 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置偏移量。 索引位置偏移量,表示从指定project ID下最新的专属资源创建时间开始,按时间的先后顺序偏移offset条数据后查询对应的专属资源信息。 取值大于或等于0。 不传该参数时,查询偏移量默认为0,表示从最新的创建时间对应的专属资源开始查询。 limit 否 Integer 查询专属资源个数上限值。 取值范围:1~100。不传该参数时,默认查询前100条实例信息。
  • URI GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/tables 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 database_name 是 String 数据库名。 offset 否 Integer 索引位置偏移量。 索引位置偏移量,表示从指定project ID下最新的专属资源创建时间开始,按时间的先后顺序偏移offset条数据后查询对应的专属资源信息。 取值大于或等于0。 不传该参数时,查询偏移量默认为0,表示从最新的创建时间对应的专属资源开始查询。 limit 否 Integer 查询专属资源个数上限值。 取值范围:1~100。不传该参数时,默认查询前100条实例信息。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data Array of objects 分页查询的数据。 page_info Object 分页信息。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String AOM .30005001 error_msg String 参数错误 状态码: 403 表6 响应Body参数 参数 参数类型 描述 error_code String AOM.30001005 error_msg String 没有权限
  • 响应示例 状态码: 200 资源关联返回的信息 { "data" : [ { "id" : "7015d303a8454f49a289dd47ada4b60c", "resource_id" : "aom_7015d303a8454f49a289dd47ada4b60c", "resource_name" : "luban121000000333", "resource_region" : "xxx", "env_ids" : [ "63c2195e9da846258b113205184b2b53" ], "topology" : [ { "app_id" : "07f6836530e24efdab068aacef933d4b", "app_name" : "test91", "sub_app_id" : "b554711fb4774bf98cfbdfa955a2d640", "sub_app_name" : "sub-888", "component_id" : "b218263a62554ad6aa976908e4990cf3", "component_name" : "组件99", "env_id" : "63c2195e9da846258b113205184b2b53", "env_name" : "环境22", "env_region" : "xxx", "os_type" : "LINUX" } ], "status" : "ACTIVE", "cloud_vendors" : "His", "agent_state" : "UNINSTALLED", "vpc_id" : " 6681507e-779e-4d0d-9421-5df07b95cca6 ", "addresses" : [ { "host_ip" : "117.1.0.1", "ip_type" : "fixed", "ip_version" : 4, "mac" : null }, { "host_ip" : "179.1.0.1", "ip_type" : "floating", "ip_version" : 4, "mac" : null } ] }, { "id" : "2c6fd895c88742559f2fd6c57817cf93", "resource_id" : "aom_2c6fd895c88742559f2fd6c57817cf93", "env_ids" : [ "63c2195e9da846258b113205184b2b53" ], "topology" : [ { "app_id" : "07f6836530e24efdab068aacef933d4b", "app_name" : "test91", "sub_app_id" : "b554711fb4774bf98cfbdfa955a2d640", "sub_app_name" : "sub-888", "component_id" : "b218263a62554ad6aa976908e4990cf3", "component_name" : "组件99", "env_id" : "63c2195e9da846258b113205184b2b53", "env_name" : "环境22", "env_region" : "xxx", "os_type" : "LINUX" } ], "cloud_vendors" : "His", "agent_state" : "UNINSTALLED", "addresses" : [ { "host_ip" : "1.3.4.5", "ip_type" : "fixed", "ip_version" : 4, "mac" : null } ] } ], "page_info" : { "next_marker" : null, "current_count" : 2 } }
  • 请求示例 获取节点下资源列表 https://{Endpoint}/v1/resource/{rf_resource_type}/type/{type}/ci-relationships { "ci_ids" : [ "63c2195e9da846258b113205184b2b53" ], "ci_relationships" : true, "ci_type" : "environment" }
  • 响应示例 状态码: 200 请求响应成功,返回指定任务的执行历史。 [ { "approve_user_name_list" : [ ], "begin_time" : 1600000000, "create_by" : "xxx", "end_time" : 1600000000, "execution_id" : "xxxx", "execution_result_list" : [ { "begin_time" : 16000000, "end_time" : 160000000, "function_execution_id" : "xxxxx", "node_id" : "delete-workload-pod", "output" : { "fail" : [ ], "in_execution" : [ ], "success" : [ { "app" : "xxxxxx", "code" : "0", "matchLabels" : "{\"app\":\"xxxxx\",\"version\":\"xxxx\"}", "current_project" : true, "log" : "Restart Success.", "replicas" : 1, "cmdb_work_load_id" : "xxxxxxx", "type" : "manual", "availableReplicas" : 0, "execute_time" : "35505", "creationTimestamp" : " ", "name" : "xxxxxx", "namespace" : "default", "cceWorkloadCluster" : "xxxxxx", "id" : "xxxxx", "cceWorkloadType" : "deployments" } ], "not_performed" : [ ] }, "status" : "success" } ], "project_id" : "xxxxxxx", "status" : "success", "workflowEditTime" : 0, "workflow_id" : "xxxxxxx" } ] 状态码: 401 Unauthorized。在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 { "error_code" : "AOM.31009004", "error_message" : "auth failed.", "http_code" : "401" } 状态码: 500 InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 { "error_code" : "AOM.31001405", "error_msg" : "execution internal server error.", "http_code" : 500 }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 [数组元素] Array of WorkflowExecutionBrief objects 请求响应成功,返回指定任务的执行历史。 表5 WorkflowExecutionBrief 参数 参数类型 描述 workflow_id String 流程定义ID 最小长度:1 最大长度:64 execution_id String 流程执行实例ID 最小长度:1 最大长度:64 status String 流程实例执行状态 最小长度:1 最大长度:32 begin_time Long 流程实例创建时间,格式:UTC时间戳 最小值:0 最大值:9999999999999 end_time Long 流程实例结束时间,格式:UTC时间戳 最小值:0 最大值:9999999999999 last_update_time Long 流程实例上次更新时间,格式:UTC时间戳 最小值:0 最大值:9999999999999 created_by String 流程实例创建者 最小长度:1 最大长度:32 approve_user_name_list Array of strings 审批人列表 最小长度:1 最大长度:128 数组长度:0 - 200 execution_result_list Array of execution_result_list objects 执行记录 数组长度:1 - 200 project_id String 租户从 IAM 申请到的projectid,一般为32位字符串。 最小长度:32 最大长度:32 workflow_edit_time Long 执行工作流的修改时间,格式:UTC时间戳 最小值:0 最大值:9999999999999 last_record_id_with_snapshot String 执行快照 最小长度:1 最大长度:64 表6 execution_result_list 参数 参数类型 描述 node_id String 流程节点ID。 最小长度:1 最大长度:64 begin_time Long 节点开始执行时间。 最小值:0 最大值:9999999999999 end_time Long 节点执行结束时间。 最小值:0 最大值:9999999999999 function_execution_id String FunctionGraph的执行id。 最小长度:1 最大长度:64 output Object 节点输出。 status String 节点状态。 最小长度:1 最大长度:32 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String 响应码。 最小长度:1 最大长度:64 error_msg String 调用失败响应信息描述。 最小长度:1 最大长度:1024 http_code Integer http返回码 最小值:0 最大值:999 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 响应码。 最小长度:1 最大长度:64 error_msg String 调用失败响应信息描述。 最小长度:1 最大长度:1024 http_code Integer http返回码 最小值:0 最大值:999
  • URI GET /v1/{project_id}/cms/workflow/{workflow_id}/executions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户从IAM申请到的projectid,一般为32位字符串。 最小长度:32 最大长度:32 workflow_id 是 String 任务id,从工作流命令列表中获取的工作流id。 最小长度:1 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 x_enterprise_project_id 否 String 所属的企业项目id。 缺省值:0 最小长度:1 最大长度:64
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 workflow_id String 流程定义ID。 最小长度:1 最大长度:64 execution_id String 流程执行实例ID。 最小长度:1 最大长度:64 status String 流程实例执行状态。 最小长度:1 最大长度:32 begin_time Long 流程实例创建时间,格式:UTC时间戳 最小值:0 最大值:9999999999999 end_time Long 流程实例结束时间,格式:UTC时间戳 最小值:0 最大值:9999999999999 last_update_time Long 流程实例上次更新时间,格式:yyyy-MM-ddTHH:mm:ssZ,UTC时间。 最小值:0 最大值:9999999999999 execution_result_list Array of execution_result_list objects 节点执行信息。 数组长度:0 - 200 approve_user_name_list Array of strings 审批用户列表 最小长度:1 最大长度:256 数组长度:0 - 200 project_id String 租户从IAM申请到的projectid,一般为32位字符串。 最小长度:32 最大长度:32 workflow_edit_time Long 执行workflow的更新时间 最小值:0 最大值:9999999999999 last_record_id_with_snapshot String 执行快照 最小长度:1 最大长度:128 表4 execution_result_list 参数 参数类型 描述 node_id String 流程节点ID。 最小长度:1 最大长度:64 begin_time Long 节点开始执行时间。 最小值:0 最大值:9999999999999 end_time Long 节点执行结束时间。 最小值:0 最大值:9999999999999 function_execution_id String FunctionGraph的执行id。 最小长度:1 最大长度:64 output Object 节点输出。 status String 节点状态。 最小长度:1 最大长度:32 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 响应码。 最小长度:1 最大长度:64 error_msg String 调用失败响应信息描述。 最小长度:1 最大长度:1024 http_code Integer http返回码 最小值:0 最大值:999 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 响应码。 最小长度:1 最大长度:64 error_msg String 调用失败响应信息描述。 最小长度:1 最大长度:1024 http_code Integer http返回码 最小值:0 最大值:999 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 响应码。 最小长度:1 最大长度:64 error_msg String 调用失败响应信息描述。 最小长度:1 最大长度:1024 http_code Integer http返回码 最小值:0 最大值:999
  • URI GET /v1/{project_id}/cms/workflow/{workflow_id}/executions/{execution_id}/status 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户从IAM申请到的projectid,一般为32位字符串。 最小长度:32 最大长度:32 workflow_id 是 String 工作流ID,唯一标识,根据project_id和workflow_name生成。 最小长度:1 最大长度:64 execution_id 是 String 工作流执行ID。 最小长度:1 最大长度:64
共100000条