华为云用户手册

  • 请求消息 请求参数 参数 是否必选 参数类型 取值范围 描述 customer_id 是 String [1-64] 企业子账号的客户ID。您可以调用查询企业子账号列表接口,获取响应参数“id”的返回值。 amount 是 String [1-32] 总划拨金额。单位为元。 单位:元。取值大于0且精确到小数点后2位。 coupon_id 是 String [1-64] 优惠券ID。您可以调用查询企业主账号可拨款优惠券列表接口,获取响应参数“coupon_id”的返回值。 trans_id 否 String [0-32] 交易序列号,用于防止重复提交。 如果接口调用方不传此参数的值,则系统自动生成。 如果接口调用方传入此参数的值,请采用UUID保证全局唯一。 此参数不携带或携带值为null或携带值为空串时,由系统自动生成。 请求示例 POST https://bss.myhuaweicloud.com/v2/enterprises/multi-accounts/transfer-coupon HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ { "customer_id": "06a29c********400fc0c01027684d40", "amount": "100.00", "trans_id": "2020042401", "coupon_id": "CP19092406014086E3" }
  • 调用函数 在浏览器地址栏输入APIG触发器的调用地址URL,按“Enter”。 函数执行完毕,得到返回结果,如图3所示。 图3 返回结果 FunctionGraph函数对APIG调用的传入值为函数自带的事件模板,您可以参见表2。 FunctionGraph函数对来自APIG调用的返回结果进行了封装,APIG触发器要求函数的返回结果中必须包含body(String)、statusCode(int)、headers(Map)和isBase64Encoded(boolean),才可以正确返回。
  • 创建函数 登录函数工作流控制台,在左侧的导航栏选择“函数模板”。 在“函数模板”界面,“云服务”选择“函数工作流”,模板选择Python 2.7的“context使用指导”,单击“使用模板”。 此处以Python 2.7的“context使用指导”举例,请您根据实际需求选择模板。 选择函数模板后,会加载模板内置的代码、配置信息,进入到“创建函数”界面。 输入函数名称“context”,选择已创建的委托,其他设置保持不变,单击“创建函数”,进入配置详情页。 若不配置委托,在触发函数时,执行结果会返回 Failed to access other services because no temporary AK, SK, or token has been obtained. Please set an agency. 请您根据实际业务进行参数配置。
  • 总览页面介绍 登录FunctionGraph控制台,在左侧导航栏选择“总览”,进入“总览”页面。 可以查看函数数量/配额信息、代码存储/存储配额、函数月度调用次数/月度资源用量。 图2 月度统计 可以查看租户层面的监控信息:调用次数、调用数TOP10、错误次数、错误数TOP10、运行时间、被拒绝次数。 运行监控指标说明如表1所示。 表1 监控指标说明表 指标 单位 说明 调用次数 次 函数总的调用请求数,包含了错误和被拒绝的调用。异步调用在该请求实际被系统执行时才开始计数。 调用数TOP10 - 展示指定时间范围内(最近1天/最近3天/自定义)的函数调用数TOP10。 运行时间 毫秒 最大运行时间为某统计粒度(周期)下,即某一时间段内所有函数单次执行最大的运行时间。 最小运行时间为某统计粒度(周期)下,即某一时间段内所有函数单次执行最小的运行时间。 平均运行时间为某统计粒度(周期)下,即某一时间段内所有函数单次执行平均的运行时间。 错误次数 次 指发生异常请求的函数不能正确执行完并且返回200,都计入错误次数。函数自身的语法错误或自身执行错误也会计入该指标。 错误数TOP10 - 展示指定时间范围内(最近1天/最近3天/自定义)的函数错误数TOP10。 被拒绝次数 次 由于并发请求太多,系统流控而被拒绝的请求次数。 可以查看函数流指标:调用次数、运行时间、错误次数、运行中 指标 单位 说明 调用次数 次 函数流总的调用请求数,包含了正确、错误和运行中的调用。异步函数流在请求被系统执行时才开始计数。 运行时间 毫秒 时间段内单次函数流执行平均的运行时间。 错误次数 次 指发生异常请求的函数流不能正确执行完,会计入错误次数。 运行中 个 正在运行中的函数流的数量。
  • 函数使用流程 函数使用流程如图1所示。 用户编写业务程序代码,打包上传至FunctionGraph函数,添加事件源(如SMN、OBS和APIG等),完成应用程序构建部署。 通过RESTful API或者云产品事件源触发函数,生成函数实例,实现业务功能,函数在运行过程中的资源调度由FunctionGraph来管理。 用户可以查看函数运行日志和监控信息,按照代码运行情况收费,代码未运行时不产生费用。 图1 函数使用流程 说明如下: 编写代码 用户编写代码,目前支持Node.js、Python、Java、Go、C#、PHP等语言,详情请参见开发指南。 上传代码 上传代码,目前支持在线编辑、上传ZIP或JAR包,从OBS引用ZIP包等,详情请参见创建程序包。 API和云产品事件源触发函数执行 通过API和云产品事件源触发函数执行,触发方法请参见配置触发器。 弹性执行 函数在执行过程中,会根据请求量弹性扩容,支持请求峰值的执行,此过程用户无需配置,由FunctionGraph完成,并发数限制请参见使用限制。 查看日志 FunctionGraph函数实现了与云日志服务的对接,您无需配置,即可查看函数运行日志信息,请参见日志。 查看监控 FunctionGraph函数实现了与云监控服务的对接,您无需配置,即可查看图形化监控信息,请参见指标。 计费方式 函数执行结束后,根据函数请求执行次数和执行时间计费,查看费用详情请参见费用账单。
  • 概述 心跳函数用于检测用户函数运行时的异常,例如以下场景: 用户函数死锁,无法正常运行。 用户函数内存溢出,无法正常运行。 用户函数网络异常,无法正常运行。 在配置了自定义心跳函数后,当用户函数运行时,FunctionGraph每隔5s向函数实例发送一次心跳请求,触发心跳函数。如果心跳请求返回异常,FunctionGraph会认为函数实例异常,终止此函数实例。 FunctionGraph心跳请求的超时时间是3s,如果连续6次心跳请求未响应,函数实例将被终止。
  • 响应参数 状态码: 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 日志单行序列号。
  • 响应示例 状态码: 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 }
  • 请求参数 表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。
  • 请求示例 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 }
  • 响应示例 状态码: 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" } ] }
  • 请求参数 表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 日志单行序列号。
  • 请求示例 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" ] }
  • 响应示例 状态码: 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 日志单行序列号。
  • 请求参数 表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条实例信息。
  • 请求示例 获取节点下资源列表 https://{Endpoint}/v1/resource/{rf_resource_type}/type/{type}/ci-relationships { "ci_ids" : [ "63c2195e9da846258b113205184b2b53" ], "ci_relationships" : true, "ci_type" : "environment" }
  • 响应参数 状态码: 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 } }
  • 响应参数 状态码: 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
  • 响应示例 状态码: 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 }
  • 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
  • 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
  • 响应参数 状态码: 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
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 elements Array of ScriptVersion objects 查询结果集合。 数组长度:0 - 9999999 total_elements Integer 查询到的结果数量。 最小值:0 最大值:9999999 表5 ScriptVersion 参数 参数类型 描述 content String 脚本内容,脚本内容不能为空 最小长度:1 最大长度:30000 create_by String 创建人,比如为:张三 最小长度:1 最大长度:64 create_time Long 创建时间 最小值:0 最大值:9999999999999 enterprise_project_id String 企业项目id 最小长度:1 最大长度:64 name String 脚本名称,支持数字,下划线,大小写字母 ,中文 最小长度:1 最大长度:64 project_id String 租户从IAM申请到的projectid,一般为32位字符串 最小长度:32 最大长度:32 job_reference_number Integer 脚本版本的引用次数,脚本版本被作业引用的次数。默认是0次,引用次数为非负整数,不能出现负数 最小值:0 最大值:9999999 script_id String 脚本id,根据UUID.randomUUID生成。 最小长度:1 最大长度:64 script_language String 脚本语言,目前支持四种,分别是:SHELL BAT PYTHON POWER_SHELL 最小长度:1 最大长度:32 status_desc Integer 状态说明 0代表 未上线,1代表已上线 2代表已下线 3代表已禁用 最小值:0 最大值:4 update_by String 修改人 最小长度:1 最大长度:64 update_time Long 实体的最后更新时间戳。 注意:执行创建/修改/删除操作时,update_time将更新。 最小值:0 最大值:9999999999999 version_id String 版本id,根据UUID.randomUUID生成。 最小长度:1 最大长度:64 version_number String 脚本版本号,支持数字,下划线,大小写字母和小数点 最小长度:1 最大长度:64 job_reference_name Array of ReferenceInfo objects 脚本引用的作业详情 数组长度:0 - 9999999 表6 ReferenceInfo 参数 参数类型 描述 job_id String 作业ID。 最小长度:1 最大长度:64 job_name String 作业名称。 最小长度:1 最大长度:64 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 响应码。 最小长度:1 最大长度:32 error_msg String 调用失败响应信息描述。 最小长度:1 最大长度:1024 http_code Integer Http返回码 最小值:1 最大值:999 状态码: 401 表8 响应Body参数 参数 参数类型 描述 error_code String 响应码。 最小长度:1 最大长度:32 error_msg String 调用失败响应信息描述。 最小长度:1 最大长度:1024 http_code Integer Http返回码 最小值:1 最大值:999 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 响应码。 最小长度:1 最大长度:32 error_msg String 调用失败响应信息描述。 最小长度:1 最大长度:1024 http_code Integer Http返回码 最小值:1 最大值:999
  • 请求示例 查询指定script_id下脚本版本信息。 POST https://{Endpoint}/v1/{project_id}/cms/script-version-list { "script_id" : "xxxxxxxxxx", "page_num" : 1, "page_size" : 10, "order_by_column" : "update_time", "sort_order" : "ASC" }
共100000条