华为云用户手册

请求消息元素 表1 请求消息元素 名称 描述 是否必选 rules 策略规则数组。 类型：Container 取值范围：[1, 10] 说明： 同一个桶下的不同策略前缀不能重复和起始包含，委托建议使用同一个。 是 表2 rules参数说明 名称 描述 是否必选 id 规则ID。当前桶上配置的DIS策略规则的唯一标识。 类型：String 取值范围：[1, 256]，满足“^[a-zA-Z0-9_-]{1, 256}$” 是 stream DIS服务通道名称。需要先在DIS服务创建此通道。 类型：String 是 project DIS服务通道所属的项目ID。 类型：String 是 events OBS事件列表。 类型：String 有效值：长度[0, 1023]，值允许为任意字符，支持如下事件类型： ObjectCreated:* （所有上传操作） ObjectCreated:Put （上传对象） ObjectCreated:Post （使用浏览器上传对象） ObjectCreated:Copy （拷贝对象） ObjectCreated:CompleteMultipartUpload （合并段） ObjectRemoved:* （所有删除操作） ObjectRemoved:Delete （指定对象版本号删除对象） ObjectRemoved:DeleteMarkerCreated （不指定对象版本号删除对象） 是 prefix 对象名前缀，用于指定的对象名关键字，根据定义的前缀，输入需要过滤的对象的关键字信息，字符越长匹配精度越高，最大可支持1024个字符，最小可为空。同时，prefix和suffix加起来长度最大为1024个字符。 类型：String 取值范围：[0, 1024] 否 suffix 对象名后缀。用于指定的对象名关键字，根据定义的后缀，输入需要过滤的对象的关键字信息，字符越长匹配精度越高，最大可支持1024个字符，最小可为空。同时，prefix和suffix加起来长度最大为1024个字符。 类型：String 取值范围：[0, 1024] 否 agency IAM 委托名，被委托方必须包含OBS服务，赋予的权限必须是DIS服务的DIS Administrator或DIS User。 类型：String 是

请求示例 DELETE /?obsworkflowtriggerpolicy HTTP/1.1 Host: bucket.obs.cn-north-4.myhuaweicloud.com Date: Thu, 27 Aug 2020 12:38:10 GMT Authorization: OBS H4IPJX0TQTHTHEBQQCEC:sc2PM13Wlfcoc/YZLK0MwsI2Zpo= Content-Type: application/json Content-Length: 0

请求示例 GET /?obsworkflowtriggerpolicy HTTP/1.1 Host: bucket.obs.cn-north-4.myhuaweicloud.com Authorization: OBS H4IPJX0TQTHTHEBQQCEC:sc2PM13Wlfcoc/YZLK0MwsI2Zpo= Content-Type: application/json Content-Length: 0 Date: Thu, 27 Aug 2020 12:38:10 GMT

响应示例 HTTP/1.1 200 OK Date: Thu, 27 Aug 2020 12:38:10 GMT Content-Length: 100 X-Request-ID: 6a63a18b8bab40ffb71ebd9cb80d0085 { "rules": [{ "id":"event-01", "graph_urn": "graph_urn", "events": ["ObjectCreated:*", "ObjectRemoved:*"], "prefix": "", "suffix": "" }] }

请求示例 PUT /?obsworkflowtriggerpolicy HTTP/1.1 Host: bucket.obs.cn-north-4.myhuaweicloud.com Authorization: OBS H4IPJX0TQTHTHEBQQCEC:sc2PM13Wlfcoc/YZLK0MwsI2Zpo= Content-Type: application/json Content-Length: 100 Date: Thu, 27 Aug 2020 12:38:10 GMT { "rules": [{ "id":"event-01", "graph_urn": "graph_urn", "events": ["ObjectCreated:*", "ObjectRemoved:*"], "prefix": "", "suffix": "" }] }

请求消息元素 表1 请求消息元素 名称 是否必选 参数类型 说明 约束 rules 是 Array 策略规则数组，请参考Rule结构体。 在同一个桶中，关联同一个工作流的不同策略条件（prefix、suffix）不能重复和起始包含。 表2 Rule结构体说明 名称 是否必选 参数类型 说明 约束 id 是 String 策略规则ID。 规则ID只允许由大写或小写的英文字母、数字、下划线和连字符组成，必须在1到256个字符之间。 策略中不允许出现相同规则ID。 graph_urn 是 String 工作流URN。 需要先在创建此工作流。 events 是 Array String OBS事件列表，请参考OBS事件类型。 - prefix 否 String 对象名前缀。 用于指定的对象名关键字，根据定义的前缀，输入需要过滤的对象的关键字信息，字符越长匹配精度越高，最大可支持1024个字符，最小可为空。 同时，prefix和suffix加起来长度最大为1024个字符。 suffix 否 String 对象名后缀。 用于指定的对象名关键字，根据定义的后缀，输入需要过滤的对象的关键字信息，字符越长匹配精度越高，最大可支持1024个字符，最小可为空。 同时，prefix和suffix加起来长度最大为1024个字符。 表3 OBS事件类型描述 事件类型 描述 值 OBJECT_CREATED_PUT Put上传对象操作。 ObjectCreated:Put OBJECT_CREATED_POST Post上传对象操作。 ObjectCreated:Post OBJECT_CREATED_COPY Copy上传对象操作。 ObjectCreated:Copy OBJECT_CREATED_COMPLETEMULTIPARTUPLOAD 合并段上传对象操作。 ObjectCreated:CompleteMultipartUpload OBJECT_CREATED_ALL 使用通配符支持所有上传对象操作。 ObjectCreated:* OBJECT_REMOVED_DELETE 删除对象操作。 ObjectRemoved:Delete OBJECT_REMOVED_DELETEMARKERCREATED 删除对象操作。 ObjectRemoved:DeleteMarkerCreated OBJECT_REMOVED_ALL 使用通配符支持所有删除对象操作。 ObjectRemoved:*

请求消息样式 GET /v2/actiontemplates/{template_name_prefix}?x-workflow-category={category}&x-workflow-prefix HTTP/1.1 Host: obs.cn-north-4.myhuaweicloud.com Authorization: authorization Content-Type: application/json Content-Length: length Date: date

请求示例 GET /v2/actiontemplates/{template_name_prefix}?x-workflow-category={category}&x-workflow-prefix HTTP/1.1 Host: obs.cn-north-4.myhuaweicloud.com Authorization: OBS H4IPJX0TQTHTHEBQQCEC:sc2PM13Wlfcoc/YZLK0MwsI2Zpo= Content-Type: application/json Content-Length: length Date: Thu, 27 Aug 2020 12:38:10 GMT

响应示例 HTTP/1.1 200 OK Date: Thu, 27 Aug 2020 12:38:10 GMT Content-Length: 100 Content-Type: application/json X-Request-ID: 6a63a18b8bab40ffb71ebd9cb80d0085 { "count": 1, "action_templates": [{ "name": "MediaTranscode", "category": "MediaProcess" }] }

请求消息参数 表1 参数说明 名称 是否必选 参数类型 说明 约束 template_name_prefix 否 String Action模板的名称前缀。 名称必须以字母或数字开头，只能由字母、数字、下划线和中划线组成，长度小于等于64个字符。 x-workflow-category 否 String Action模板的分类。 名称必须以字母或数字开头，只能由字母、数字、下划线和中划线组成，长度小于等于64个字符。 x-workflow-prefix 是 String 按前缀查询Action模板。 不需要传值。

请求示例 GET /v2/actiontemplates/{template_name} HTTP/1.1 Host: obs.cn-north-4.myhuaweicloud.com Authorization: OBS H4IPJX0TQTHTHEBQQCEC:sc2PM13Wlfcoc/YZLK0MwsI2Zpo= Content-Type: application/json Content-Length: 0 Date: Thu, 27 Aug 2020 12:38:10 GMT

响应消息元素 表2 响应消息元素 名称 参数类型 说明 provided_actions Array of ProvidedAction 可选的Action列表。 表3 ProvidedAction参数说明 名称 是否必选 参数类型 说明 name 是 String Action模板名称。 category 是 String 分类。 create_time 是 String 创建时间。 last_modify_time 否 String 最近修改时间。 function_template 是 String 函数的URN。 inputs 否 Array of Input 可修改参数定义列表。 dynamic_source_definition 是 Map 可修改参数引用。 need_policy 是 Policy 需要的权限。 provider 是 String 提供方。 description 否 String 描述。 表4 Policy参数说明 名称 参数类型 说明 version String 权限版本号。 1.0：系统预置的角色。以服务为粒度，提供有限的服务相关角色用于授权。 1.1：策略。IAM最新提供的一种细粒度授权的能力，可以精确到具体服务的操作、资源以及请求条件等。 statement Array of Statement 授权语句，描述权限的具体内容。 表5 Statement参数说明 名称 参数类型 说明 action Array String 授权项。指对资源的具体操作权限，不超过100个。 格式为：服务名:资源类型:操作，例：vpc:ports:create。 服务名为产品名称，例如ecs、evs和vpc等，服务名仅支持小写。 资源类型和操作没有大小写，要求支持通配符号*，无需罗列全部授权项。 当自定义策略为委托自定义策略时，该字段值为： "Action": ["iam:agencies:assume"]。 resource Array String 资源。数组长度不超过10，每个字符串长度不超过128，规则如下： 可填 * 的五段式：::::，例："obs:::bucket:*"。 region字段为*或用户可访问的region。service必须存在且resource属于对应service。 当该自定义策略为委托自定义策略时，该字段类型为Object，值为："Resource": {"uri": ["/iam/agencies/07805acaba800fdd4fbdc00b8f888c7c"]}。

请求示例 GET /v2/workflow-authorization HTTP/1.1 Host: obs.cn-north-4.myhuaweicloud.com Authorization: OBS H4IPJX0TQTHTHEBQQCEC:sc2PM13Wlfcoc/YZLK0MwsI2Zpo= Content-Type: application/json Content-Length: 0 Date: Thu, 27 Aug 2020 12:38:10 GMT

响应消息元素 表1 响应元素 名称 参数类型 说明 agencies Array of AgencyDetail 委托权限信息。 表2 AgencyDetail参数说明 名称 是否必选 参数类型 说明 create_time 是 String 创建时间。 last_modify_time 否 String 最近修改时间。 agency_id 是 String 委托方账号ID。 agency_name 是 String 委托名。 agency_duration 是 String 委托的期限。取值为"FOREVER"或“null”表示委托的期限为永久，取值为"ONEDAY"表示委托的期限为一天。 trust_domain_name 是 String 被委托方账号名。 role_id 是 String 权限ID。 role_dependent_by_function 是 String 权限使用的依赖函数。 role_remark_name 是 String 权限备注名。 role_remark_type 是 String 权限的备注模式： AX表示在domain层显示。 XA表示在project层显示。 AA表示在domain和project层均显示。 XX表示在domain和project层均不显示。 自定义策略的显示模式只能为AX或者XA，不能在domain层和project层都显示（AA），或者在domain层和project层都不显示（XX）。

请求示例 POST /v2/workflow-authorization HTTP/1.1 Host: obs.cn-north-4.myhuaweicloud.com Authorization: OBS H4IPJX0TQTHTHEBQQCEC:sc2PM13Wlfcoc/YZLK0MwsI2Zpo= Content-Type: application/json Content-Length: 0 Date: Thu, 27 Aug 2020 12:38:10 GMT

请求消息样式 PUT /v2/workflowexecutions/{execution_name}?x-workflow-graph-name={graph_name} HTTP/1.1 Host: obs.cn-north-4.myhuaweicloud.com Authorization: authorization Content-Type: application/json Content-Length: length Date: date

请求示例 PUT /v2/workflowexecutions/{execution_name}?x-workflow-graph-name={graph_name} HTTP/1.1 Host: obs.cn-north-4.myhuaweicloud.com Authorization: OBS H4IPJX0TQTHTHEBQQCEC:sc2PM13Wlfcoc/YZLK0MwsI2Zpo= Content-Type: application/json Content-Length: 0 Date: Thu, 27 Aug 2020 12:38:10 GMT

请求消息样式 GET /v2/workflowexecutions/{execution_name}?x-workflow-graph-name={graph_name} HTTP/1.1 Host: obs.cn-north-4.myhuaweicloud.com Authorization: authorization Content-Type: application/json Content-Length: length Date: date

请求示例 GET /v2/workflowexecutions/{execution_name}?x-workflow-graph-name={graph_name} HTTP/1.1 Host: obs.cn-north-4.myhuaweicloud.com Authorization: OBS H4IPJX0TQTHTHEBQQCEC:sc2PM13Wlfcoc/YZLK0MwsI2Zpo= Content-Type: application/json Content-Length: 0 Date: Thu, 27 Aug 2020 12:38:10 GMT

请求示例 GET /v2/workflowexecutions?x-workflow-next-marker={marker}&x-workflow-limit={limit}&x-workflow-graph-name={graph_name}&x-workflow-execution-type={execution_type} HTTP/1.1 Host: obs.cn-north-4.myhuaweicloud.com Authorization: OBS H4IPJX0TQTHTHEBQQCEC:sc2PM13Wlfcoc/YZLK0MwsI2Zpo= Content-Type: application/json Content-Length: 0 Date: Thu, 27 Aug 2020 12:38:10 GMT

请求消息参数 表1 参数说明 名称 是否必选 参数类型 说明 约束 x-workflow-execution-type 否 String 工作流实例的执行方式。 只能是如下枚举值： APICALL：要查询以API触发的工作流实例。 TRIGGERCAL：要查询以事件触发的工作流实例列表。 x-workflow-next-marker 否 String 列举列表时，指定一个标识符，返回的工作流实例列表将是按照字典顺序排序后这个标识符以后的所有工作流实例。 该标识由两部分组成： 触发类型+工作流实例名，其中触发类型枚举值见“x-workflow-execution-type”字段的约束。 x-workflow-limit 否 Int 请求返回的最大记录条数。 limit取值最小1，最大1000，不设置则取默认值10。 x-workflow-graph-name 是 string 工作流名称。 是已存在的工作流。

请求消息样式 GET /v2/workflowexecutions?x-workflow-next-marker={marker}&x-workflow-limit={limit}&x-workflow-graph-name={graph_name}&x-workflow-execution-type={execution_type} HTTP/1.1 Host: obs.cn-north-4.myhuaweicloud.com Authorization: authorization Content-Type: application/json Content-Length: length Date: date

响应消息元素 表2 响应元素 名称 参数类型 说明 count Int 满足条件的运行实例个数。 executions Array Execution 实例信息列表。 is_truncated Boolean 表明是否本次返回的结果列表被截断。 true：表示本次没有返回全部结果。 false：表示本次已经返回了全部结果。 next_marker String 如果本次没有返回全部结果，响应请求中将包含此字段，用于标明本次请求列举到的最后一个工作流实例。后续请求可以指定Marker等于该值来列举剩余的工作流实例。 如果is_truncated为false，该字段不会返回。

请求消息样式 GET /v2/workflows/{graph_name_prefix}?x-workflow-start={start}&x-workflow-limit={limit}&x-workflow-prefix HTTP/1.1 Host: obs.cn-north-4.myhuaweicloud.com Authorization: authorization Content-Type: application/json Content-Length: length Date: date

请求示例 GET /v2/workflows/{graph_name_prefix}?x-workflow-start={start}&x-workflow-limit={limit}&x-workflow-prefix HTTP/1.1 Host: obs.cn-north-4.myhuaweicloud.com Date: Thu, 27 Aug 2020 12:38:10 GMT Authorization: OBS H4IPJX0TQTHTHEBQQCEC:sc2PM13Wlfcoc/YZLK0MwsI2Zpo= Content-Type: application/json Content-Length: 0

请求消息参数 表1 请求消息参数 名称 是否必选 参数类型 说明 约束 graph_name_prefix 否 String 工作流的名称前缀。 名称必须以字母或数字开头，只能由字母、数字、下划线和中划线组成，长度小于等于64个字符。 x-workflow-prefix 是 String 按前缀查询工作流。 不需要传值。 x-workflow-start 否 Int 查询的起始位置。 start大于等于1，最大1000，不设置则取默认值1。 x-workflow-limit 否 Int 请求返回的最大记录条数。 limit取值最小1，最大1000，不设置则取默认值10。

响应消息元素 名称 参数类型 说明 count Int 列表条数。 graphs Array GraphItem 工作流模板列表信息。 next_start Int 下一次查询的起始位置。 is_truncated Boolean 表明是否本次返回的ListWorkflow结果列表被截断。“true”表示本次没有返回全部结果；“false”表示本次已经返回了全部结果。 表2 GraphItem结构体说明 名称 参数类型 说明 name String 工作流的名称。 created_at String 系统记录的创建工作流模板的时间。 graph_urn String 工作流的URN。

响应示例 HTTP/1.1 200 OK Date: Thu, 27 Aug 2020 12:38:10 GMT Content-Length: 10 X-Request-ID: 000001742FE8FB3CCA20173B00807C43 { "graph_name": "test-graph", "graph_urn": "urn:obs:cn-north-5:3f1e6caf808246c68457e660e4bfeb2f:graph:test-graph", "last_modified": "2020-08-26T07:37:36.131Z" }

请求示例 PUT /v2/workflows/{graph_name} HTTP/1.1 Host: obs.cn-north-4.myhuaweicloud.com Date: Thu, 27 Aug 2020 12:38:10 GMT Authorization: OBS H4IPJX0TQTHTHEBQQCEC:sc2PM13Wlfcoc/YZLK0MwsI2Zpo= Content-Type: application/json Content-Length: 100 { "parameters": { "transcode-template-id": 1234567 } }

请求示例 DELETE /v2/workflows/{graph_name} HTTP/1.1 Host: obs.cn-north-4.myhuaweicloud.com Date: Thu, 27 Aug 2020 12:38:10 GMT Authorization: OBS H4IPJX0TQTHTHEBQQCEC:sc2PM13Wlfcoc/YZLK0MwsI2Zpo= Content-Type: application/json Content-Length: 0