华为云用户手册

  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 id String 事件模型版本ID schema_id String 事件模型ID version Integer 事件模型版本号 format String 事件模型格式 created_time String 创建时间 updated_time String 更新时间 definition String 事件模型内容定义
  • 响应示例 状态码:200 详情 { "id" : "2a0ee4f2-78a4-4122-80af-7455e37f64ee", "name" : "file.upload", "description" : "文件上传事件模型定义", "compatibility" : "NONE", "provider_type" : "CUSTOM", "format" : "OPENAPI_3_0", "number_of_versions" : 1, "created_time" : "2021-12-09 09:00:00", "updated_time" : "2021-12-09 09:00:00", "version" : 1, "definition" : "{\"$schema\": \"http://json-schema.org/draft-06/schema#\",\"title\": \"fileUpload\",\"definitions\": {\"fileUpload\": {\"properties\": {\"fileName\": {\"type\": \"string\"},\"fileSize\": {\"type\": \"integer\"}},\"required\": [\"foo\",\"bar\"],\"type\": \"object\"}},\"properties\": {\"specversion\": {\"type\": \"string\"},\"id\": {\"type\": \"string\"},\"type\": {\"type\": \"string\"},\"source\": {\"type\": \"string\"},\"subject\": {\"type\": \"string\"},\"datacontenttype\": {\"type\": \"string\"},\"dataschema\": {\"type\": \"string\"},\"time\": {\"format\": \"date-time\",\"type\": \"string\"},\"data\": {\"$ref\": \"#/definitions/fileUpload\"}},\"required\": [\"id\",\"source\",\"time\",\"type\",\"specversion\"],\"type\": \"object\"}" }
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 id String 事件模型ID name String 事件模型名称,租户下唯一 description String 事件模型描述 compatibility String 事件模型兼容性 provider_type String 提供方类型,OFFICIAL:官方事件源;CUSTOM:自定义事件源 format String 事件模型格式 number_of_versions Integer 事件模型版本数 created_time String 创建时间 updated_time String 更新时间 version Integer 事件模型当前版本号 definition String 事件模型内容定义
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 id String 事件源ID name String 目标连接名称,租户下唯一,由小写字母、数字、点、下划线和中划线组成,必须以字母或数字开头,不能为default description String 目标连接描述 status String 目标连接状态 error_info ErrorInfo object 错误信息 vpc_id String 待连接的VPC ID subnet_id String 待连接的子网ID agency String 私网目标连接使用的用户委托名称 flavor flavor object 规格 type String 目标连接类型。目前支持webhook:http连接;kafka:华为云官方kafka实例 kafka_detail KafkaConnectionDetail object kafka连接参数 created_time String 创建UTC时间 updated_time String 更新UTC时间 表4 ErrorInfo 参数 参数类型 描述 error_code String 错误码 error_detail String 错误详情 error_msg String 错误信息 表5 flavor 参数 参数类型 描述 name String 规格名称 concurrency_type String 并发规格类型 concurrency Integer 并发数 bandwidth_type String 带宽类型 表6 KafkaConnectionDetail 参数 参数类型 描述 instance_id String kafka实例id。 addr String kafka连接地址。 security_protocol String 安全协议。 enable_sasl_ssl Boolean kafka实例是否开启了SASL_SSL。 user_name String kafka实例用户名。实例开启了SASL_SSL时必填 password String kafka实例密码。实例开启了SASL_SSL时必填 acks String 收到Server端确认信号个数,表示procuder需要收到多少个这样的确认信号,算消息发送成功。acks参数代表了数据备份的可用性。支持选项: acks=0:表示producer不需要等待任何确认收到的信息,副本将立即加到socket buffer并认为已经发送。没有任何保障可以保证此种情况下server已经成功接收数据,同时重试配置不会发生作用(因为客户端不知道是否失败)回馈的offset会总是设置为-1。 acks=1:这意味着至少要等待leader已经成功将数据写入本地log,但是并没有等待所有follower是否成功写入。如果follower没有成功备份数据,而此时leader又无法提供服务,则消息会丢失。 acks=all:这意味着leader需要等待ISR中所有备份都成功写入日志,只有任何一个备份存活,数据都不会丢失。min.insync.replicas指定必须确认写入才能被认为成功的副本的最小数量。
  • 响应示例 状态码:200 详情 { "id" : "90e0b962-c6c1-438c-ba8a-3024fe592bda", "name" : "private-link", "description" : "", "status" : "CREATING", "error_info" : { }, "vpc_id" : "ac14144e-8fec-53d6-bdfd-8f09b52c09iu", "subnet_id" : "bf14153e-5fec-67d6-b89d-5409b52c0op8", "agency" : "EG_TRUST", "flavor" : { "name" : "default", "concurrency_type" : "exclusive", "concurrency" : 500, "bandwidth_type" : "exclusive" }, "type" : { }, "kafka_detail" : { }, "created_time" : "2021-12-09 09:00:00", "updated_time" : "2021-12-09 09:00:00" }
  • 响应示例 状态码:200 详情 { "id" : "bd14144e-8f3c-43d6-bdfd-bf09b52c2b96", "name" : "channel", "description" : "first channel", "provider_type" : "CUSTOM", "created_time" : "2021-12-09 09:00:00", "updated_time" : "2021-12-09 09:00:00", "enterprise_project_id" : "string" }
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 id String 通道ID name String 通道名称 description String 通道描述 provider_type String 通道提供方类型,OFFICIAL:官方事件通道;CUSTOM:自定义事件通道;PARTNER:伙伴事件通道 created_time String 创建UTC时间 updated_time String 更新UTC时间 enterprise_project_id String 企业项目id
  • 响应参数 状态码:200 表4 响应Header参数 参数 参数类型 描述 X-Request-Id String This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. 表5 响应Body参数 参数 参数类型 描述 eventStreamingID String 事件流ID
  • 请求示例 翻新obs桶名为obs1的fg触发器,创建为EG订阅 POST https://{eg_endpoint}/v1/{project_id}/subscriptions/obsbuckets/obs1/refurbishobs { "agency_name" : "string", "id" : "string", "transform" : { "type" : "VARIABLE", "value" : "{\"contant_boolean\": true,\"contant_string\": \"constant\",\"varaible_string\": \"$.data.string\",\"varaible_json_object\": \"$.data.object\"}", "template" : "{\"contant_boolean\": ${contant_boolean},\"contant_string\": \"${contant_string!\\\"default\\\"}\",\"varaible_string\": \"${contant_boolean}\",\"varaible_json_object\": ${varaible_json_object!\"null\"}}" } }
  • 响应示例 状态码:200 翻新FG后所创建订阅 { "id" : "23709d68-54d5-423b-a6be-03302e893152", "name" : "test-subscription", "description" : "this is a test subscription", "type" : "EVENT", "status" : "CREATED", "channel_id" : "05649f9a-b324-4920-9c49-156d4cd2e546", "channel_name" : "channel006", "used" : [ { } ], "sources" : [ { } ], "targets" : [ { } ], "created_time" : "2021-12-09 09:00:00", "updated_time" : "2021-12-09 09:00:00" }
  • 响应参数 状态码:200 表5 响应Body参数 参数 参数类型 描述 id String 订阅ID name String 订阅名称 description String 订阅描述 type String 类型 status String 状态 channel_id String 通道ID channel_name String 通道名称 used Array of SubscriptionUsedInfo objects 标签信息 sources Array of SubscriptionSourceInfo objects 订阅源列表 targets Array of SubscriptionTargetInfo objects 订阅目标列表 created_time String 创建时间 updated_time String 更新时间 表6 SubscriptionUsedInfo 参数 参数类型 描述 resource_id String 关联资源ID owner String 管理租户账号 description String 描述 表7 SubscriptionSourceInfo 参数 参数类型 描述 id String 订阅源ID name String 订阅的事件源名称 provider_type String 订阅的事件源的提供方类型 detail Object 订阅的事件源参数列表 filter Object 订阅事件源的匹配过滤规则 created_time String 创建时间 updated_time String 更新时间 表8 SubscriptionTargetInfo 参数 参数类型 描述 id String 订阅目标ID name String 订阅的事件目标名称 provider_type String 订阅的事件目标的提供方类型 connection_id String 订阅的事件目标使用的目标链接ID detail Object 订阅的事件目标参数列表 kafka_detail KafkaTargetDetail object 订阅的kafka事件目标参数列表,该字段序列化后总长度不超过1024字节 smn_detail SmnTargetDetail object 订阅的 SMN 事件目标参数列表,该字段序列化后总长度不超过1024字节 eg_detail EgTargetDetail object 订阅的事件eg通道目标参数列表,该字段序列化后总长度不超过1024字节,eg通道目标必填 apigw_detail ApigwTargetDetail object 订阅的事件APIGWurl目标参数列表,该字段序列化后总长度不超过1024字节,APIGW目标必填 retry_times Integer 重试次数 transform TransForm object 订阅的事件目标转换规则 dead_letter_queue DeadLetterQueue object 订阅的死信参数列表 created_time String 创建时间 updated_time String 更新时间 表9 KafkaTargetDetail 参数 参数类型 描述 topic String 主题 keyTransform keyTransform object 键值规则 表10 keyTransform 参数 参数类型 描述 type String 键值规则类型 value String 键值规则,键值规则为VARIABLE,CONSTANT时必填 template String 键值规则模板,键值规则为VARIABLE时必填 表11 SmnTargetDetail 参数 参数类型 描述 urn String 主题urn agency_name String 委托名称 subject_transform subject_transform object 标题规则 表12 subject_transform 参数 参数类型 描述 type String 标题规则类型 value String 标题规则 template String 标题规则模板,键值规则为VARIABLE时必填 表13 EgTargetDetail 参数 参数类型 描述 target_project_id String 目标项目id target_channel_id String 目标通道id target_region String 目标region cross_region Boolean 跨region开关 cross_account Boolean 跨账号开关 agency_name String 委托名称 表14 ApigwTargetDetail 参数 参数类型 描述 url String 目标url invocation_http_parameters InvocationHttpParameters object 调用Http的参数 表15 InvocationHttpParameters 参数 参数类型 描述 header_parameters Array of HeaderParameter objects 对象列表 表16 HeaderParameter 参数 参数类型 描述 is_value_secret Boolean 是否加密 key String header的key值 value String deader的value值 表17 TransForm 参数 参数类型 描述 type String 转换规则类型 value String 常量类型规则时,字段为常量内容定义; 变量类型规则时,为变量定义,内容必须为JsonObject字符串。 变量最多支持100个,且不支持嵌套结构定义; 变量名由字母、数字、点、下划线和中划线组成,必须字母或数字开头不能以HC.开头,长度不超过64个字符; 变量值表达式支持常量或JsonPath表达式,字符串长度不超过1024个字符。 template String 变量类型规则时,规则内容的模板定义,支持对已定义变量的引用。 表18 DeadLetterQueue 参数 参数类型 描述 type String 队列类型 instance_id String 实例id connection_id String 目标连接id topic String 主题
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 agency_name 是 String 委托名称 id 是 String 需要翻新的触发器id transform 是 TransForm object 订阅的事件目标转换规则 表4 TransForm 参数 是否必选 参数类型 描述 type 是 String 转换规则类型 value 否 String 常量类型规则时,字段为常量内容定义; 变量类型规则时,为变量定义,内容必须为JsonObject字符串。 变量最多支持100个,且不支持嵌套结构定义; 变量名由字母、数字、点、下划线和中划线组成,必须字母或数字开头不能以HC.开头,长度不超过64个字符; 变量值表达式支持常量或JsonPath表达式,字符串长度不超过1024个字符。 template 否 String 变量类型规则时,规则内容的模板定义,支持对已定义变量的引用。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 events 否 Array of CloudEvents objects CloudEvents事件格式定义,参考https://github.com/cloudevents/spec/blob/v1.0.1/spec.md 表4 CloudEvents 参数 是否必选 参数类型 描述 id 是 String 事件唯一标识串,同一个事件来源里必须唯一 source 是 String 事件来源上下文标识串,source+id可以唯一确定一个事件。采用URI-Reference格式,参考https://tools.ietf.org/html/rfc3986#section-4.1 specversion 是 String CloudEvents协议版本,格式为major.minor type 是 String 事件类型 datacontenttype 否 String 事件内容格式,采用MIME格式,遵循RFC2046,参考https://tools.ietf.org/html/rfc2046 dataschema 否 String 事件内容模型定义的URI,遵循RFC3986,参考https://tools.ietf.org/html/rfc3986#section-4.3 data 否 Object 事件的负载内容,采用datacontenttype字段指定的格式,内容字段遵循dataschema字段的描述 time 否 String 事件发生UTC日期时间,相同来源的事件格式相同,遵循RFC3339,格式需满足2018-04-05T17:31:00Z,参考https://tools.ietf.org/html/rfc3339 subject 否 String 事件发生的主题或对象,用以标识哪个具体对象发生了当前事件
  • 响应参数 状态码:200 表5 响应Header参数 参数 参数类型 描述 X-Request-Id String This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. 表6 响应Body参数 参数 参数类型 描述 failed_count Integer 发布失败的事件个数 events Array of events objects 事件列表 表7 events 参数 参数类型 描述 error_code String 发布失败的错误码 error_msg String 发布失败的原因 event_id String 事件唯一标识串
  • 请求示例 发布官方事件到事件通道 POST https://{endpoint}/v1/{project_id}/official/sources/{source_name}/events { "events" : [ { "id" : "id", "source" : "source", "specversion" : "specversion", "type" : "blob_created" } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 events 否 Array of CloudEvents objects CloudEvents事件格式定义,参考https://github.com/cloudevents/spec/blob/v1.0.1/spec.md 表4 CloudEvents 参数 是否必选 参数类型 描述 id 是 String 事件唯一标识串,同一个事件来源里必须唯一 source 是 String 事件来源上下文标识串,source+id可以唯一确定一个事件。采用URI-Reference格式,参考https://tools.ietf.org/html/rfc3986#section-4.1 specversion 是 String CloudEvents协议版本,格式为major.minor type 是 String 事件类型 datacontenttype 否 String 事件内容格式,采用MIME格式,遵循RFC2046,参考https://tools.ietf.org/html/rfc2046 dataschema 否 String 事件内容模型定义的URI,遵循RFC3986,参考https://tools.ietf.org/html/rfc3986#section-4.3 data 否 Object 事件的负载内容,采用datacontenttype字段指定的格式,内容字段遵循dataschema字段的描述 time 否 String 事件发生UTC日期时间,相同来源的事件格式相同,遵循RFC3339,格式需满足2018-04-05T17:31:00Z,参考https://tools.ietf.org/html/rfc3339 subject 否 String 事件发生的主题或对象,用以标识哪个具体对象发生了当前事件
  • 响应参数 状态码:200 表5 响应Header参数 参数 参数类型 描述 X-Request-Id String This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. 表6 响应Body参数 参数 参数类型 描述 failed_count Integer 发布失败的事件个数 events Array of events objects 事件列表 表7 events 参数 参数类型 描述 error_code String 发布失败的错误码 error_msg String 发布失败的原因 event_id String 事件唯一标识串
  • 请求示例 发布事件到事件通道 POST https://{endpoint}/v1/{project_id}/channels/{channel_id}/events { "events" : [ { "id" : "id", "source" : "source", "specversion" : "specversion", "type" : "blob_created" } ] }
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数 size Integer 本页数量 items Array of SubscriptionInfo objects 对象列表 表5 SubscriptionInfo 参数 参数类型 描述 id String 订阅ID name String 订阅名称 description String 订阅描述 type String 类型 status String 状态 channel_id String 通道ID channel_name String 通道名称 used Array of SubscriptionUsedInfo objects 标签信息 sources Array of SubscriptionSourceInfo objects 订阅源列表 targets Array of SubscriptionTargetInfo objects 订阅目标列表 created_time String 创建时间 updated_time String 更新时间 表6 SubscriptionUsedInfo 参数 参数类型 描述 resource_id String 关联资源ID owner String 管理租户账号 description String 描述 表7 SubscriptionSourceInfo 参数 参数类型 描述 id String 订阅源ID name String 订阅的事件源名称 provider_type String 订阅的事件源的提供方类型 detail Object 订阅的事件源参数列表 filter Object 订阅事件源的匹配过滤规则 created_time String 创建时间 updated_time String 更新时间 表8 SubscriptionTargetInfo 参数 参数类型 描述 id String 订阅目标ID name String 订阅的事件目标名称 provider_type String 订阅的事件目标的提供方类型 connection_id String 订阅的事件目标使用的目标链接ID detail Object 订阅的事件目标参数列表 kafka_detail KafkaTargetDetail object 订阅的kafka事件目标参数列表,该字段序列化后总长度不超过1024字节 smn_detail SmnTargetDetail object 订阅的SMN事件目标参数列表,该字段序列化后总长度不超过1024字节 eg_detail EgTargetDetail object 订阅的事件eg通道目标参数列表,该字段序列化后总长度不超过1024字节,eg通道目标必填 apigw_detail ApigwTargetDetail object 订阅的事件APIGWurl目标参数列表,该字段序列化后总长度不超过1024字节,APIGW目标必填 retry_times Integer 重试次数 transform TransForm object 订阅的事件目标转换规则 dead_letter_queue DeadLetterQueue object 订阅的死信参数列表 created_time String 创建时间 updated_time String 更新时间 表9 KafkaTargetDetail 参数 参数类型 描述 topic String 主题 keyTransform keyTransform object 键值规则 表10 keyTransform 参数 参数类型 描述 type String 键值规则类型 value String 键值规则,键值规则为VARIABLE,CONSTANT时必填 template String 键值规则模板,键值规则为VARIABLE时必填 表11 SmnTargetDetail 参数 参数类型 描述 urn String 主题urn agency_name String 委托名称 subject_transform subject_transform object 标题规则 表12 subject_transform 参数 参数类型 描述 type String 标题规则类型 value String 标题规则 template String 标题规则模板,键值规则为VARIABLE时必填 表13 EgTargetDetail 参数 参数类型 描述 target_project_id String 目标项目id target_channel_id String 目标通道id target_region String 目标region cross_region Boolean 跨region开关 cross_account Boolean 跨账号开关 agency_name String 委托名称 表14 ApigwTargetDetail 参数 参数类型 描述 url String 目标url invocation_http_parameters InvocationHttpParameters object 调用Http的参数 表15 InvocationHttpParameters 参数 参数类型 描述 header_parameters Array of HeaderParameter objects 对象列表 表16 HeaderParameter 参数 参数类型 描述 is_value_secret Boolean 是否加密 key String header的key值 value String deader的value值 表17 TransForm 参数 参数类型 描述 type String 转换规则类型 value String 常量类型规则时,字段为常量内容定义; 变量类型规则时,为变量定义,内容必须为JsonObject字符串。 变量最多支持100个,且不支持嵌套结构定义; 变量名由字母、数字、点、下划线和中划线组成,必须字母或数字开头不能以HC.开头,长度不超过64个字符; 变量值表达式支持常量或JsonPath表达式,字符串长度不超过1024个字符。 template String 变量类型规则时,规则内容的模板定义,支持对已定义变量的引用。 表18 DeadLetterQueue 参数 参数类型 描述 type String 队列类型 instance_id String 实例id connection_id String 目标连接id topic String 主题
  • URI GET /v1/{project_id}/subscription-triggers/workflow/{workflow_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户资源空间ID workflow_id 是 String 目标函数流的id 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量,表示从此偏移量开始查询,偏移量不能小于0 limit 否 Integer 每页显示的条目数量,不能小于1或大于1000 sort 否 String 指定查询排序
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数 size Integer 本页数量 items Array of SubscriptionInfo objects 对象列表 表5 SubscriptionInfo 参数 参数类型 描述 id String 订阅ID name String 订阅名称 description String 订阅描述 type String 类型 status String 状态 channel_id String 通道ID channel_name String 通道名称 used Array of SubscriptionUsedInfo objects 标签信息 sources Array of SubscriptionSourceInfo objects 订阅源列表 targets Array of SubscriptionTargetInfo objects 订阅目标列表 created_time String 创建时间 updated_time String 更新时间 表6 SubscriptionUsedInfo 参数 参数类型 描述 resource_id String 关联资源ID owner String 管理租户账号 description String 描述 表7 SubscriptionSourceInfo 参数 参数类型 描述 id String 订阅源ID name String 订阅的事件源名称 provider_type String 订阅的事件源的提供方类型 detail Object 订阅的事件源参数列表 filter Object 订阅事件源的匹配过滤规则 created_time String 创建时间 updated_time String 更新时间 表8 SubscriptionTargetInfo 参数 参数类型 描述 id String 订阅目标ID name String 订阅的事件目标名称 provider_type String 订阅的事件目标的提供方类型 connection_id String 订阅的事件目标使用的目标链接ID detail Object 订阅的事件目标参数列表 kafka_detail KafkaTargetDetail object 订阅的kafka事件目标参数列表,该字段序列化后总长度不超过1024字节 smn_detail SmnTargetDetail object 订阅的SMN事件目标参数列表,该字段序列化后总长度不超过1024字节 eg_detail EgTargetDetail object 订阅的事件eg通道目标参数列表,该字段序列化后总长度不超过1024字节,eg通道目标必填 apigw_detail ApigwTargetDetail object 订阅的事件APIGWurl目标参数列表,该字段序列化后总长度不超过1024字节,APIGW目标必填 retry_times Integer 重试次数 transform TransForm object 订阅的事件目标转换规则 dead_letter_queue DeadLetterQueue object 订阅的死信参数列表 created_time String 创建时间 updated_time String 更新时间 表9 KafkaTargetDetail 参数 参数类型 描述 topic String 主题 keyTransform keyTransform object 键值规则 表10 keyTransform 参数 参数类型 描述 type String 键值规则类型 value String 键值规则,键值规则为VARIABLE,CONSTANT时必填 template String 键值规则模板,键值规则为VARIABLE时必填 表11 SmnTargetDetail 参数 参数类型 描述 urn String 主题urn agency_name String 委托名称 subject_transform subject_transform object 标题规则 表12 subject_transform 参数 参数类型 描述 type String 标题规则类型 value String 标题规则 template String 标题规则模板,键值规则为VARIABLE时必填 表13 EgTargetDetail 参数 参数类型 描述 target_project_id String 目标项目id target_channel_id String 目标通道id target_region String 目标region cross_region Boolean 跨region开关 cross_account Boolean 跨账号开关 agency_name String 委托名称 表14 ApigwTargetDetail 参数 参数类型 描述 url String 目标url invocation_http_parameters InvocationHttpParameters object 调用Http的参数 表15 InvocationHttpParameters 参数 参数类型 描述 header_parameters Array of HeaderParameter objects 对象列表 表16 HeaderParameter 参数 参数类型 描述 is_value_secret Boolean 是否加密 key String header的key值 value String deader的value值 表17 TransForm 参数 参数类型 描述 type String 转换规则类型 value String 常量类型规则时,字段为常量内容定义; 变量类型规则时,为变量定义,内容必须为JsonObject字符串。 变量最多支持100个,且不支持嵌套结构定义; 变量名由字母、数字、点、下划线和中划线组成,必须字母或数字开头不能以HC.开头,长度不超过64个字符; 变量值表达式支持常量或JsonPath表达式,字符串长度不超过1024个字符。 template String 变量类型规则时,规则内容的模板定义,支持对已定义变量的引用。 表18 DeadLetterQueue 参数 参数类型 描述 type String 队列类型 instance_id String 实例id connection_id String 目标连接id topic String 主题
  • URI GET /v1/{project_id}/subscription-triggers/{func_urn} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户资源空间ID func_urn 是 String 目标函数的urn 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量,表示从此偏移量开始查询,偏移量不能小于0 limit 否 Integer 每页显示的条目数量,不能小于1或大于1000 sort 否 String 指定查询排序
  • 响应参数 状态码:200 表4 响应Header参数 参数 参数类型 描述 X-Request-Id String This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. 表5 响应Body参数 参数 参数类型 描述 total Integer 总数 size Integer 本页数量 result Array of result objects 事件追踪列表 表6 result 参数 参数类型 描述 subscription_name String 事件订阅名称 source_name String 事件源名称 source_provider String 事件源供应方 event_type String 事件类型 event_id String 事件Id event_received_time Integer 事件接收时间
  • 响应示例 状态码:200 Information { "total" : 1, "size" : 1, "result" : [ { "subscription_name" : "subscription-xxxx", "source_name" : "HC.SMN", "source_provider" : "OFFICIAL", "event_type" : "SMN:CloudTrace:ConsoleAction", "event_id" : "ace774cb-d3f1-49c1-9d8b-9efd086ac9e00533366", "event_received_time" : 1677651126823 } ] }
  • URI GET /v1/{project_id}/traced-events 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户资源空间ID 表2 Query参数 参数 是否必选 参数类型 描述 start_time 是 Long 查询数据起始时间 end_time 是 Long 查询数据结束时间 event_id 否 String 指定查询事件的Id source_name 否 String 事件源名称 event_type 否 String 指定查询的事件类型,精准匹配 subscription_name 否 String 事件订阅名称 limit 否 String 每页显示的条目数量,不能小于0 offset 否 Integer 偏移量,表示从此偏移量开始查询,偏移量不能小于0 channel_id 是 String 通道ID
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数 size Integer 本页数量 items Array of SubscriptionInfo objects 对象列表 表5 SubscriptionInfo 参数 参数类型 描述 id String 订阅ID name String 订阅名称 description String 订阅描述 type String 类型 status String 状态 channel_id String 通道ID channel_name String 通道名称 used Array of SubscriptionUsedInfo objects 标签信息 sources Array of SubscriptionSourceInfo objects 订阅源列表 targets Array of SubscriptionTargetInfo objects 订阅目标列表 created_time String 创建时间 updated_time String 更新时间 表6 SubscriptionUsedInfo 参数 参数类型 描述 resource_id String 关联资源ID owner String 管理租户账号 description String 描述 表7 SubscriptionSourceInfo 参数 参数类型 描述 id String 订阅源ID name String 订阅的事件源名称 provider_type String 订阅的事件源的提供方类型 detail Object 订阅的事件源参数列表 filter Object 订阅事件源的匹配过滤规则 created_time String 创建时间 updated_time String 更新时间 表8 SubscriptionTargetInfo 参数 参数类型 描述 id String 订阅目标ID name String 订阅的事件目标名称 provider_type String 订阅的事件目标的提供方类型 connection_id String 订阅的事件目标使用的目标链接ID detail Object 订阅的事件目标参数列表 kafka_detail KafkaTargetDetail object 订阅的kafka事件目标参数列表,该字段序列化后总长度不超过1024字节 smn_detail SmnTargetDetail object 订阅的SMN事件目标参数列表,该字段序列化后总长度不超过1024字节 eg_detail EgTargetDetail object 订阅的事件eg通道目标参数列表,该字段序列化后总长度不超过1024字节,eg通道目标必填 apigw_detail ApigwTargetDetail object 订阅的事件APIGWurl目标参数列表,该字段序列化后总长度不超过1024字节,APIGW目标必填 retry_times Integer 重试次数 transform TransForm object 订阅的事件目标转换规则 dead_letter_queue DeadLetterQueue object 订阅的死信参数列表 created_time String 创建时间 updated_time String 更新时间 表9 KafkaTargetDetail 参数 参数类型 描述 topic String 主题 keyTransform keyTransform object 键值规则 表10 keyTransform 参数 参数类型 描述 type String 键值规则类型 value String 键值规则,键值规则为VARIABLE,CONSTANT时必填 template String 键值规则模板,键值规则为VARIABLE时必填 表11 SmnTargetDetail 参数 参数类型 描述 urn String 主题urn agency_name String 委托名称 subject_transform subject_transform object 标题规则 表12 subject_transform 参数 参数类型 描述 type String 标题规则类型 value String 标题规则 template String 标题规则模板,键值规则为VARIABLE时必填 表13 EgTargetDetail 参数 参数类型 描述 target_project_id String 目标项目id target_channel_id String 目标通道id target_region String 目标region cross_region Boolean 跨region开关 cross_account Boolean 跨账号开关 agency_name String 委托名称 表14 ApigwTargetDetail 参数 参数类型 描述 url String 目标url invocation_http_parameters InvocationHttpParameters object 调用Http的参数 表15 InvocationHttpParameters 参数 参数类型 描述 header_parameters Array of HeaderParameter objects 对象列表 表16 HeaderParameter 参数 参数类型 描述 is_value_secret Boolean 是否加密 key String header的key值 value String deader的value值 表17 TransForm 参数 参数类型 描述 type String 转换规则类型 value String 常量类型规则时,字段为常量内容定义; 变量类型规则时,为变量定义,内容必须为JsonObject字符串。 变量最多支持100个,且不支持嵌套结构定义; 变量名由字母、数字、点、下划线和中划线组成,必须字母或数字开头不能以HC.开头,长度不超过64个字符; 变量值表达式支持常量或JsonPath表达式,字符串长度不超过1024个字符。 template String 变量类型规则时,规则内容的模板定义,支持对已定义变量的引用。 表18 DeadLetterQueue 参数 参数类型 描述 type String 队列类型 instance_id String 实例id connection_id String 目标连接id topic String 主题
  • URI GET /v1/{project_id}/subscriptions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户资源空间ID 表2 Query参数 参数 是否必选 参数类型 描述 channel_id 否 String 指定查询的事件通道ID offset 否 Integer 偏移量,表示从此偏移量开始查询,偏移量不能小于0 limit 否 Integer 每页显示的条目数量,不能小于1或大于1000 sort 否 String 指定查询排序 name 否 String 指定查询的事件订阅名称,精准匹配 fuzzy_name 否 String 指定查询的事件订阅名称,模糊匹配 connection_id 否 String 目标连接 id enterprise_project_id 否 String 创建订阅时所使用的企业项目id
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数 result Array of EventSubMetricsItem objects 指标数据列表 表5 EventSubMetricsItem 参数 参数类型 描述 fail_num Long 失败数 retry_success_num Long 重试成功数 retry_fail_num Long 重试失败数 retry_times Integer 重试数 timestamp Long 时间戳 num Long 调用数 success_num Long 调用成功数 process_time Long 处理时间 invoke_time Long 调用时间
  • URI GET /v1/{project_id}/metrics/sub 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户资源空间ID 表2 Query参数 参数 是否必选 参数类型 描述 filter 否 String 指标数据统计方式 period 否 Integer 指标数据统计周期,单位minute。 start_time 是 Long 获取指标数据起始时间 end_time 否 Long 获取指标数据结束时间 subscription_id 是 String 事件订阅id provider_type 否 String 事件目标类型/事件通道类型 target_id 否 String 事件目标id
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 quotas QuotaResourceResp object 配额描述 表5 QuotaResourceResp 参数 参数类型 描述 resources Array of QuotaItemInfo objects 错误描述 表6 QuotaItemInfo 参数 参数类型 描述 name String 名称 type String 配额类型 max Integer 配额最大值 min Integer 配额最小值 quota Integer 当前租户的配额 used Integer 当前租户已使用的配额
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全