diff options
Diffstat (limited to 'data/zh_cn/fnf/2019-03-15')
| -rw-r--r-- | data/zh_cn/fnf/2019-03-15/api-docs.php | 6686 |
1 files changed, 2310 insertions, 4376 deletions
diff --git a/data/zh_cn/fnf/2019-03-15/api-docs.php b/data/zh_cn/fnf/2019-03-15/api-docs.php index d84633f..94b2da4 100644 --- a/data/zh_cn/fnf/2019-03-15/api-docs.php +++ b/data/zh_cn/fnf/2019-03-15/api-docs.php @@ -1,23 +1,14 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'fnf', - 'version' => '2019-03-15', - ], + 'info' => ['style' => 'RPC', 'product' => 'fnf', 'version' => '2019-03-15'], 'directories' => [ [ - 'id' => 308092, - 'title' => '地域', + 'children' => ['DescribeRegions'], 'type' => 'directory', - 'children' => [ - 'DescribeRegions', - ], + 'title' => '地域', + 'id' => 87038, ], [ - 'id' => 308094, - 'title' => '流程', - 'type' => 'directory', 'children' => [ 'CreateFlow', 'DeleteFlow', @@ -25,216 +16,49 @@ 'DescribeFlow', 'ListFlows', [ - 'id' => 308100, - 'title' => '流程版本', + 'children' => ['PublishFlowVersion', 'ListFlowVersions', 'DeleteFlowVersion'], 'type' => 'directory', - 'children' => [ - 'PublishFlowVersion', - 'ListFlowVersions', - 'DeleteFlowVersion', - ], + 'title' => '流程版本', + 'id' => 212631, ], [ - 'id' => 308104, - 'title' => '流程别名', + 'children' => ['ListFlowAliases', 'CreateFlowAlias', 'DescribeFlowAlias', 'UpdateFlowAlias', 'DeleteFlowAlias'], 'type' => 'directory', - 'children' => [ - 'ListFlowAliases', - 'CreateFlowAlias', - 'DescribeFlowAlias', - 'UpdateFlowAlias', - 'DeleteFlowAlias', - ], + 'title' => '流程别名', + 'id' => 212954, ], ], + 'type' => 'directory', + 'title' => '流程', + 'id' => 46915, ], [ - 'id' => 308110, - 'title' => '执行', + 'children' => ['StartExecution', 'StopExecution', 'DescribeExecution', 'ListExecutions', 'GetExecutionHistory', 'StartSyncExecution', 'DescribeMapRun', 'UpdateMapRun'], 'type' => 'directory', - 'children' => [ - 'StartExecution', - 'StopExecution', - 'DescribeExecution', - 'ListExecutions', - 'GetExecutionHistory', - 'StartSyncExecution', - 'DescribeMapRun', - 'UpdateMapRun', - ], + 'title' => '执行', + 'id' => 46927, ], [ - 'id' => 308119, - 'title' => '任务', + 'children' => ['ReportTaskFailed', 'ReportTaskSucceeded'], 'type' => 'directory', - 'children' => [ - 'ReportTaskFailed', - 'ReportTaskSucceeded', - ], + 'title' => '任务', + 'id' => 46912, ], [ - 'id' => 308122, - 'title' => '定时调度', + 'children' => ['CreateSchedule', 'DeleteSchedule', 'UpdateSchedule', 'DescribeSchedule', 'ListSchedules'], 'type' => 'directory', - 'children' => [ - 'CreateSchedule', - 'DeleteSchedule', - 'UpdateSchedule', - 'DescribeSchedule', - 'ListSchedules', - ], + 'title' => '定时调度', + 'id' => 46921, ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'DescribeRegions' => [ - 'summary' => '查询云工作流产品支持的地域信息。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '264118', - 'abilityTreeNodes' => [ - 'FEATUREfnf8CPMA5', - ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'AcceptLanguage', - 'in' => 'formData', - 'schema' => [ - 'title' => '根据汉语、英语筛选返回结果。更多详情，请参见RFC 7231。取值范围：'."\n" - ."\n" - .'zh-CN：简体中文。'."\n" - .'en-US：英文。'."\n" - .'默认值：zh-CN。', - 'description' => '根据汉语、英语筛选返回结果。更多详情，请参见RFC 7231。取值范围：'."\n" - ."\n" - .'zh-CN：简体中文。'."\n" - .'en-US：英文。'."\n" - .'默认值：zh-CN。', - 'type' => 'string', - 'required' => false, - 'example' => 'zh-CN', - 'default' => 'zh-CN', - 'enum' => [ - 'zh-CN', - 'en-US', - ], - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '0aa3f793-6e5f-8472-c7a2-70d2b84c04ac', - ], - 'Regions' => [ - 'description' => '地域信息。', - 'type' => 'object', - 'properties' => [ - 'Region' => [ - 'description' => '地域信息集合。', - 'type' => 'array', - 'items' => [ - 'description' => '地域对象。', - 'type' => 'object', - 'properties' => [ - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-qingdao', - ], - 'RegionEndpoint' => [ - 'description' => '地域对应的公网接入点。', - 'type' => 'string', - 'example' => 'cn-qingdao.fnf.aliyuncs.com', - ], - 'LocalName' => [ - 'description' => '地域名称。', - 'type' => 'string', - 'example' => '华北1（青岛）', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ActionNotSupported', - 'errorMessage' => 'The requested API operation %s is incorrect. Please check.', - ], - [ - 'errorCode' => 'APIVersionNotSupported', - 'errorMessage' => 'The requested API version %s is not supported yet. Please check.', - ], - ], - 403 => [ - [ - 'errorCode' => 'SignatureNotMatch', - 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0aa3f793-6e5f-8472-c7a2-70d2b84c04ac\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"RegionId\\": \\"cn-qingdao\\",\\n \\"RegionEndpoint\\": \\"cn-qingdao.fnf.aliyuncs.com\\",\\n \\"LocalName\\": \\"华北1（青岛）\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '查询地域信息', - 'responseParamsDescription' => '正常返回示例'."\n" - .'JSON格式'."\n" - .'```json'."\n" - .'{'."\n" - .' "RequestId": "67623904-2da4-d950-c8c0-7c68573899ab",'."\n" - .' "Regions": {'."\n" - .' "Region": ['."\n" - .' {'."\n" - .' "RegionId": "cn-qingdao",'."\n" - .' "RegionEndpoint": "cn-qingdao.fnf.aliyuncs.com",'."\n" - .' "LocalName": "华北1（青岛）"'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .'}'."\n" - .'```', - ], 'CreateFlow' => [ 'summary' => '创建一个流程。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -247,71 +71,51 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '98854', - 'abilityTreeNodes' => [ - 'FEATUREfnf8CPMA5', - ], + 'abilityTreeNodes' => ['FEATUREfnf8CPMA5'], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => '流程名称。该名称在同一地域内唯一，创建后不可修改。取值说明如下：'."\n" - ."\n" - .'- 支持英文字符（a~z）或（A~Z）、数字（0~9）、下划线（_）和短划线（-）。'."\n" - .'- 首字母必须为英文字母（a~z）、（A~Z）或下划线（_）。'."\n" - .'- 区分大小写。'."\n" - .'- 长度为1~128个字符。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_flow_name', - ], + 'schema' => ['description' => '流程名称。该名称在同一地域内唯一，创建后不可修改。取值说明如下：'."\n" + ."\n" + .'- 支持英文字符（a~z）或（A~Z）、数字（0~9）、下划线（_）和短划线（-）。'."\n" + .'- 首字母必须为英文字母（a~z）、（A~Z）或下划线（_）。'."\n" + .'- 区分大小写。'."\n" + .'- 长度为1~128个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_flow_name'], ], [ 'name' => 'Definition', 'in' => 'formData', - 'schema' => [ - 'description' => '流程定义，遵循Flow Definition Language (FDL)语法标准。考虑到向前兼容，当系统支持两种规范的流程定义规范。'."\n" - ."\n" - .'> '."\n" - .'> 以上流程定义示例中Name：my_flow_name是指流程名称，需和入参Name保持一致', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '旧版：'."\n" - .'"'."\n" - .'type: flow'."\n" - .'version: v1'."\n" - .'name: my_flow_name'."\n" - .'steps:'."\n" - .' - type: pass'."\n" - .' name: mypass'."\n" - .'"'."\n" - ."\n" - .'新版：'."\n" - .'"'."\n" - .'Type: StateMachine'."\n" - .'SpecVersion: v1'."\n" - .'Name: my_flow_name'."\n" - .'StartAt: my_state'."\n" - .'States:'."\n" - .' - Type: Pass'."\n" - .' Name: my_state'."\n" - .' End: true'."\n" - .'"', - ], + 'schema' => ['description' => '流程定义，遵循Flow Definition Language (FDL)语法标准。考虑到向前兼容，当系统支持两种规范的流程定义规范。'."\n" + ."\n" + .'> '."\n" + .'> 以上流程定义示例中Name：my_flow_name是指流程名称，需和入参Name保持一致', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Legacy version:'."\n" + .'"'."\n" + .'type: flow'."\n" + .'version: v1'."\n" + .'name: my_flow_name'."\n" + .'steps:'."\n" + .' - type: pass'."\n" + .' name: mypass'."\n" + .'"'."\n" + ."\n" + .'New version:'."\n" + .'"'."\n" + .'Type: StateMachine'."\n" + .'SpecVersion: v1'."\n" + .'Name: my_flow_name'."\n" + .'StartAt: my_state'."\n" + .'States:'."\n" + .' - Type: Pass'."\n" + .' Name: my_state'."\n" + .' End: true'."\n" + .'"'], ], [ 'name' => 'Description', 'in' => 'formData', - 'schema' => [ - 'description' => '流程描述。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my test flow', - ], + 'schema' => ['description' => '流程描述。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my test flow'], ], [ 'name' => 'Type', @@ -321,31 +125,19 @@ 'type' => 'string', 'required' => true, 'docRequired' => true, - 'enumValueTitles' => [ - 'FDL' => '流程描述语言', - ], + 'enumValueTitles' => ['FDL' => '流程描述语言'], 'example' => 'FDL', ], ], [ 'name' => 'RoleArn', 'in' => 'formData', - 'schema' => [ - 'description' => '流程执行依赖的授权角色资源描述符信息。用于在执行流程时，Serverless 工作流服务扮演该角色（AssumeRole）操作相关的流程资源。', - 'type' => 'string', - 'required' => false, - 'example' => 'acs:ram:${region}:${accountID}:${role}', - ], + 'schema' => ['description' => '流程执行依赖的授权角色资源描述符信息。用于在执行流程时，Serverless 工作流服务扮演该角色（AssumeRole）操作相关的流程资源。', 'type' => 'string', 'required' => false, 'example' => 'acs:ram:${region}:${accountID}:${role}'], ], [ 'name' => 'ExternalStorageLocation', 'in' => 'formData', - 'schema' => [ - 'description' => '外部存储位置。', - 'type' => 'string', - 'required' => false, - 'example' => '/path', - ], + 'schema' => ['description' => '外部存储位置。', 'type' => 'string', 'required' => false, 'example' => '/path'], ], [ 'name' => 'ExecutionMode', @@ -355,10 +147,7 @@ 'description' => '执行模式，枚举类型，可以是Express和Standard；考虑到向前兼容，空串等价于Standard 执行模式。', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'Express' => '快速执行模式', - 'Standard' => '标准执行模式', - ], + 'enumValueTitles' => ['Express' => '快速执行模式', 'Standard' => '标准执行模式'], 'example' => 'Standard', ], ], @@ -380,27 +169,9 @@ 'description' => '配置 Flow 执行期间可以访问的变量列表', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '变量名称', - 'description' => '变量名称', - 'type' => 'string', - 'required' => false, - 'example' => 'key', - ], - 'Value' => [ - 'title' => '变量值', - 'description' => '变量值', - 'type' => 'string', - 'required' => false, - 'example' => 'value', - ], - 'Description' => [ - 'title' => '变量描述', - 'description' => '变量描述', - 'type' => 'string', - 'required' => false, - 'example' => 'description', - ], + 'Name' => ['title' => '变量名称', 'description' => '变量名称', 'type' => 'string', 'required' => false, 'example' => 'key'], + 'Value' => ['title' => '变量值', 'description' => '变量值', 'type' => 'string', 'required' => false, 'example' => 'value'], + 'Description' => ['title' => '变量描述', 'description' => '变量描述', 'type' => 'string', 'required' => false, 'example' => 'description'], ], 'required' => false, ], @@ -410,6 +181,11 @@ 'required' => false, ], ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => ['title' => '资源组id', 'type' => 'string'], + ], ], 'responses' => [ 200 => [ @@ -420,61 +196,22 @@ 'Type' => [ 'description' => '流程类型。', 'type' => 'string', - 'enumValueTitles' => [ - 'FDL' => '流程描述语言', - ], + 'enumValueTitles' => ['FDL' => '流程描述语言'], 'example' => 'FDL', ], - 'Definition' => [ - 'description' => '流程定义，考虑到向前兼容，当系统支持两种规范的流程定义规范。', - 'type' => 'string', - 'example' => '旧版：'."\n" - .'"type: flow\\nversion: v1\\nname: my_flow_name\\nsteps:\\n - type: pass\\n name: mypass"'."\n" - ."\n" - .'新版：'."\n" - .'"Type: StateMachine\\nSpecVersion: v1\\nName: my_flow_name\\nStartAt: my_state\\nStates:\\n - Type: Pass\\n Name: my_state\\n End: true"', - ], - 'RoleArn' => [ - 'description' => '流程执行依赖的授权角色资源描述符信息。用于在执行流程时，Serverless 工作流服务扮演该角色（AssumeRole）操作相关的流程资源。', - 'type' => 'string', - 'example' => 'acs:ram:${region}:${accountID}:${role}', - ], - 'RequestId' => [ - 'description' => '请求ID。当有`http status code`返回时，Serverless工作流都会返回请求ID。', - 'type' => 'string', - 'example' => 'testRequestID', - ], - 'Description' => [ - 'description' => '流程描述信息。', - 'type' => 'string', - 'example' => 'my test flow', - ], - 'Name' => [ - 'description' => '流程名称。', - 'type' => 'string', - 'example' => 'my_flow_name', - ], - 'CreatedTime' => [ - 'description' => '流程创建时间。', - 'type' => 'string', - 'example' => '2019-01-01T01:01:01.001Z', - ], - 'LastModifiedTime' => [ - 'description' => '流程最近一次的更改时间。', - 'type' => 'string', - 'example' => '2019-01-01T01:01:01.001Z', - ], - 'Id' => [ - 'description' => '流程的唯一标识。', - 'type' => 'string', - 'example' => 'e589e092-e2c0-4dee-b306-3574ddfdddf5****', - ], - 'ExecutionMode' => [ - 'title' => '执行模式，枚举类型，可以是Express和Standard，空串等价于Standard', - 'description' => '执行模式，枚举类型，可以是Express和Standard，考虑到向前兼容，该字段可能为空字符串，这种情况等价于Standard模式。', - 'type' => 'string', - 'example' => 'Standard', - ], + 'Definition' => ['description' => '流程定义，考虑到向前兼容，当系统支持两种规范的流程定义规范。', 'type' => 'string', 'example' => 'Legacy version:'."\n" + .'"type: flow\\nversion: v1\\nname: my_flow_name\\nsteps:\\n - type: pass\\n name: mypass"'."\n" + ."\n" + .'New version:'."\n" + .'"Type: StateMachine\\nSpecVersion: v1\\nName: my_flow_name\\nStartAt: my_state\\nStates:\\n - Type: Pass\\n Name: my_state\\n End: true"'], + 'RoleArn' => ['description' => '流程执行依赖的授权角色资源描述符信息。用于在执行流程时，Serverless 工作流服务扮演该角色（AssumeRole）操作相关的流程资源。', 'type' => 'string', 'example' => 'acs:ram:${region}:${accountID}:${role}'], + 'RequestId' => ['description' => '请求ID。当有`http status code`返回时，Serverless工作流都会返回请求ID。', 'type' => 'string', 'example' => 'testRequestID'], + 'Description' => ['description' => '流程描述信息。', 'type' => 'string', 'example' => 'my test flow'], + 'Name' => ['description' => '流程名称。', 'type' => 'string', 'example' => 'my_flow_name'], + 'CreatedTime' => ['description' => '流程创建时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'], + 'LastModifiedTime' => ['description' => '流程最近一次的更改时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'], + 'Id' => ['description' => '流程的唯一标识。', 'type' => 'string', 'example' => 'e589e092-e2c0-4dee-b306-3574ddfdddf5****'], + 'ExecutionMode' => ['title' => '执行模式，枚举类型，可以是Express和Standard，空串等价于Standard', 'description' => '执行模式，枚举类型，可以是Express和Standard，考虑到向前兼容，该字段可能为空字符串，这种情况等价于Standard模式。', 'type' => 'string', 'example' => 'Standard'], 'Environment' => [ 'title' => 'Flow 执行期间可以访问的变量列表', 'description' => 'Flow 执行期间可以访问的变量列表', @@ -489,104 +226,48 @@ 'description' => 'Flow 执行期间可以访问的变量列表', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '变量名称', - 'description' => '变量名称', - 'type' => 'string', - 'example' => 'key', - ], - 'Value' => [ - 'title' => '变量值', - 'description' => '变量值', - 'type' => 'string', - 'example' => 'value', - ], - 'Description' => [ - 'title' => '变量描述', - 'description' => '变量描述', - 'type' => 'string', - 'example' => 'description', - ], + 'Name' => ['title' => '变量名称', 'description' => '变量名称', 'type' => 'string', 'example' => 'key'], + 'Value' => ['title' => '变量值', 'description' => '变量值', 'type' => 'string', 'example' => 'value'], + 'Description' => ['title' => '变量描述', 'description' => '变量描述', 'type' => 'string', 'example' => 'description'], ], ], ], ], ], + 'ResourceGroupId' => ['title' => '资源组id', 'type' => 'string', 'example' => 'rg-xxx'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ActionNotSupported', - 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', - ], - [ - 'errorCode' => 'APIVersionNotSupported', - 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', - ], - [ - 'errorCode' => 'EntityTooLarge', - 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', - ], - [ - 'errorCode' => 'InvalidArgument', - 'errorMessage' => 'Parameter error.', - ], - [ - 'errorCode' => 'MissingRequiredHeader', - 'errorMessage' => 'The HTTP header \'%s\' must be specified.', - ], - [ - 'errorCode' => 'MissingRequiredParams', - 'errorMessage' => 'The HTTP query \'%s\' must be specified.', - ], + ['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''], + ['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''], + ['errorCode' => 'EntityTooLarge', 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', 'description' => '请求消息体过大。'], + ['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => '请求参数错误。具体内容请参考实际错误信息。'], + ['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'], + ['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'], ], 403 => [ - [ - 'errorCode' => 'AccessDenied', - 'errorMessage' => 'The resources doesn\'t belong to you.', - ], - [ - 'errorCode' => 'InvalidAccessKeyID', - 'errorMessage' => 'The AccessKey ID %s is invalid.', - ], - [ - 'errorCode' => 'RequestTimeTooSkewed', - 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', - ], - [ - 'errorCode' => 'SignatureNotMatch', - 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', - ], + ['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''], + ['errorCode' => 'InvalidAccessKeyID', 'errorMessage' => 'The AccessKey ID %s is invalid.', 'description' => 'AccessKey ID无效。'], + ['errorCode' => 'RequestTimeTooSkewed', 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', 'description' => '您的请求时间不正确，该请求已被识别为无效。请参考通用参数一节。'], + ['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => '您发起请求的签名与我们计算不一致，请检查您的签名算法及AccessKey Secret。'], ], 409 => [ - [ - 'errorCode' => 'FlowAlreadyExists', - 'errorMessage' => 'Flow %s already exists.', - ], + ['errorCode' => 'FlowAlreadyExists', 'errorMessage' => 'Flow %s already exists.', 'description' => '已存在同名流程。'], ], 415 => [ - [ - 'errorCode' => 'UnsupportedMediaType', - 'errorMessage' => 'The content type must be "application/json".', - ], + ['errorCode' => 'UnsupportedMediaType', 'errorMessage' => 'The content type must be "application/json".', 'description' => '请求消息体类型错误。'], ], 429 => [ - [ - 'errorCode' => 'ResourceThrottled', - 'errorMessage' => 'The request is throttled. Please try again later.', - ], + ['errorCode' => 'ResourceThrottled', 'errorMessage' => 'The request is throttled. Please try again later.', 'description' => '因某些原因系统流量已达瓶颈。请稍后重试。'], ], 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'An internal error has occurred. Please retry.', - ], + ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => '服务器内部错误。请稍后重试。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Type\\": \\"FDL\\",\\n \\"Definition\\": \\"旧版：\\\\n\\\\\\"type: flow\\\\\\\\nversion: v1\\\\\\\\nname: my_flow_name\\\\\\\\nsteps:\\\\\\\\n - type: pass\\\\\\\\n name: mypass\\\\\\"\\\\n\\\\n新版：\\\\n\\\\\\"Type: StateMachine\\\\\\\\nSpecVersion: v1\\\\\\\\nName: my_flow_name\\\\\\\\nStartAt: my_state\\\\\\\\nStates:\\\\\\\\n - Type: Pass\\\\\\\\n Name: my_state\\\\\\\\n End: true\\\\\\"\\",\\n \\"RoleArn\\": \\"acs:ram:${region}:${accountID}:${role}\\",\\n \\"RequestId\\": \\"testRequestID\\",\\n \\"Description\\": \\"my test flow\\",\\n \\"Name\\": \\"my_flow_name\\",\\n \\"CreatedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"LastModifiedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"Id\\": \\"e589e092-e2c0-4dee-b306-3574ddfdddf5****\\",\\n \\"ExecutionMode\\": \\"Standard\\",\\n \\"Environment\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"key\\",\\n \\"Value\\": \\"value\\",\\n \\"Description\\": \\"description\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Type\\": \\"FDL\\",\\n \\"Definition\\": \\"Legacy version:\\\\n\\\\\\"type: flow\\\\\\\\nversion: v1\\\\\\\\nname: my_flow_name\\\\\\\\nsteps:\\\\\\\\n - type: pass\\\\\\\\n name: mypass\\\\\\"\\\\n\\\\nNew version:\\\\n\\\\\\"Type: StateMachine\\\\\\\\nSpecVersion: v1\\\\\\\\nName: my_flow_name\\\\\\\\nStartAt: my_state\\\\\\\\nStates:\\\\\\\\n - Type: Pass\\\\\\\\n Name: my_state\\\\\\\\n End: true\\\\\\"\\",\\n \\"RoleArn\\": \\"acs:ram:${region}:${accountID}:${role}\\",\\n \\"RequestId\\": \\"testRequestID\\",\\n \\"Description\\": \\"my test flow\\",\\n \\"Name\\": \\"my_flow_name\\",\\n \\"CreatedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"LastModifiedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"Id\\": \\"e589e092-e2c0-4dee-b306-3574ddfdddf5****\\",\\n \\"ExecutionMode\\": \\"Standard\\",\\n \\"Environment\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"key\\",\\n \\"Value\\": \\"value\\",\\n \\"Description\\": \\"description\\"\\n }\\n ]\\n },\\n \\"ResourceGroupId\\": \\"rg-xxx\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '创建一个流程', 'description' => '## 接口说明'."\n" .'- 每个用户所能创建的流程个数受资源限制（详见[使用限制](~~122093~~)），如果您有特殊需求，可以提工单进行调整。'."\n" @@ -594,145 +275,122 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteFlow' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'fnf:CreateFlow', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => 'Flow', 'arn' => 'acs:fnf:{#regionId}:{#accountId}:flow/*'], + ], + ], + ], ], + ], + 'CreateFlowAlias' => [ + 'summary' => '为流程创建别名，此后可以在发起执行时指定流程别名', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '98856', - 'abilityTreeNodes' => [ - 'FEATUREfnf8CPMA5', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREfnf8CPMA5'], + 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ + 'name' => 'FlowName', + 'in' => 'formData', + 'schema' => ['title' => '流程名称', 'description' => '流程名称', 'type' => 'string', 'required' => true, 'example' => 'example-flow-name'], + ], + [ 'name' => 'Name', 'in' => 'formData', + 'schema' => ['title' => '别名名称', 'description' => '别名名称', 'type' => 'string', 'required' => true, 'example' => 'example-alias-name'], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['title' => '别名描述', 'description' => '别名描述', 'type' => 'string', 'required' => false, 'example' => 'example description'], + ], + [ + 'name' => 'RoutingConfigurations', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '要删除的流程名称。', - 'type' => 'string', + 'title' => '流量分发设置', + 'description' => '流量分发配置，支持配置一个或两个流程版本。当指定别名发起执行时，系统会根据权重选择对应的流程版本进行执行。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Version' => ['title' => '流程版本', 'description' => '流程版本', 'type' => 'string', 'required' => true, 'example' => '1'], + 'Weight' => ['title' => '权重', 'description' => '权重', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '30'], + ], + 'required' => false, + ], 'required' => true, - 'docRequired' => true, - 'example' => 'my_flow_name', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回数据。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'testRequestId', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'testRequestID'], + 'FlowName' => ['title' => '流程名称', 'description' => '流程名称', 'type' => 'string', 'example' => 'example-flow-name'], + 'Name' => ['title' => '别名名称', 'description' => '别名名称', 'type' => 'string', 'example' => 'exampe-alias-name'], + 'Description' => ['title' => '别名描述', 'description' => '别名描述', 'type' => 'string', 'example' => 'example description'], + 'RoutingConfigurations' => [ + 'description' => '流量分发配置，支持配置一个或两个流程版本。当指定别名发起执行时，系统会根据权重选择对应的流程版本进行执行。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Version' => ['title' => '版本名称', 'description' => '版本名称', 'type' => 'string', 'example' => '1'], + 'Weight' => ['title' => '权重', 'description' => '权重', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + ], + ], ], + 'CreatedTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2020-01-01T01:01:01.001Z'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ActionNotSupported', - 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', - ], - [ - 'errorCode' => 'APIVersionNotSupported', - 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', - ], - [ - 'errorCode' => 'EntityTooLarge', - 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', - ], - [ - 'errorCode' => 'InvalidArgument', - 'errorMessage' => 'Parameter error.', - ], - [ - 'errorCode' => 'MissingRequiredParams', - 'errorMessage' => 'The HTTP query \'%s\' must be specified.', - ], - ], - 403 => [ - [ - 'errorCode' => 'AccessDenied', - 'errorMessage' => 'The resources doesn\'t belong to you.', - ], - [ - 'errorCode' => 'InvalidAccessKeyID', - 'errorMessage' => 'The AccessKey ID %s is invalid.', - ], - [ - 'errorCode' => 'RequestTimeTooSkewed', - 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', - ], - [ - 'errorCode' => 'SignatureNotMatch', - 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', - ], - ], - [ - [ - 'errorCode' => 'FlowNotExists', - 'errorMessage' => 'Flow %s does not exist.', - ], - ], - 409 => [ - [ - 'errorCode' => 'ConcurrentUpdateError', - 'errorMessage' => 'Update conflict, please retry.', - ], - ], - 412 => [ - [ - 'errorCode' => 'PreconditionFailed', - 'errorMessage' => 'The resource to be modified has been changed.', - ], - ], - 415 => [ - [ - 'errorCode' => 'UnsupportedMediaType', - 'errorMessage' => 'The content type must be "application/json".', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'An internal error has occurred. Please retry.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"testRequestId\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '删除一个已存在的流程', - 'summary' => '删除一个已存在的流程。', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建一个流程别名', 'description' => '## 接口说明'."\n" - .'删除动作为异步删除，API调用成功后您将收到成功的返回。待删除后您重新建立的同名流程不会受到历史的流程影响。删除流程后，所有的历史执行信息将无法再查询，处于执行中的每个执行将会完成最近的一个步骤后停止。', - ], - 'UpdateFlow' => [ - 'summary' => '更新一个流程的内容。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + .'- 每个用户所能创建的流程个数受资源限制（详见[使用限制](~~122093~~)），如果您有特殊需求，可以提工单进行调整。'."\n" + .'- 流程在用户级别是按照名称来区分的，即单一账号下不可以存在同名流程。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"testRequestID\\",\\n \\"FlowName\\": \\"example-flow-name\\",\\n \\"Name\\": \\"exampe-alias-name\\",\\n \\"Description\\": \\"example description\\",\\n \\"RoutingConfigurations\\": [\\n {\\n \\"Version\\": \\"1\\",\\n \\"Weight\\": 30\\n }\\n ],\\n \\"CreatedTime\\": \\"2020-01-01T01:01:01.001Z\\"\\n}","type":"json"}]', + ], + 'CreateSchedule' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -741,135 +399,52 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '98869', - 'abilityTreeNodes' => [ - 'FEATUREfnf8CPMA5', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '98855', + 'abilityTreeNodes' => ['FEATUREfnf06LH4G'], ], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'FlowName', 'in' => 'formData', - 'schema' => [ - 'description' => '已创建的流程名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_flow_name', - ], + 'schema' => ['description' => '定时调度绑定的工作流名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_flow_name'], ], [ - 'name' => 'Definition', + 'name' => 'ScheduleName', 'in' => 'formData', - 'schema' => [ - 'description' => '流程定义，遵循Flow Definition Language (FDL)语法标准。考虑到向前兼容，当系统支持两种规范的流程定义规范。'."\n" - .'> '."\n" - .'> 以上流程定义示例中Name：my_flow_name是指流程名称，需和入参Name保持一致', - 'type' => 'string', - 'required' => false, - 'example' => '旧版：'."\n" - .'"'."\n" - .'type: flow'."\n" - .'version: v1'."\n" - .'name: my_flow_name'."\n" - .'steps:'."\n" - .' - type: pass'."\n" - .' name: mypass'."\n" - .'"'."\n" - ."\n" - .'新版：'."\n" - .'"'."\n" - .'Type: StateMachine'."\n" - .'SpecVersion: v1'."\n" - .'Name: my_flow_name'."\n" - .'StartAt: my_state'."\n" - .'States:'."\n" - .' - Type: Pass'."\n" - .' Name: my_state'."\n" - .' End: true'."\n" - .'"', - ], + 'schema' => ['description' => '定时调度的名称。取值说明如下：'."\n" + ."\n" + .'- 支持英文字符（a~z）或（A~Z）、数字（0~9）、下划线（_）和短划线（-）。'."\n" + .'- 首字母必须为英文字母（a~z）、（A~Z）或下划线（_）。'."\n" + .'- 区分大小写。'."\n" + .'- 长度为1~128个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_schedule_name'], ], [ 'name' => 'Description', 'in' => 'formData', - 'schema' => [ - 'description' => '流程描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'my test flow', - ], + 'schema' => ['description' => '定时调度的描述。', 'type' => 'string', 'required' => false, 'example' => 'my test schedule'], ], [ - 'name' => 'Type', + 'name' => 'Payload', 'in' => 'formData', - 'schema' => [ - 'description' => '流程类型，取值：**FDL**。', - 'type' => 'string', - 'required' => false, - 'example' => 'FDL', - ], + 'schema' => ['description' => '定时调度的触发消息，必须为JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{"key": "value"}'], ], [ - 'name' => 'RoleArn', + 'name' => 'CronExpression', 'in' => 'formData', - 'schema' => [ - 'description' => '流程执行依赖的授权角色资源描述符信息。用于在执行流程时，流程执行引擎扮演该角色（AssumeRole）调用相关的流程资源API。', - 'type' => 'string', - 'required' => false, - 'example' => 'acs:ram:${region}:${accountID}:${role}', - ], + 'schema' => ['description' => 'Cron表达式。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0 * * * * *'], ], [ - 'name' => 'Environment', + 'name' => 'Enable', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '配置 Flow 执行期间可以访问的变量列表', - 'description' => '配置 Flow 执行期间可以访问的变量列表', - 'type' => 'object', - 'properties' => [ - 'Variables' => [ - 'title' => '配置 Flow 执行期间可以访问的变量列表', - 'description' => '配置 Flow 执行期间可以访问的变量列表', - 'type' => 'array', - 'items' => [ - 'title' => '配置 Flow 执行期间可以访问的变量列表', - 'description' => '配置 Flow 执行期间可以访问的变量列表', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '变量名称', - 'description' => '变量名称', - 'type' => 'string', - 'required' => false, - 'example' => 'key', - ], - 'Value' => [ - 'title' => '变量值', - 'description' => '变量值', - 'type' => 'string', - 'required' => false, - 'example' => 'value', - ], - 'Description' => [ - 'title' => '变量描述', - 'description' => '变量描述', - 'type' => 'string', - 'required' => false, - 'example' => 'description', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], + 'schema' => ['description' => '是否启用定时调度。取值说明如下：'."\n" + .'- **true**：启用。'."\n" + .'- **false**：禁用。'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'SignatureVersion', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -878,233 +453,80 @@ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => '流程类型。', - 'type' => 'string', - 'example' => 'FDL', - ], - 'Definition' => [ - 'description' => '流程定义，遵循Flow Definition Language (FDL)语法标准。考虑到向前兼容，当系统支持两种规范的流程定义规范。', - 'type' => 'string', - 'example' => '旧版：'."\n" - .'"type: flow\\nversion: v1\\nname: my_flow_name\\nsteps:\\n - type: pass\\n name: mypass"'."\n" - ."\n" - .'新版：'."\n" - .'"Type: StateMachine\\nSpecVersion: v1\\nName: my_flow_name\\nStartAt: my_state\\nStates:\\n - Type: Pass\\n Name: my_state\\n End: true"', - ], - 'RoleArn' => [ - 'description' => '流程执行依赖的授权角色资源描述符信息。用于在执行流程时，流程执行引擎扮演该角色（AssumeRole）调用相关的流程资源API。', - 'type' => 'string', - 'example' => 'acs:ram:${region}:${accountID}:${role}', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'testRequestID', - ], - 'Description' => [ - 'description' => '流程描述。', - 'type' => 'string', - 'example' => 'my test flow', - ], - 'ExternalStorageLocation' => [ - 'description' => '外部存储位置。', - 'type' => 'string', - 'example' => '/path', - ], - 'Name' => [ - 'description' => '流程名称。', - 'type' => 'string', - 'example' => 'my_flow_name', - ], - 'CreatedTime' => [ - 'description' => '流程创建时间。', - 'type' => 'string', - 'example' => '2019-01-01T01:01:01.001Z', - ], - 'LastModifiedTime' => [ - 'description' => '流程最近一次的更改时间。', - 'type' => 'string', - 'example' => '2019-01-01T01:01:01.001Z', - ], - 'Id' => [ - 'description' => '流程的唯一ID。', - 'type' => 'string', - 'example' => 'e589e092-e2c0-4dee-b306-3574ddfdddf5****', - ], - 'Environment' => [ - 'title' => 'Flow 执行期间可以访问的变量列表', - 'description' => 'Flow 执行期间可以访问的变量列表', - 'type' => 'object', - 'properties' => [ - 'Variables' => [ - 'title' => 'Flow 执行期间可以访问的变量列表', - 'description' => 'Flow 执行期间可以访问的变量列表', - 'type' => 'array', - 'items' => [ - 'title' => 'Flow 执行期间可以访问的变量列表', - 'description' => 'Flow 执行期间可以访问的变量列表', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '变量名称', - 'description' => '变量名称', - 'type' => 'string', - 'example' => 'key', - ], - 'Value' => [ - 'title' => '变量值', - 'description' => '变量值', - 'type' => 'string', - 'example' => 'value', - ], - 'Description' => [ - 'title' => '变量描述', - 'description' => '变量描述', - 'type' => 'string', - 'example' => 'description', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestId'], + 'Description' => ['description' => '定时调度的描述。', 'type' => 'string', 'example' => 'test description'], + 'ScheduleId' => ['description' => '定时调度的ID。', 'type' => 'string', 'example' => 'testScheduleId'], + 'Payload' => ['description' => '定时调度的触发消息。', 'type' => 'string', 'example' => '{"key": "value"}'], + 'ScheduleName' => ['description' => '定时调度的名称。', 'type' => 'string', 'example' => 'testScheduleName'], + 'CreatedTime' => ['description' => '定时调度的创建时间。', 'type' => 'string', 'example' => '2020-01-01T01:01:01.001Z'], + 'LastModifiedTime' => ['description' => '定时调度最近一次的更改时间。', 'type' => 'string', 'example' => '2020-01-01T01:01:01.001Z'], + 'CronExpression' => ['description' => 'Cron表达式。', 'type' => 'string', 'example' => '0 * * * * *'], + 'Enable' => ['description' => '是否启用定时调度。', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ActionNotSupported', - 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', - ], - [ - 'errorCode' => 'APIVersionNotSupported', - 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', - ], - [ - 'errorCode' => 'InvalidArgument', - 'errorMessage' => 'Parameter error.', - ], - [ - 'errorCode' => 'MissingRequiredHeader', - 'errorMessage' => 'The HTTP header \'%s\' must be specified.', - ], - [ - 'errorCode' => 'MissingRequiredParams', - 'errorMessage' => 'The HTTP query \'%s\' must be specified.', - ], + ['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''], + ['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => ''], + ['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => ''], + ['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessDenied', - 'errorMessage' => 'The resources doesn\'t belong to you.', - ], - [ - 'errorCode' => 'InvalidAccessKeyID', - 'errorMessage' => 'The AccessKey ID %s is invalid.', - ], - [ - 'errorCode' => 'RequestTimeTooSkewed', - 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', - ], - [ - 'errorCode' => 'SignatureNotMatch', - 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', - ], + ['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''], ], [ - [ - 'errorCode' => 'FlowNotExists', - 'errorMessage' => 'Flow %s does not exist.', - ], + ['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => ''], ], 409 => [ - [ - 'errorCode' => 'ConcurrentUpdateError', - 'errorMessage' => 'Update conflict, please retry.', - ], - ], - 412 => [ - [ - 'errorCode' => 'PreconditionFailed', - 'errorMessage' => 'The resource to be modified has been changed.', - ], - ], - 415 => [ - [ - 'errorCode' => 'UnsupportedMediaType', - 'errorMessage' => 'The content type must be "application/json".', - ], - ], - 429 => [ - [ - 'errorCode' => 'ResourceThrottled', - 'errorMessage' => 'The request is throttled. Please try again later.', - ], + ['errorCode' => 'ConcurrentUpdateError', 'errorMessage' => 'Update conflict, please retry.', 'description' => ''], + ['errorCode' => 'ScheduleAlreadyExists', 'errorMessage' => 'The schedule %s already exists in flow %s.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'An internal error has occurred. Please retry.', + ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"Description\\": \\"test description\\",\\n \\"ScheduleId\\": \\"testScheduleId\\",\\n \\"Payload\\": \\"{\\\\\\"key\\\\\\": \\\\\\"value\\\\\\"}\\",\\n \\"ScheduleName\\": \\"testScheduleName\\",\\n \\"CreatedTime\\": \\"2020-01-01T01:01:01.001Z\\",\\n \\"LastModifiedTime\\": \\"2020-01-01T01:01:01.001Z\\",\\n \\"CronExpression\\": \\"0 * * * * *\\",\\n \\"Enable\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '创建一个定时调度（仅适用于旧版工作流）', + 'summary' => '创建一个定时调度。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'fnf:CreateSchedule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Type\\": \\"FDL\\",\\n \\"Definition\\": \\"旧版：\\\\n\\\\\\"type: flow\\\\\\\\nversion: v1\\\\\\\\nname: my_flow_name\\\\\\\\nsteps:\\\\\\\\n - type: pass\\\\\\\\n name: mypass\\\\\\"\\\\n\\\\n新版：\\\\n\\\\\\"Type: StateMachine\\\\\\\\nSpecVersion: v1\\\\\\\\nName: my_flow_name\\\\\\\\nStartAt: my_state\\\\\\\\nStates:\\\\\\\\n - Type: Pass\\\\\\\\n Name: my_state\\\\\\\\n End: true\\\\\\"\\",\\n \\"RoleArn\\": \\"acs:ram:${region}:${accountID}:${role}\\",\\n \\"RequestId\\": \\"testRequestID\\",\\n \\"Description\\": \\"my test flow\\",\\n \\"ExternalStorageLocation\\": \\"/path\\",\\n \\"Name\\": \\"my_flow_name\\",\\n \\"CreatedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"LastModifiedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"Id\\": \\"e589e092-e2c0-4dee-b306-3574ddfdddf5****\\",\\n \\"Environment\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"key\\",\\n \\"Value\\": \\"value\\",\\n \\"Description\\": \\"description\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '更新一个已有流程', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'DescribeFlow' => [ - 'summary' => '获取一个流程的相关信息。', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteFlow' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '98859', - 'abilityTreeNodes' => [ - 'FEATUREfnf8CPMA5', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '98856', + 'abilityTreeNodes' => ['FEATUREfnf8CPMA5'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '流程名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_flow_name', - ], - ], - [ - 'name' => 'FlowVersion', - 'in' => 'query', - 'schema' => [ - 'title' => '版本', - 'description' => '版本', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'in' => 'formData', + 'schema' => ['description' => '要删除的流程名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_flow_name'], ], ], 'responses' => [ @@ -1113,432 +535,66 @@ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => '流程类型。', - 'type' => 'string', - 'example' => 'FDL', - ], - 'Definition' => [ - 'description' => '流程定义，遵循Flow Definition Language (FDL)语法标准。考虑到向前兼容，当系统支持两种规范的流程定义规范。', - 'type' => 'string', - 'example' => '旧版：'."\n" - .'"'."\n" - .'type: flow'."\n" - .'version: v1'."\n" - .'name: my_flow_name'."\n" - .'steps:'."\n" - .' - type: pass'."\n" - .' name: mypass'."\n" - .'"'."\n" - ."\n" - .'新版：'."\n" - .'"'."\n" - .'Type: StateMachine'."\n" - .'SpecVersion: v1'."\n" - .'Name: my_flow_name'."\n" - .'StartAt: my_state'."\n" - .'States:'."\n" - .' - Type: Pass'."\n" - .' Name: my_state'."\n" - .' End: true'."\n" - .'"', - ], - 'RoleArn' => [ - 'description' => '流程执行依赖的授权角色资源描述符信息。用于在执行流程时，Serverless 工作流服务扮演该角色（AssumeRole）操作相关的流程资源。', - 'type' => 'string', - 'example' => 'acs:ram:${region}:${accountID}:${role}', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'testRequestId', - ], - 'Description' => [ - 'description' => '流程描述。', - 'type' => 'string', - 'example' => 'my test flow', - ], - 'Name' => [ - 'description' => '流程名称。', - 'type' => 'string', - 'example' => 'my_flow_name', - ], - 'CreatedTime' => [ - 'description' => '流程创建时间。', - 'type' => 'string', - 'example' => '2019-01-01T01:01:01.001Z', - ], - 'LastModifiedTime' => [ - 'description' => '流程最近一次的更改时间。', - 'type' => 'string', - 'example' => '2019-01-01T01:01:01.001Z', - ], - 'Id' => [ - 'description' => '流程的唯一ID。', - 'type' => 'string', - 'example' => 'e589e092-e2c0-4dee-b306-3574ddfdddf5****', - ], - 'ExecutionMode' => [ - 'title' => '执行模式，枚举类型，可以是Express和Standard，空串等价于Standard', - 'description' => '执行模式，枚举类型，可以是Express和Standard，空串等价于Standard', - 'type' => 'string', - 'example' => 'Standard', - ], - 'Environment' => [ - 'title' => 'Flow 执行期间可以访问的变量列表', - 'description' => 'Flow 执行期间可以访问的变量列表', - 'type' => 'object', - 'properties' => [ - 'Variables' => [ - 'title' => 'Flow 执行期间可以访问的变量列表', - 'description' => 'Flow 执行期间可以访问的变量列表', - 'type' => 'array', - 'items' => [ - 'title' => 'Flow 执行期间可以访问的变量列表', - 'description' => 'Flow 执行期间可以访问的变量列表', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '变量名称', - 'description' => '变量名称', - 'type' => 'string', - 'example' => 'key', - ], - 'Value' => [ - 'title' => '变量值', - 'description' => '变量值', - 'type' => 'string', - 'example' => 'value', - ], - 'Description' => [ - 'title' => '变量描述', - 'description' => '变量描述', - 'type' => 'string', - 'example' => 'description', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestId'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ActionNotSupported', - 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', - ], - [ - 'errorCode' => 'APIVersionNotSupported', - 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', - ], - [ - 'errorCode' => 'EntityTooLarge', - 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', - ], - [ - 'errorCode' => 'InvalidArgument', - 'errorMessage' => 'Parameter error.', - ], - [ - 'errorCode' => 'MissingRequiredHeader', - 'errorMessage' => 'The HTTP header \'%s\' must be specified.', - ], - [ - 'errorCode' => 'MissingRequiredParams', - 'errorMessage' => 'The HTTP query \'%s\' must be specified.', - ], + ['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''], + ['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''], + ['errorCode' => 'EntityTooLarge', 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', 'description' => ''], + ['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => ''], + ['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessDenied', - 'errorMessage' => 'The resources doesn\'t belong to you.', - ], - [ - 'errorCode' => 'InvalidAccessKeyID', - 'errorMessage' => 'The AccessKey ID %s is invalid.', - ], - [ - 'errorCode' => 'RequestTimeTooSkewed', - 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', - ], - [ - 'errorCode' => 'SignatureNotMatch', - 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', - ], + ['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''], + ['errorCode' => 'InvalidAccessKeyID', 'errorMessage' => 'The AccessKey ID %s is invalid.', 'description' => ''], + ['errorCode' => 'RequestTimeTooSkewed', 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', 'description' => ''], + ['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => ''], ], [ - [ - 'errorCode' => 'FlowNotExists', - 'errorMessage' => 'Flow %s does not exist.', - ], + ['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => ''], + ], + 409 => [ + ['errorCode' => 'ConcurrentUpdateError', 'errorMessage' => 'Update conflict, please retry.', 'description' => ''], ], 412 => [ - [ - 'errorCode' => 'PreconditionFailed', - 'errorMessage' => 'The resource to be modified has been changed.', - ], + ['errorCode' => 'PreconditionFailed', 'errorMessage' => 'The resource to be modified has been changed.', 'description' => ''], ], 415 => [ - [ - 'errorCode' => 'UnsupportedMediaType', - 'errorMessage' => 'The content type must be "application/json".', - ], - ], - 429 => [ - [ - 'errorCode' => 'ResourceThrottled', - 'errorMessage' => 'The request is throttled. Please try again later.', - ], + ['errorCode' => 'UnsupportedMediaType', 'errorMessage' => 'The content type must be "application/json".', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'An internal error has occurred. Please retry.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Type\\": \\"FDL\\",\\n \\"Definition\\": \\"旧版：\\\\n\\\\\\"\\\\ntype: flow\\\\nversion: v1\\\\nname: my_flow_name\\\\nsteps:\\\\n - type: pass\\\\n name: mypass\\\\n\\\\\\"\\\\n\\\\n新版：\\\\n\\\\\\"\\\\nType: StateMachine\\\\nSpecVersion: v1\\\\nName: my_flow_name\\\\nStartAt: my_state\\\\nStates:\\\\n - Type: Pass\\\\n Name: my_state\\\\n End: true\\\\n\\\\\\"\\",\\n \\"RoleArn\\": \\"acs:ram:${region}:${accountID}:${role}\\",\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"Description\\": \\"my test flow\\",\\n \\"Name\\": \\"my_flow_name\\",\\n \\"CreatedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"LastModifiedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"Id\\": \\"e589e092-e2c0-4dee-b306-3574ddfdddf5****\\",\\n \\"ExecutionMode\\": \\"Standard\\",\\n \\"Environment\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"key\\",\\n \\"Value\\": \\"value\\",\\n \\"Description\\": \\"description\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '获取一个流程的相关信息', - ], - 'ListFlows' => [ - 'summary' => '批量查询流程信息。', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '98863', - 'abilityTreeNodes' => [ - 'FEATUREfnf8CPMA5', - ], - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => '流程查询开始名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'flow_nextxxx', - ], - ], - [ - 'name' => 'Limit', - 'in' => 'query', - 'schema' => [ - 'description' => '查询数量。取值范围\\[1,1000)，默认值为60。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => ''], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '流程列表。', - 'type' => 'object', - 'properties' => [ - 'NextToken' => [ - 'description' => '下次查询起始Key，如果没有其他数据则不返回。', - 'type' => 'string', - 'example' => 'flow_nextxxx', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'testRequestId', - ], - 'Flows' => [ - 'description' => '流程列表。', - 'type' => 'array', - 'items' => [ - 'description' => '流程列表。', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => '流程类型。', - 'type' => 'string', - 'example' => 'FDL', - ], - 'Definition' => [ - 'description' => '流程定义，遵循FDL语法标准。', - 'type' => 'string', - 'example' => 'version: v1.0\\ntype: flow\\nname: test\\nsteps:\\n - type: pass\\n name: mypass', - ], - 'RoleArn' => [ - 'description' => '流程执行所需资源描述符信息。', - 'type' => 'string', - 'example' => 'acs:ram::${accountID}:${role}', - ], - 'Description' => [ - 'description' => '流程描述。', - 'type' => 'string', - 'example' => 'my test flow', - ], - 'Name' => [ - 'description' => '流程名称。', - 'type' => 'string', - 'example' => 'my_flow_name', - ], - 'CreatedTime' => [ - 'description' => '流程创建时间。', - 'type' => 'string', - 'example' => '2019-01-01T01:01:01.001Z', - ], - 'LastModifiedTime' => [ - 'description' => '流程最后更改时间。', - 'type' => 'string', - 'example' => '2019-01-01T01:01:01.001Z', - ], - 'Id' => [ - 'description' => '流程的唯一ID。', - 'type' => 'string', - 'example' => 'e589e092-e2c0-4dee-b306-3574ddf5****', - ], - 'ExecutionMode' => [ - 'title' => '执行模式，枚举类型，可以是Express和Standard，空串等价于Standard', - 'description' => '执行模式，枚举类型，可以是Express和Standard，空串等价于Standard', - 'type' => 'string', - 'example' => 'Standard', - ], - 'Environment' => [ - 'title' => 'Flow 执行期间可以访问的变量列表', - 'description' => 'Flow 执行期间可以访问的变量列表', - 'type' => 'object', - 'properties' => [ - 'Variables' => [ - 'title' => 'Flow 执行期间可以访问的变量列表', - 'description' => 'Flow 执行期间可以访问的变量列表', - 'type' => 'array', - 'items' => [ - 'title' => 'Flow 执行期间可以访问的变量列表', - 'description' => 'Flow 执行期间可以访问的变量列表', - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'title' => '变量描述', - 'description' => '变量描述', - 'type' => 'string', - 'example' => 'description', - ], - 'Name' => [ - 'title' => '变量名称', - 'description' => '变量名称', - 'type' => 'string', - 'example' => 'key', - ], - 'Value' => [ - 'title' => '变量值', - 'description' => '变量值', - 'type' => 'string', - 'example' => 'value', - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"testRequestId\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '删除一个已存在的流程', + 'summary' => '删除一个已存在的流程。', + 'description' => '## 接口说明'."\n" + .'删除动作为异步删除，API调用成功后您将收到成功的返回。待删除后您重新建立的同名流程不会受到历史的流程影响。删除流程后，所有的历史执行信息将无法再查询，处于执行中的每个执行将会完成最近的一个步骤后停止。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'fnf:DeleteFlow', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ActionNotSupported', - 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', - ], - [ - 'errorCode' => 'APIVersionNotSupported', - 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', - ], - [ - 'errorCode' => 'InvalidArgument', - 'errorMessage' => 'Parameter error.', - ], - [ - 'errorCode' => 'MissingRequiredHeader', - 'errorMessage' => 'The HTTP header \'%s\' must be specified.', - ], - [ - 'errorCode' => 'MissingRequiredParams', - 'errorMessage' => 'The HTTP query \'%s\' must be specified.', - ], - ], - 403 => [ - [ - 'errorCode' => 'AccessDenied', - 'errorMessage' => 'The resources doesn\'t belong to you.', - ], - [ - 'errorCode' => 'InvalidAccessKeyID', - 'errorMessage' => 'The AccessKey ID %s is invalid.', - ], - [ - 'errorCode' => 'RequestTimeTooSkewed', - 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', - ], - [ - 'errorCode' => 'SignatureNotMatch', - 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', - ], - ], - 415 => [ - [ - 'errorCode' => 'UnsupportedMediaType', - 'errorMessage' => 'The content type must be "application/json".', - ], - ], - 429 => [ - [ - 'errorCode' => 'ResourceThrottled', - 'errorMessage' => 'The request is throttled. Please try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'An internal error has occurred. Please retry.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"flow_nextxxx\\",\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"Flows\\": [\\n {\\n \\"Type\\": \\"FDL\\",\\n \\"Definition\\": \\"version: v1.0\\\\\\\\ntype: flow\\\\\\\\nname: test\\\\\\\\nsteps:\\\\\\\\n - type: pass\\\\\\\\n name: mypass\\",\\n \\"RoleArn\\": \\"acs:ram::${accountID}:${role}\\",\\n \\"Description\\": \\"my test flow\\",\\n \\"Name\\": \\"my_flow_name\\",\\n \\"CreatedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"LastModifiedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"Id\\": \\"e589e092-e2c0-4dee-b306-3574ddf5****\\",\\n \\"ExecutionMode\\": \\"Standard\\",\\n \\"Environment\\": {\\n \\"Variables\\": [\\n {\\n \\"Description\\": \\"description\\",\\n \\"Name\\": \\"key\\",\\n \\"Value\\": \\"value\\"\\n }\\n ]\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '批量查询流程信息', ], - 'PublishFlowVersion' => [ - 'summary' => '以当前工作流的定义发布新的流程版本，版本号从1递增，流程版本会包含工作流定义、描述、环境变量设置和执行角色定义信息。', + 'DeleteFlowAlias' => [ + 'summary' => '删除流程别名', 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1547,12 +603,10 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', + 'operationType' => 'delete', + 'riskType' => 'high', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREfnf8CPMA5', - ], + 'abilityTreeNodes' => ['FEATUREfnf8CPMA5'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], @@ -1560,24 +614,12 @@ [ 'name' => 'FlowName', 'in' => 'formData', - 'schema' => [ - 'title' => '流程名称', - 'description' => '流程名称', - 'type' => 'string', - 'required' => true, - 'example' => 'example-flow-name', - ], + 'schema' => ['description' => 'Flow名称', 'type' => 'string', 'required' => true, 'example' => 'my_flow_name'], ], [ - 'name' => 'Description', + 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'title' => '版本描述', - 'description' => '版本描述', - 'type' => 'string', - 'required' => false, - 'example' => 'example flow description', - ], + 'schema' => ['description' => '别名名称', 'type' => 'string', 'required' => true, 'example' => 'alias_name'], ], ], 'responses' => [ @@ -1587,105 +629,50 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '294D68C1-5108-5971-853A-1A9CC87B4816', - ], - 'FlowName' => [ - 'title' => '流程名称', - 'description' => '流程名称', - 'type' => 'string', - 'example' => 'my-flow-name', - ], - 'Version' => [ - 'title' => '流程版本', - 'description' => '流程版本', - 'type' => 'string', - 'example' => '1', - ], - 'Description' => [ - 'title' => '流程版本描述', - 'description' => '流程版本描述', - 'type' => 'string', - 'example' => 'my flow description', - ], - 'CreatedTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2025-10-24T14:11:26+08:00', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3A44E113-9962-5B0B-AB92-14060EFE3164'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除指定的流程别名', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"294D68C1-5108-5971-853A-1A9CC87B4816\\",\\n \\"FlowName\\": \\"my-flow-name\\",\\n \\"Version\\": \\"1\\",\\n \\"Description\\": \\"my flow description\\",\\n \\"CreatedTime\\": \\"2025-10-24T14:11:26+08:00\\"\\n}","type":"json"}]', - 'title' => '发布流程版本', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3A44E113-9962-5B0B-AB92-14060EFE3164\\"\\n}","type":"json"}]', ], - 'ListFlowVersions' => [ - 'summary' => '查询流程版本列表', + 'DeleteFlowVersion' => [ + 'summary' => '删除流程版本', 'path' => '', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', + 'operationType' => 'delete', + 'riskType' => 'high', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREfnf8CPMA5', - ], + 'abilityTreeNodes' => ['FEATUREfnf8CPMA5'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'FlowName', - 'in' => 'query', - 'schema' => [ - 'title' => '流程名称', - 'description' => '流程名称', - 'type' => 'string', - 'required' => true, - 'example' => 'example-flow-name', - ], - ], - [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'title' => 'list token', - 'description' => 'list token', - 'type' => 'string', - 'required' => false, - 'example' => 'token', - ], + 'in' => 'formData', + 'schema' => ['title' => '流程名称', 'description' => '流程名称', 'type' => 'string', 'required' => true, 'example' => 'example-flow'], ], [ - 'name' => 'Limit', - 'in' => 'query', - 'schema' => [ - 'title' => '返回的最大结果数量', - 'description' => '返回的最大结果数量', - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + 'name' => 'FlowVersion', + 'in' => 'formData', + 'schema' => ['title' => '流程版本', 'description' => '流程版本', 'type' => 'string', 'required' => true, 'example' => '1'], ], ], 'responses' => [ @@ -1695,139 +682,107 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '294D68C1-5108-5971-853A-1A9CC87B4816', - ], - 'NextToken' => [ - 'title' => 'list token', - 'description' => 'list token', - 'type' => 'string', - 'example' => 'token', - ], - 'FlowVersions' => [ - 'title' => '流程版本列表', - 'description' => '流程版本列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Version' => [ - 'title' => '版本名称', - 'description' => '版本名称', - 'type' => 'string', - 'example' => '1', - ], - 'Description' => [ - 'title' => '版本描述', - 'description' => '版本描述', - 'type' => 'string', - 'example' => 'version description', - ], - 'CreatedTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2025-10-24T14:11:26+08:00', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3A44E113-9962-5B0B-AB92-14060EFE3164'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除指定的流程版本', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"294D68C1-5108-5971-853A-1A9CC87B4816\\",\\n \\"NextToken\\": \\"token\\",\\n \\"FlowVersions\\": [\\n {\\n \\"Version\\": \\"1\\",\\n \\"Description\\": \\"version description\\",\\n \\"CreatedTime\\": \\"2025-10-24T14:11:26+08:00\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询流程版本列表', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3A44E113-9962-5B0B-AB92-14060EFE3164\\"\\n}","type":"json"}]', ], - 'DeleteFlowVersion' => [ - 'summary' => '删除流程版本', - 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DeleteSchedule' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREfnf8CPMA5', - ], - 'autoTest' => true, + 'abilityTreeCode' => '98857', + 'abilityTreeNodes' => ['FEATUREfnf06LH4G'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'FlowName', 'in' => 'formData', - 'schema' => [ - 'title' => '流程名称', - 'description' => '流程名称', - 'type' => 'string', - 'required' => true, - 'example' => 'example-flow', - ], + 'schema' => ['description' => '待删除调度任务绑定的流程名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'flow'], ], [ - 'name' => 'FlowVersion', + 'name' => 'ScheduleName', 'in' => 'formData', - 'schema' => [ - 'title' => '流程版本', - 'description' => '流程版本', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '待删除调度的名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testScheduleName'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '3A44E113-9962-5B0B-AB92-14060EFE3164', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestId'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3A44E113-9962-5B0B-AB92-14060EFE3164\\"\\n}","type":"json"}]', - 'title' => '删除指定的流程版本', - ], - 'ListFlowAliases' => [ - 'summary' => '查询流程版本别名列表', - 'path' => '', - 'methods' => [ - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''], + ['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''], + ['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => ''], + ['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => ''], + ['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''], + ], + [ + ['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => ''], + ['errorCode' => 'ScheduleNotExists', 'errorMessage' => 'The schedule %s for flow %s does not exist.', 'description' => ''], + ], + 409 => [ + ['errorCode' => 'ConcurrentUpdateError', 'errorMessage' => 'Update conflict, please retry.', 'description' => ''], + ], + 412 => [ + ['errorCode' => 'PreconditionFailed', 'errorMessage' => 'The resource to be modified has been changed.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => ''], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"testRequestId\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '删除一个定时调度（仅适用于旧版工作流）', + 'summary' => '删除一个定时调度。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'fnf:DeleteSchedule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeExecution' => [ + 'summary' => '获取一次执行的状态信息，支持长轮询模式，长轮询最长等待时间由 WaitTimeSeconds 参数指定。', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1836,118 +791,75 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREfnf8CPMA5', - ], - 'autoTest' => true, + 'abilityTreeCode' => '98858', + 'abilityTreeNodes' => ['FEATUREfnf8CPMA5'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'FlowName', 'in' => 'query', - 'schema' => [ - 'title' => '流程名称', - 'description' => '流程名称', - 'type' => 'string', - 'required' => true, - 'example' => 'example-flow-name', - ], + 'schema' => ['description' => '流程名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_flow_name'], ], [ - 'name' => 'NextToken', + 'name' => 'ExecutionName', 'in' => 'query', - 'schema' => [ - 'title' => 'list token', - 'description' => 'list token', - 'type' => 'string', - 'required' => false, - 'example' => 'token', - ], + 'schema' => ['description' => '执行名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_exec_name'], ], [ - 'name' => 'Limit', + 'name' => 'WaitTimeSeconds', 'in' => 'query', - 'schema' => [ - 'title' => '最大返回的结果数量', - 'description' => '最大返回的结果数量', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '请求长轮询的最长等待时间。取值范围\\[0,60]，单位为秒。取值说明如下：'."\n" + .'- 取值等于0：请求立即返回当前执行状态。'."\n" + .'- 取值大于0：请求在服务端长轮询等待执行结束，最长等待设定的秒数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '3A44E113-9962-5B0B-AB92-14060EFE3164', - ], - 'NextToken' => [ - 'title' => 'list token', - 'description' => 'list token', - 'type' => 'string', - 'example' => 'testNextToken', - ], - 'Aliases' => [ - 'title' => '别名列表', - 'description' => '别名列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '别名名称', - 'description' => '别名名称', - 'type' => 'string', - 'example' => 'my-alias-name', - ], - 'Description' => [ - 'title' => '别名描述', - 'description' => '别名描述', - 'type' => 'string', - 'example' => 'my alias description', - ], - 'RoutingConfigurations' => [ - 'title' => '权重配置', - 'description' => '流量分发配置，支持配置一个或两个流程版本。当指定别名发起执行时，系统会根据权重选择对应的流程版本进行执行。', - 'type' => 'array', - 'items' => [ - 'description' => '流量分发配置，支持配置一个或两个流程版本。当指定别名发起执行时，系统会根据权重选择对应的流程版本进行执行。', - 'type' => 'object', - 'properties' => [ - 'Version' => [ - 'title' => '版本', - 'description' => '版本', - 'type' => 'string', - 'example' => '1', - ], - 'Weight' => [ - 'title' => '权重', - 'description' => '权重', - 'type' => 'string', - 'example' => '20', - ], - ], + 'Status' => ['description' => '执行状态。取值说明如下：'."\n" + .'- **Starting**'."\n" + .'- **Running**'."\n" + .'- **Stopped**'."\n" + .'- **Succeeded**'."\n" + .'- **Failed**'."\n" + .'- **TimedOut**', 'type' => 'string', 'example' => 'Succeeded'], + 'StoppedTime' => ['description' => '执行停止时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestId'], + 'StartedTime' => ['description' => '执行开始时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'], + 'FlowDefinition' => ['description' => '执行的流程定义。', 'type' => 'string', 'example' => 'Legacy version:'."\n" + .'"type: flow\\nversion: v1\\nname: my_flow_name\\nsteps:\\n - type: pass\\n name: mypass"'."\n" + ."\n" + .'New version:'."\n" + .'"Type: StateMachine\\nSpecVersion: v1\\nName: my_flow_name\\nStartAt: my_state\\nStates:\\n - Type: Pass\\n Name: my_state\\n End: true"'], + 'Output' => ['description' => '执行的输出，为JSON对象格式。', 'type' => 'string', 'example' => '{"key":"value"}'], + 'FlowName' => ['description' => '流程名称。', 'type' => 'string', 'example' => 'my_flow_name'], + 'Name' => ['description' => '执行名称。', 'type' => 'string', 'example' => 'my_exec_name'], + 'Input' => ['description' => '执行的输入，为JSON对象格式。', 'type' => 'string', 'example' => '{"key":"value"}'], + 'Environment' => [ + 'title' => 'Flow 执行时使用的环境变量列表', + 'description' => 'Flow 执行时使用的环境变量列表', + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'title' => 'Flow 执行时使用的环境变量列表', + 'description' => 'Flow 执行时使用的环境变量列表', + 'type' => 'array', + 'items' => [ + 'title' => 'Flow 执行期间可以访问的变量列表', + 'description' => 'Flow 执行期间可以访问的变量列表', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '变量名称', 'description' => '变量名称', 'type' => 'string', 'example' => 'key'], + 'Value' => ['title' => '变量值', 'description' => '变量值', 'type' => 'string', 'example' => 'value'], ], ], - 'CreatedTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2025-10-24T14:11:26+08:00', - ], ], ], ], @@ -1955,187 +867,62 @@ ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3A44E113-9962-5B0B-AB92-14060EFE3164\\",\\n \\"NextToken\\": \\"testNextToken\\",\\n \\"Aliases\\": [\\n {\\n \\"Name\\": \\"my-alias-name\\",\\n \\"Description\\": \\"my alias description\\",\\n \\"RoutingConfigurations\\": [\\n {\\n \\"Version\\": \\"1\\",\\n \\"Weight\\": \\"20\\"\\n }\\n ],\\n \\"CreatedTime\\": \\"2025-10-24T14:11:26+08:00\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询流程别名列表', - ], - 'CreateFlowAlias' => [ - 'summary' => '为流程创建别名，此后可以在发起执行时指定流程别名', - 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => '请求参数错误。具体内容请参考实际错误信息。'], + ['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'], + ['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'], + ['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''], + ['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''], + ['errorCode' => 'EntityTooLarge', 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', 'description' => '请求消息体过大。'], ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREfnf8CPMA5', + 403 => [ + ['errorCode' => 'InvalidAccessKeyID', 'errorMessage' => 'The AccessKey ID %s is invalid.', 'description' => 'AccessKey ID无效。'], + ['errorCode' => 'RequestTimeTooSkewed', 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', 'description' => '您的请求时间不正确，该请求已被识别为无效。请参考通用参数一节。'], + ['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => '您发起请求的签名与我们计算不一致，请检查您的签名算法及AccessKey Secret。'], + ['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''], ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ [ - 'name' => 'FlowName', - 'in' => 'formData', - 'schema' => [ - 'title' => '流程名称', - 'description' => '流程名称', - 'type' => 'string', - 'required' => true, - 'example' => 'example-flow-name', - ], + ['errorCode' => 'ExecutionNotExists', 'errorMessage' => 'Execution %s for flow %s does not exist.', 'description' => '所请求资源不存在，请确保流程已创建并存在待查询的执行。'], + ['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => '所请求资源不存在，请确保流程已创建。'], ], - [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'title' => '别名名称', - 'description' => '别名名称', - 'type' => 'string', - 'required' => true, - 'example' => 'example-alias-name', - ], + 412 => [ + ['errorCode' => 'PreconditionFailed', 'errorMessage' => 'The resource to be modified has been changed.', 'description' => '资源查看或更新检查失败，该资源可能已被更改。请稍后重试。'], ], - [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'title' => '别名描述', - 'description' => '别名描述', - 'type' => 'string', - 'required' => false, - 'example' => 'example description', - ], + 415 => [ + ['errorCode' => 'UnsupportedMediaType', 'errorMessage' => 'The content type must be "application/json".', 'description' => '请求消息体类型错误。'], ], - [ - 'name' => 'RoutingConfigurations', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '流量分发设置', - 'description' => '流量分发配置，支持配置一个或两个流程版本。当指定别名发起执行时，系统会根据权重选择对应的流程版本进行执行。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Version' => [ - 'title' => '流程版本', - 'description' => '流程版本', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'Weight' => [ - 'title' => '权重', - 'description' => '权重', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '30', - ], - ], - 'required' => false, - ], - 'required' => true, - ], + 429 => [ + ['errorCode' => 'ResourceThrottled', 'errorMessage' => 'The request is throttled. Please try again later.', 'description' => '因某些原因系统流量已达瓶颈。请稍后重试。'], + ], + 500 => [ + ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => '服务器内部错误。请稍后重试。'], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'testRequestID', - ], - 'FlowName' => [ - 'title' => '流程名称', - 'description' => '流程名称', - 'type' => 'string', - 'example' => 'example-flow-name', - ], - 'Name' => [ - 'title' => '别名名称', - 'description' => '别名名称', - 'type' => 'string', - 'example' => 'exampe-alias-name', - ], - 'Description' => [ - 'title' => '别名描述', - 'description' => '别名描述', - 'type' => 'string', - 'example' => 'example description', - ], - 'RoutingConfigurations' => [ - 'description' => '流量分发配置，支持配置一个或两个流程版本。当指定别名发起执行时，系统会根据权重选择对应的流程版本进行执行。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Version' => [ - 'title' => '版本名称', - 'description' => '版本名称', - 'type' => 'string', - 'example' => '1', - ], - 'Weight' => [ - 'title' => '权重', - 'description' => '权重', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - ], - ], - ], - 'CreatedTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2020-01-01T01:01:01.001Z', - ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"Succeeded\\",\\n \\"StoppedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"StartedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"FlowDefinition\\": \\"Legacy version:\\\\n\\\\\\"type: flow\\\\\\\\nversion: v1\\\\\\\\nname: my_flow_name\\\\\\\\nsteps:\\\\\\\\n - type: pass\\\\\\\\n name: mypass\\\\\\"\\\\n\\\\nNew version:\\\\n\\\\\\"Type: StateMachine\\\\\\\\nSpecVersion: v1\\\\\\\\nName: my_flow_name\\\\\\\\nStartAt: my_state\\\\\\\\nStates:\\\\\\\\n - Type: Pass\\\\\\\\n Name: my_state\\\\\\\\n End: true\\\\\\"\\",\\n \\"Output\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"FlowName\\": \\"my_flow_name\\",\\n \\"Name\\": \\"my_exec_name\\",\\n \\"Input\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"Environment\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"key\\",\\n \\"Value\\": \\"value\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '获取一次执行的状态信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'fnf:DescribeExecution', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"testRequestID\\",\\n \\"FlowName\\": \\"example-flow-name\\",\\n \\"Name\\": \\"exampe-alias-name\\",\\n \\"Description\\": \\"example description\\",\\n \\"RoutingConfigurations\\": [\\n {\\n \\"Version\\": \\"1\\",\\n \\"Weight\\": 30\\n }\\n ],\\n \\"CreatedTime\\": \\"2020-01-01T01:01:01.001Z\\"\\n}","type":"json"}]', - 'title' => '创建一个流程别名', - 'description' => '## 接口说明'."\n" - .'- 每个用户所能创建的流程个数受资源限制（详见[使用限制](~~122093~~)），如果您有特殊需求，可以提工单进行调整。'."\n" - .'- 流程在用户级别是按照名称来区分的，即单一账号下不可以存在同名流程。', ], - 'DescribeFlowAlias' => [ - 'summary' => '查询流程版本别名详情', - 'path' => '', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DescribeFlow' => [ + 'summary' => '获取一个流程的相关信息。', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2147,199 +934,166 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREfnf8CPMA5', - ], - 'autoTest' => true, + 'abilityTreeCode' => '98859', + 'abilityTreeNodes' => ['FEATUREfnf8CPMA5'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'FlowName', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '流程名称', - 'description' => '流程名称', - 'type' => 'string', - 'required' => true, - 'example' => 'example-flow-name', - ], + 'schema' => ['description' => '流程名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_flow_name'], ], [ - 'name' => 'Name', + 'name' => 'FlowVersion', 'in' => 'query', - 'schema' => [ - 'title' => '别名', - 'description' => '别名', - 'type' => 'string', - 'required' => true, - 'example' => 'example-alias-name', - ], + 'schema' => ['title' => '版本', 'description' => '版本', 'type' => 'string', 'required' => false, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '294D68C1-5108-5971-853A-1A9CC87B4816', - ], - 'Alias' => [ - 'title' => '别名信息', - 'description' => '别名信息', + 'Type' => ['description' => '流程类型。', 'type' => 'string', 'example' => 'FDL'], + 'Definition' => ['description' => '流程定义，遵循Flow Definition Language (FDL)语法标准。考虑到向前兼容，当系统支持两种规范的流程定义规范。', 'type' => 'string', 'example' => 'Legacy version:'."\n" + .'"'."\n" + .'type: flow'."\n" + .'version: v1'."\n" + .'name: my_flow_name'."\n" + .'steps:'."\n" + .' - type: pass'."\n" + .' name: mypass'."\n" + .'"'."\n" + ."\n" + .'New version:'."\n" + .'"'."\n" + .'Type: StateMachine'."\n" + .'SpecVersion: v1'."\n" + .'Name: my_flow_name'."\n" + .'StartAt: my_state'."\n" + .'States:'."\n" + .' - Type: Pass'."\n" + .' Name: my_state'."\n" + .' End: true'."\n" + .'"'], + 'RoleArn' => ['description' => '流程执行依赖的授权角色资源描述符信息。用于在执行流程时，Serverless 工作流服务扮演该角色（AssumeRole）操作相关的流程资源。', 'type' => 'string', 'example' => 'acs:ram:${region}:${accountID}:${role}'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestId'], + 'Description' => ['description' => '流程描述。', 'type' => 'string', 'example' => 'my test flow'], + 'Name' => ['description' => '流程名称。', 'type' => 'string', 'example' => 'my_flow_name'], + 'CreatedTime' => ['description' => '流程创建时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'], + 'LastModifiedTime' => ['description' => '流程最近一次的更改时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'], + 'Id' => ['description' => '流程的唯一ID。', 'type' => 'string', 'example' => 'e589e092-e2c0-4dee-b306-3574ddfdddf5****'], + 'ExecutionMode' => ['title' => '执行模式，枚举类型，可以是Express和Standard，空串等价于Standard', 'description' => '执行模式，枚举类型，可以是Express和Standard，空串等价于Standard', 'type' => 'string', 'example' => 'Standard'], + 'Environment' => [ + 'title' => 'Flow 执行期间可以访问的变量列表', + 'description' => 'Flow 执行期间可以访问的变量列表', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '别名名称', - 'description' => '别名名称', - 'type' => 'string', - 'example' => 'alias-name', - ], - 'Description' => [ - 'title' => '别名描述', - 'description' => '别名描述', - 'type' => 'string', - 'example' => 'alias description', - ], - 'RoutingConfigurations' => [ - 'title' => '权重配置', - 'description' => '权重配置', + 'Variables' => [ + 'title' => 'Flow 执行期间可以访问的变量列表', + 'description' => 'Flow 执行期间可以访问的变量列表', 'type' => 'array', 'items' => [ + 'title' => 'Flow 执行期间可以访问的变量列表', + 'description' => 'Flow 执行期间可以访问的变量列表', 'type' => 'object', 'properties' => [ - 'Version' => [ - 'title' => '版本', - 'description' => '版本', - 'type' => 'string', - 'example' => '1', - ], - 'Weight' => [ - 'title' => '权重', - 'description' => '权重', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'Name' => ['title' => '变量名称', 'description' => '变量名称', 'type' => 'string', 'example' => 'key'], + 'Value' => ['title' => '变量值', 'description' => '变量值', 'type' => 'string', 'example' => 'value'], + 'Description' => ['title' => '变量描述', 'description' => '变量描述', 'type' => 'string', 'example' => 'description'], ], ], ], - 'CreatedTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2024-04-22T06:09:39.907Z', - ], ], ], + 'ResourceGroupId' => ['title' => '资源组id', 'type' => 'string', 'example' => 'rg-xxx'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''], + ['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''], + ['errorCode' => 'EntityTooLarge', 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', 'description' => '请求消息体过大。'], + ['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => '请求参数错误。具体内容请参考实际错误信息。'], + ['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'], + ['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'], + ], + 403 => [ + ['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''], + ['errorCode' => 'InvalidAccessKeyID', 'errorMessage' => 'The AccessKey ID %s is invalid.', 'description' => 'AccessKey ID无效。'], + ['errorCode' => 'RequestTimeTooSkewed', 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', 'description' => '您的请求时间不正确，该请求已被识别为无效。请参考通用参数一节。'], + ['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => '您发起请求的签名与我们计算不一致，请检查您的签名算法及AccessKey Secret。'], + ], + [ + ['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => '所请求资源不存在，请确保流程已创建。'], + ], + 412 => [ + ['errorCode' => 'PreconditionFailed', 'errorMessage' => 'The resource to be modified has been changed.', 'description' => '资源查看或更新检查失败，该资源可能已被更改。请稍后重试。'], + ], + 415 => [ + ['errorCode' => 'UnsupportedMediaType', 'errorMessage' => 'The content type must be "application/json".', 'description' => '请求消息体类型错误。'], + ], + 429 => [ + ['errorCode' => 'ResourceThrottled', 'errorMessage' => 'The request is throttled. Please try again later.', 'description' => '因某些原因系统流量已达瓶颈。请稍后重试。'], + ], + 500 => [ + ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => '服务器内部错误。请稍后重试。'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Type\\": \\"FDL\\",\\n \\"Definition\\": \\"Legacy version:\\\\n\\\\\\"\\\\ntype: flow\\\\nversion: v1\\\\nname: my_flow_name\\\\nsteps:\\\\n - type: pass\\\\n name: mypass\\\\n\\\\\\"\\\\n\\\\nNew version:\\\\n\\\\\\"\\\\nType: StateMachine\\\\nSpecVersion: v1\\\\nName: my_flow_name\\\\nStartAt: my_state\\\\nStates:\\\\n - Type: Pass\\\\n Name: my_state\\\\n End: true\\\\n\\\\\\"\\",\\n \\"RoleArn\\": \\"acs:ram:${region}:${accountID}:${role}\\",\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"Description\\": \\"my test flow\\",\\n \\"Name\\": \\"my_flow_name\\",\\n \\"CreatedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"LastModifiedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"Id\\": \\"e589e092-e2c0-4dee-b306-3574ddfdddf5****\\",\\n \\"ExecutionMode\\": \\"Standard\\",\\n \\"Environment\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"key\\",\\n \\"Value\\": \\"value\\",\\n \\"Description\\": \\"description\\"\\n }\\n ]\\n },\\n \\"ResourceGroupId\\": \\"rg-xxx\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '获取一个流程的相关信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'fnf:DescribeFlow', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"294D68C1-5108-5971-853A-1A9CC87B4816\\",\\n \\"Alias\\": {\\n \\"Name\\": \\"alias-name\\",\\n \\"Description\\": \\"alias description\\",\\n \\"RoutingConfigurations\\": [\\n {\\n \\"Version\\": \\"1\\",\\n \\"Weight\\": 10\\n }\\n ],\\n \\"CreatedTime\\": \\"2024-04-22T06:09:39.907Z\\"\\n }\\n}","type":"json"}]', - 'title' => '查询指定的流程别名配置', ], - 'UpdateFlowAlias' => [ - 'summary' => '更新流程版本别名配置', + 'DescribeFlowAlias' => [ + 'summary' => '查询流程版本别名详情', 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREfnf8CPMA5', - ], + 'abilityTreeNodes' => ['FEATUREfnf8CPMA5'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'FlowName', - 'in' => 'formData', - 'schema' => [ - 'title' => '流程名称', - 'description' => '流程名称', - 'type' => 'string', - 'required' => true, - 'example' => 'example-flow-name', - ], + 'in' => 'query', + 'schema' => ['title' => '流程名称', 'description' => '流程名称', 'type' => 'string', 'required' => true, 'example' => 'example-flow-name'], ], [ 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'title' => '别名名称', - 'description' => '别名名称', - 'type' => 'string', - 'required' => true, - 'example' => 'alias name', - ], - ], - [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'title' => '别名描述', - 'description' => '别名描述', - 'type' => 'string', - 'required' => false, - 'example' => 'example description', - ], - ], - [ - 'name' => 'RoutingConfigurations', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '权重配置', - 'description' => '权重配置', - 'type' => 'array', - 'items' => [ - 'description' => '流量分发配置，支持配置一个或两个流程版本。当指定别名发起执行时，系统会根据权重选择对应的流程版本进行执行。', - 'type' => 'object', - 'properties' => [ - 'Version' => [ - 'title' => '版本', - 'description' => '版本', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'Weight' => [ - 'description' => '权重', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'in' => 'query', + 'schema' => ['title' => '别名', 'description' => '别名', 'type' => 'string', 'required' => true, 'example' => 'example-alias-name'], ], ], 'responses' => [ @@ -2349,288 +1103,229 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '294D68C1-5108-5971-853A-1A9CC87B4816', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '294D68C1-5108-5971-853A-1A9CC87B4816'], 'Alias' => [ 'title' => '别名信息', 'description' => '别名信息', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '别名名称', - 'description' => '别名名称', - 'type' => 'string', - 'example' => 'my-alias-name', - ], - 'Description' => [ - 'title' => '别名描述', - 'description' => '别名描述', - 'type' => 'string', - 'example' => 'my alias description', - ], + 'Name' => ['title' => '别名名称', 'description' => '别名名称', 'type' => 'string', 'example' => 'alias-name'], + 'Description' => ['title' => '别名描述', 'description' => '别名描述', 'type' => 'string', 'example' => 'alias description'], 'RoutingConfigurations' => [ 'title' => '权重配置', 'description' => '权重配置', 'type' => 'array', 'items' => [ - 'description' => '流量分发配置，支持配置一个或两个流程版本。当指定别名发起执行时，系统会根据权重选择对应的流程版本进行执行。', 'type' => 'object', 'properties' => [ - 'Version' => [ - 'title' => '版本', - 'description' => '版本', - 'type' => 'string', - 'example' => '1', - ], - 'Weight' => [ - 'title' => '权重', - 'description' => '权重', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], + 'Version' => ['title' => '版本', 'description' => '版本', 'type' => 'string', 'example' => '1'], + 'Weight' => ['title' => '权重', 'description' => '权重', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], ], ], - 'CreatedTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2025-10-24T14:11:26+08:00', - ], + 'CreatedTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-04-22T06:09:39.907Z'], ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询指定的流程别名配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"294D68C1-5108-5971-853A-1A9CC87B4816\\",\\n \\"Alias\\": {\\n \\"Name\\": \\"my-alias-name\\",\\n \\"Description\\": \\"my alias description\\",\\n \\"RoutingConfigurations\\": [\\n {\\n \\"Version\\": \\"1\\",\\n \\"Weight\\": 20\\n }\\n ],\\n \\"CreatedTime\\": \\"2025-10-24T14:11:26+08:00\\"\\n }\\n}","type":"json"}]', - 'title' => '更新流程别名配置', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"294D68C1-5108-5971-853A-1A9CC87B4816\\",\\n \\"Alias\\": {\\n \\"Name\\": \\"alias-name\\",\\n \\"Description\\": \\"alias description\\",\\n \\"RoutingConfigurations\\": [\\n {\\n \\"Version\\": \\"1\\",\\n \\"Weight\\": 10\\n }\\n ],\\n \\"CreatedTime\\": \\"2024-04-22T06:09:39.907Z\\"\\n }\\n}","type":"json"}]', ], - 'DeleteFlowAlias' => [ - 'summary' => '删除流程别名', - 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DescribeMapRun' => [ + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', + 'operationType' => 'get', + 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREfnf8CPMA5', - ], - 'autoTest' => true, + 'abilityTreeCode' => '227531', + 'abilityTreeNodes' => ['FEATUREfnfR0JC2A'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ + 'name' => 'RequestId', + 'in' => 'query', + 'schema' => ['description' => '请求ID。', 'type' => 'string', 'required' => false, 'example' => '3A44E113-9962-5B0B-AB92-14060EFE3164'], + ], + [ 'name' => 'FlowName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Flow名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my_flow_name', - ], + 'in' => 'query', + 'schema' => ['description' => '流程名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_flow_name'], ], [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'description' => '别名名称', - 'type' => 'string', - 'required' => true, - 'example' => 'alias_name', - ], + 'name' => 'ExecutionName', + 'in' => 'query', + 'schema' => ['description' => '执行名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_exec_name'], + ], + [ + 'name' => 'MapRunName', + 'in' => 'query', + 'schema' => ['description' => 'MapRun 名称，当 Execution 中发起 MapRun 执行后，会产生 MapRunStarted 事件，MapRunName 可以从 MapRunStarted 事件的 Output 中获取。', 'type' => 'string', 'required' => true, 'example' => 'c39142f1345b196d678333c41f113200'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '3A44E113-9962-5B0B-AB92-14060EFE3164', + 'Status' => ['description' => '执行状态。取值说明如下：'."\n" + .'- **Pending**'."\n" + .'- **Running**'."\n" + .'- **Failed**'."\n" + .'- **Succeeded**'."\n" + .'- **Aborted**', 'type' => 'string', 'example' => 'Succeeded'], + 'StoppedTime' => ['description' => '执行停止时间。', 'type' => 'string', 'example' => '2025-10-24T14:11:28+08:00'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3A44E113-9962-5B0B-AB92-14060EFE3164'], + 'StartedTime' => ['description' => '执行开始时间。', 'type' => 'string', 'example' => '2025-10-24T14:11:26+08:00'], + 'Concurrency' => ['description' => 'MapRun 运行时的并发限制。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ToleratedFailedCount' => ['description' => '允许失败的 Item 数量的最大值', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'ToleratedFailedPercentage' => ['description' => '允许失败的 Item 数量占全部 Item 数量的最大百分比', 'type' => 'number', 'format' => 'float', 'example' => '20'], + 'ExecutionName' => ['description' => '执行名称', 'type' => 'string', 'example' => 'my_exec_name'], + 'MapRunName' => ['description' => 'MapRun 名称', 'type' => 'string', 'example' => 'c39142f1345b196d678333c41f113000'], + 'ItemCounts' => [ + 'description' => 'MapRun 任务中处于不同处理状态的 Item 数量汇总', + 'type' => 'object', + 'properties' => [ + 'Pending' => ['description' => '待开始的 Item 数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'Running' => ['description' => '正在处理的 Item 数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'Succeed' => ['description' => '处理完成的 Item 数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'Failed' => ['description' => '处理失败的 Item 数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'Aborted' => ['description' => '处理终止的 Item 数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'Total' => ['description' => 'Item 总数量', 'type' => 'integer', 'format' => 'int64', 'example' => '500'], + ], ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3A44E113-9962-5B0B-AB92-14060EFE3164\\"\\n}","type":"json"}]', - 'title' => '删除指定的流程别名', - ], - 'StartExecution' => [ - 'summary' => '开始一个流程的执行。', - 'methods' => [ - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => '请求参数错误。具体内容请参考实际错误信息。'], + ['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'], + ['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'], + ['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''], + ['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''], + ['errorCode' => 'EntityTooLarge', 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', 'description' => '请求消息体过大。'], + ], + 403 => [ + ['errorCode' => 'InvalidAccessKeyID', 'errorMessage' => 'The AccessKey ID %s is invalid.', 'description' => 'AccessKey ID无效。'], + ['errorCode' => 'RequestTimeTooSkewed', 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', 'description' => '您的请求时间不正确，该请求已被识别为无效。请参考通用参数一节。'], + ['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => '您发起请求的签名与我们计算不一致，请检查您的签名算法及AccessKey Secret。'], + ['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''], + ], + [ + ['errorCode' => 'ExecutionNotExists', 'errorMessage' => 'Execution %s for flow %s does not exist.', 'description' => '所请求资源不存在，请确保流程已创建并存在待查询的执行。'], + ['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => '所请求资源不存在，请确保流程已创建。'], + ], + 412 => [ + ['errorCode' => 'PreconditionFailed', 'errorMessage' => 'The resource to be modified has been changed.', 'description' => '资源查看或更新检查失败，该资源可能已被更改。请稍后重试。'], + ], + 415 => [ + ['errorCode' => 'UnsupportedMediaType', 'errorMessage' => 'The content type must be "application/json".', 'description' => '请求消息体类型错误。'], + ], + 429 => [ + ['errorCode' => 'ResourceThrottled', 'errorMessage' => 'The request is throttled. Please try again later.', 'description' => '因某些原因系统流量已达瓶颈。请稍后重试。'], + ], + 500 => [ + ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => '服务器内部错误。请稍后重试。'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询 MapRun 执行详情', + 'summary' => '查询 MapRun 详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"Succeeded\\",\\n \\"StoppedTime\\": \\"2025-10-24T14:11:28+08:00\\",\\n \\"RequestId\\": \\"3A44E113-9962-5B0B-AB92-14060EFE3164\\",\\n \\"StartedTime\\": \\"2025-10-24T14:11:26+08:00\\",\\n \\"Concurrency\\": 1,\\n \\"ToleratedFailedCount\\": 100,\\n \\"ToleratedFailedPercentage\\": 20,\\n \\"ExecutionName\\": \\"my_exec_name\\",\\n \\"MapRunName\\": \\"c39142f1345b196d678333c41f113000\\",\\n \\"ItemCounts\\": {\\n \\"Pending\\": 100,\\n \\"Running\\": 100,\\n \\"Succeed\\": 100,\\n \\"Failed\\": 100,\\n \\"Aborted\\": 100,\\n \\"Total\\": 500\\n }\\n}","type":"json"}]', + ], + 'DescribeRegions' => [ + 'summary' => '查询云工作流产品支持的地域信息。', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '98867', - 'abilityTreeNodes' => [ - 'FEATUREfnf8CPMA5', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '264118', + 'abilityTreeNodes' => ['FEATUREfnf8CPMA5'], + 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'FlowName', - 'in' => 'formData', - 'schema' => [ - 'description' => '开始执行的流程名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_flow_name', - ], - ], - [ - 'name' => 'ExecutionName', + 'name' => 'AcceptLanguage', 'in' => 'formData', 'schema' => [ - 'description' => '执行名称，在同一流程内唯一。取值说明如下：'."\n" + 'title' => '根据汉语、英语筛选返回结果。更多详情，请参见RFC 7231。取值范围：'."\n" ."\n" - .'- 首字母必须为英文字母（a~z）、（A~Z）或下划线（_）。'."\n" - .'- 支持英文字符（a~z）或（A~Z）、数字（0~9）、下划线（_）和短划线（-）。'."\n" - .'- 区分大小写。'."\n" - .'- 长度为1~128个字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'my_exec_name', - ], - ], - [ - 'name' => 'Input', - 'in' => 'formData', - 'schema' => [ - 'description' => '执行的输入，为JSON对象格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{"key":"value"}', - ], - ], - [ - 'name' => 'CallbackFnFTaskToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '流程执行结束后回调**TaskToken**相关任务。', - 'type' => 'string', - 'required' => false, - 'example' => '12', - ], - ], - [ - 'name' => 'Qualifier', - 'in' => 'formData', - 'schema' => [ - 'title' => '指定流程版本或别名', - 'description' => '指定流程版本或别名', + .'zh-CN：简体中文。'."\n" + .'en-US：英文。'."\n" + .'默认值：zh-CN。', + 'description' => '根据汉语、英语筛选返回结果。更多详情，请参见RFC 7231。取值范围：'."\n" + ."\n" + .'zh-CN：简体中文。'."\n" + .'en-US：英文。'."\n" + .'默认值：zh-CN。', 'type' => 'string', 'required' => false, - 'example' => '1', + 'example' => 'zh-CN', + 'default' => 'zh-CN', + 'enum' => ['zh-CN', 'en-US'], ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回数据。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '执行状态。取值说明如下：'."\n" - .'- **Starting**'."\n" - .'- **Running**'."\n" - .'- **Stopped**'."\n" - .'- **Succeeded**'."\n" - .'- **Failed**'."\n" - .'- **TimedOut**', - 'type' => 'string', - 'example' => 'Succeeded', - ], - 'StoppedTime' => [ - 'description' => '执行停止时间。', - 'type' => 'string', - 'example' => '2019-01-01T01:01:01.001Z', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'testRequestId', - ], - 'StartedTime' => [ - 'description' => '执行开始时间。', - 'type' => 'string', - 'example' => '2019-01-01T01:01:01.001Z', - ], - 'FlowDefinition' => [ - 'description' => '执行的流程定义。', - 'type' => 'string', - 'example' => '旧版：'."\n" - .'"type: flow\\nversion: v1\\nname: my_flow_name\\nsteps:\\n - type: pass\\n name: mypass"'."\n" - ."\n" - .'新版：'."\n" - .'"Type: StateMachine\\nSpecVersion: v1\\nName: my_flow_name\\nStartAt: my_state\\nStates:\\n - Type: Pass\\n Name: my_state\\n End: true"', - ], - 'Output' => [ - 'description' => '执行的输出，为JSON对象格式。', - 'type' => 'string', - 'example' => '{"key":"value"}', - ], - 'FlowName' => [ - 'description' => '流程名称。', - 'type' => 'string', - 'example' => 'my_flow_name', - ], - 'Name' => [ - 'description' => '执行名称。', - 'type' => 'string', - 'example' => 'my_exec_name', - ], - 'Input' => [ - 'description' => '执行的输入，为JSON对象格式。', - 'type' => 'string', - 'example' => '{"key":"value"}', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0aa3f793-6e5f-8472-c7a2-70d2b84c04ac'], + 'Regions' => [ + 'description' => '地域信息。', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => '地域信息集合。', + 'type' => 'array', + 'items' => [ + 'description' => '地域对象。', + 'type' => 'object', + 'properties' => [ + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-qingdao'], + 'RegionEndpoint' => ['description' => '地域对应的公网接入点。', 'type' => 'string', 'example' => 'cn-qingdao.fnf.aliyuncs.com'], + 'LocalName' => ['description' => '地域名称。', 'type' => 'string', 'example' => 'China (Qingdao)'], + ], + ], + ], + ], ], ], ], @@ -2638,152 +1333,73 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ActionNotSupported', - 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', - ], - [ - 'errorCode' => 'APIVersionNotSupported', - 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', - ], - [ - 'errorCode' => 'EntityTooLarge', - 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', - ], - [ - 'errorCode' => 'ExecutionAlreadyExists', - 'errorMessage' => 'Execution %s for flow %s already exists.', - ], - [ - 'errorCode' => 'InvalidArgument', - 'errorMessage' => 'Parameter error.', - ], - [ - 'errorCode' => 'MissingRequiredHeader', - 'errorMessage' => 'The HTTP header \'%s\' must be specified.', - ], - [ - 'errorCode' => 'MissingRequiredParams', - 'errorMessage' => 'The HTTP query \'%s\' must be specified.', - ], + ['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation %s is incorrect. Please check.', 'description' => '所请求方法错误。请参照API文档并检查拼写。'], + ['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version %s is not supported yet. Please check.', 'description' => '所请求接口版本不正确。请参考API简介。'], ], 403 => [ - [ - 'errorCode' => 'AccessDenied', - 'errorMessage' => 'The resources doesn\'t belong to you.', - ], - [ - 'errorCode' => 'InvalidAccessKeyID', - 'errorMessage' => 'The AccessKey ID %s is invalid.', - ], - [ - 'errorCode' => 'RequestTimeTooSkewed', - 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', - ], - [ - 'errorCode' => 'SignatureNotMatch', - 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', - ], - ], - [ - [ - 'errorCode' => 'FlowNotExists', - 'errorMessage' => 'Flow %s does not exist.', - ], - ], - 415 => [ - [ - 'errorCode' => 'UnsupportedMediaType', - 'errorMessage' => 'The content type must be "application/json".', - ], - ], - 429 => [ - [ - 'errorCode' => 'ResourceThrottled', - 'errorMessage' => 'The request is throttled. Please try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'An internal error has occurred. Please retry.', - ], + ['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => '您发起请求的签名与我们计算不一致，请检查您的签名算法及AccessKey Secret。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"Succeeded\\",\\n \\"StoppedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"StartedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"FlowDefinition\\": \\"旧版：\\\\n\\\\\\"type: flow\\\\\\\\nversion: v1\\\\\\\\nname: my_flow_name\\\\\\\\nsteps:\\\\\\\\n - type: pass\\\\\\\\n name: mypass\\\\\\"\\\\n\\\\n新版：\\\\n\\\\\\"Type: StateMachine\\\\\\\\nSpecVersion: v1\\\\\\\\nName: my_flow_name\\\\\\\\nStartAt: my_state\\\\\\\\nStates:\\\\\\\\n - Type: Pass\\\\\\\\n Name: my_state\\\\\\\\n End: true\\\\\\"\\",\\n \\"Output\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"FlowName\\": \\"my_flow_name\\",\\n \\"Name\\": \\"my_exec_name\\",\\n \\"Input\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '异步调用开始一个流程的执行', - 'description' => '## 接口说明'."\n" - .'- 流程必须已经存在，当前仅支持 Standard 执行模式的流程。'."\n" - .'- 如果没有指定执行名称，则服务会自动生成执行名称并开始执行。'."\n" - .'- 如果有同名执行正在进行，则不会开始新的执行，直接返回正在进行中的同名执行。'."\n" - .'- 如果同名执行已经结束（成功或者失败），则会返回`ExecutionAlreadyExists`。'."\n" - .'- 如果没有同名执行，则开始新的执行。', - ], - 'StopExecution' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0aa3f793-6e5f-8472-c7a2-70d2b84c04ac\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"RegionId\\": \\"cn-qingdao\\",\\n \\"RegionEndpoint\\": \\"cn-qingdao.fnf.aliyuncs.com\\",\\n \\"LocalName\\": \\"China (Qingdao)\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询地域信息', + 'responseParamsDescription' => '正常返回示例'."\n" + .'JSON格式'."\n" + .'```json'."\n" + .'{'."\n" + .' "RequestId": "67623904-2da4-d950-c8c0-7c68573899ab",'."\n" + .' "Regions": {'."\n" + .' "Region": ['."\n" + .' {'."\n" + .' "RegionId": "cn-qingdao",'."\n" + .' "RegionEndpoint": "cn-qingdao.fnf.aliyuncs.com",'."\n" + .' "LocalName": "华北1（青岛）"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}'."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'DescribeSchedule' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '98868', - 'abilityTreeNodes' => [ - 'FEATUREfnf8CPMA5', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '98860', + 'abilityTreeNodes' => ['FEATUREfnf06LH4G'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'FlowName', - 'in' => 'formData', - 'schema' => [ - 'description' => '需要停止的流程名称，可以通过**ListFlows**的返回值获取。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_flow_name', - ], - ], - [ - 'name' => 'ExecutionName', - 'in' => 'formData', - 'schema' => [ - 'description' => '需要停止的执行名称，可以通过**ListExecutions**的返回值获取。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_exec_name', - ], - ], - [ - 'name' => 'Cause', - 'in' => 'formData', - 'schema' => [ - 'description' => '停止错误原因。长度为1~4096个字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'for test', - ], + 'in' => 'query', + 'schema' => ['description' => '定时调度绑定的流程名称。该名称在同一地域内唯一，创建后不可修改。取值说明如下：'."\n" + ."\n" + .'- 支持英文字符（a~z）或（A~Z）、数字（0~9）、下划线（_）和短划线（-）。'."\n" + .'- 首字母必须为英文字母（a~z）、（A~Z）或下划线（_）。'."\n" + .'- 区分大小写。'."\n" + .'- 长度为1~128个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_test_flow'], ], [ - 'name' => 'Error', - 'in' => 'formData', - 'schema' => [ - 'description' => '停止错误代码。长度为1~128个字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'InvalidArgument', - ], + 'name' => 'ScheduleName', + 'in' => 'query', + 'schema' => ['description' => '定时调度的名称。取值说明如下：'."\n" + ."\n" + .'- 支持英文字符（a~z）或（A~Z）、数字（0~9）、下划线（_）和短划线（-）。'."\n" + .'- 首字母必须为英文字母（a~z）、（A~Z）或下划线（_）。'."\n" + .'- 区分大小写。'."\n" + .'- 长度为1~128个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_schedule_name'], ], ], 'responses' => [ @@ -2792,170 +1408,62 @@ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '执行状态。取值说明如下：'."\n" - .'- **Starting**'."\n" - .'- **Running**'."\n" - .'- **Stopped**'."\n" - .'- **Succeeded**'."\n" - .'- **Failed**'."\n" - .'- **TimedOut**', - 'type' => 'string', - 'example' => 'Running', - ], - 'StoppedTime' => [ - 'description' => '执行停止时间。', - 'type' => 'string', - 'example' => '2019-01-01T01:01:01.001Z', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'testRequestId', - ], - 'StartedTime' => [ - 'description' => '执行开始时间。', - 'type' => 'string', - 'example' => '2019-01-01T01:01:01.001Z', - ], - 'FlowDefinition' => [ - 'description' => '执行的流程定义。', - 'type' => 'string', - 'example' => '旧版：'."\n" - .'"type: flow\\nversion: v1\\nname: my_flow_name\\nsteps:\\n - type: pass\\n name: mypass"'."\n" - ."\n" - .'新版：'."\n" - .'"Type: StateMachine\\nSpecVersion: v1\\nName: my_flow_name\\nStartAt: my_state\\nStates:\\n - Type: Pass\\n Name: my_state\\n End: true"', - ], - 'Output' => [ - 'description' => '执行的输出，为JSON对象格式。', - 'type' => 'string', - 'example' => '{"key":"value"}', - ], - 'FlowName' => [ - 'description' => '流程名称。', - 'type' => 'string', - 'example' => 'my_flow_name', - ], - 'Name' => [ - 'description' => '执行名称。', - 'type' => 'string', - 'example' => 'my_exec_name', - ], - 'Input' => [ - 'description' => '执行的输入，为JSON对象格式。', - 'type' => 'string', - 'example' => '{"key":"value"}', - ], - 'RoleArn' => [ - 'description' => '执行的角色权限配置。若流程定义中的RoleArn在执行期间发生变更，系统将记录并返回执行初始时刻的RoleArn的快照。'."\n" - .'> 如果您的流程在执行时未配置执行角色，则该字段不会出现。', - 'type' => 'string', - 'example' => 'acs:ram:${region}:${accountID}:${role}', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestId'], + 'Description' => ['description' => '定时调度的描述。', 'type' => 'string', 'example' => 'test description'], + 'ScheduleId' => ['description' => '定时调度的ID。', 'type' => 'string', 'example' => 'testScheduleId'], + 'Payload' => ['description' => '定时调度的触发消息。', 'type' => 'string', 'example' => '{"key": "value"}'], + 'ScheduleName' => ['description' => '定时调度的名称。', 'type' => 'string', 'example' => 'my_schedule_name'], + 'CreatedTime' => ['description' => '定时调度的创建时间。', 'type' => 'string', 'example' => '2020-01-01T01:01:01.001Z'], + 'LastModifiedTime' => ['description' => '定时调度最近一次的更改时间。', 'type' => 'string', 'example' => '2020-01-01T01:01:01.001Z'], + 'CronExpression' => ['description' => 'Cron表达式。', 'type' => 'string', 'example' => '0 * * * * *'], + 'Enable' => ['description' => '是否启用定时调度。取值说明如下：'."\n" + .'- **true**：启用。'."\n" + .'- **false**：禁用。', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ActionNotSupported', - 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', - ], - [ - 'errorCode' => 'APIVersionNotSupported', - 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', - ], - [ - 'errorCode' => 'EntityTooLarge', - 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', - ], - [ - 'errorCode' => 'ExecutionAlreadyCompleted', - 'errorMessage' => 'Execution \'%s\' for flow \'%s\' has already completed.', - ], - [ - 'errorCode' => 'InvalidArgument', - 'errorMessage' => 'Parameter error.', - ], - [ - 'errorCode' => 'MissingRequiredHeader', - 'errorMessage' => 'The HTTP header \'%s\' must be specified.', - ], - [ - 'errorCode' => 'MissingRequiredParams', - 'errorMessage' => 'The HTTP query \'%s\' must be specified.', - ], + ['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''], + ['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''], + ['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => ''], + ['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => ''], + ['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessDenied', - 'errorMessage' => 'The resources doesn\'t belong to you.', - ], - [ - 'errorCode' => 'InvalidAccessKeyID', - 'errorMessage' => 'The AccessKey ID %s is invalid.', - ], - [ - 'errorCode' => 'RequestTimeTooSkewed', - 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', - ], - [ - 'errorCode' => 'SignatureNotMatch', - 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', - ], + ['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''], ], [ - [ - 'errorCode' => 'ExecutionNotExists', - 'errorMessage' => 'Execution %s for flow %s does not exist.', - ], - [ - 'errorCode' => 'FlowNotExists', - 'errorMessage' => 'Flow %s does not exist.', - ], - ], - 409 => [ - [ - 'errorCode' => 'ConcurrentUpdateError', - 'errorMessage' => 'Update conflict, please retry.', - ], - ], - 415 => [ - [ - 'errorCode' => 'UnsupportedMediaType', - 'errorMessage' => 'The content type must be "application/json".', - ], - ], - 429 => [ - [ - 'errorCode' => 'ResourceThrottled', - 'errorMessage' => 'The request is throttled. Please try again later.', - ], + ['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => ''], + ['errorCode' => 'ScheduleNotExists', 'errorMessage' => 'The schedule %s for flow %s does not exist.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'An internal error has occurred. Please retry.', + ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"Description\\": \\"test description\\",\\n \\"ScheduleId\\": \\"testScheduleId\\",\\n \\"Payload\\": \\"{\\\\\\"key\\\\\\": \\\\\\"value\\\\\\"}\\",\\n \\"ScheduleName\\": \\"my_schedule_name\\",\\n \\"CreatedTime\\": \\"2020-01-01T01:01:01.001Z\\",\\n \\"LastModifiedTime\\": \\"2020-01-01T01:01:01.001Z\\",\\n \\"CronExpression\\": \\"0 * * * * *\\",\\n \\"Enable\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '获取一个定时调度（仅适用于旧版工作流）', + 'summary' => '获取一个定时调度信息。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'fnf:DescribeSchedule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"Running\\",\\n \\"StoppedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"StartedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"FlowDefinition\\": \\"旧版：\\\\n\\\\\\"type: flow\\\\\\\\nversion: v1\\\\\\\\nname: my_flow_name\\\\\\\\nsteps:\\\\\\\\n - type: pass\\\\\\\\n name: mypass\\\\\\"\\\\n\\\\n新版：\\\\n\\\\\\"Type: StateMachine\\\\\\\\nSpecVersion: v1\\\\\\\\nName: my_flow_name\\\\\\\\nStartAt: my_state\\\\\\\\nStates:\\\\\\\\n - Type: Pass\\\\\\\\n Name: my_state\\\\\\\\n End: true\\\\\\"\\",\\n \\"Output\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"FlowName\\": \\"my_flow_name\\",\\n \\"Name\\": \\"my_exec_name\\",\\n \\"Input\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"RoleArn\\": \\"acs:ram:${region}:${accountID}:${role}\\"\\n}","errorExample":""},{"type":"xml","example":"<StopExecutionResponse>\\n <Status>Running</Status>\\n <StoppedTime>2019-01-01T01:01:01.001Z</StoppedTime>\\n <RequestId>testRequestId</RequestId>\\n <StartedTime>2019-01-01T01:01:01.001Z</StartedTime>\\n <FlowDefinition>version: v1.0\\\\ntype: flow\\\\nname: test\\\\nsteps:\\\\n - type: pass\\\\n name: mypass</FlowDefinition>\\n <Output>{\\"key\\":\\"value\\"}</Output>\\n <FlowName>flow</FlowName>\\n <Name>exec</Name>\\n <Input>{\\"key\\":\\"value\\"}</Input>\\n</StopExecutionResponse>","errorExample":""}]', - 'title' => '停止一个正在执行的流程', - 'summary' => '停止一个正在执行的流程。', - 'description' => '## 接口说明'."\n" - .'流程必须为执行中。', ], - 'DescribeExecution' => [ - 'summary' => '获取一次执行的状态信息，支持长轮询模式，长轮询最长等待时间由 WaitTimeSeconds 参数指定。', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetExecutionHistory' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2964,50 +1472,31 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '98858', - 'abilityTreeNodes' => [ - 'FEATUREfnf8CPMA5', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '98861', + 'abilityTreeNodes' => ['FEATUREfnf8CPMA5'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'FlowName', 'in' => 'query', - 'schema' => [ - 'description' => '流程名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_flow_name', - ], + 'schema' => ['description' => '流程名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_flow_name'], ], [ 'name' => 'ExecutionName', 'in' => 'query', - 'schema' => [ - 'description' => '执行名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_exec_name', - ], + 'schema' => ['description' => '执行名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_exec_name'], ], [ - 'name' => 'WaitTimeSeconds', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => '请求长轮询的最长等待时间。取值范围\\[0,60]，单位为秒。取值说明如下：'."\n" - .'- 取值等于0：请求立即返回当前执行状态。'."\n" - .'- 取值大于0：请求在服务端长轮询等待执行结束，最长等待设定的秒数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'Event查询开始名称，根据本接口返回获取。', 'type' => 'string', 'required' => false, 'example' => 'flow_xxx'], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => ['description' => '查询数量。取值范围\\[1,1000)，默认值为60。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], ], 'responses' => [ @@ -3016,89 +1505,42 @@ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '执行状态。取值说明如下：'."\n" - .'- **Starting**'."\n" - .'- **Running**'."\n" - .'- **Stopped**'."\n" - .'- **Succeeded**'."\n" - .'- **Failed**'."\n" - .'- **TimedOut**', - 'type' => 'string', - 'example' => 'Succeeded', - ], - 'StoppedTime' => [ - 'description' => '执行停止时间。', - 'type' => 'string', - 'example' => '2019-01-01T01:01:01.001Z', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'testRequestId', - ], - 'StartedTime' => [ - 'description' => '执行开始时间。', - 'type' => 'string', - 'example' => '2019-01-01T01:01:01.001Z', - ], - 'FlowDefinition' => [ - 'description' => '执行的流程定义。', - 'type' => 'string', - 'example' => '旧版：'."\n" - .'"type: flow\\nversion: v1\\nname: my_flow_name\\nsteps:\\n - type: pass\\n name: mypass"'."\n" - ."\n" - .'新版：'."\n" - .'"Type: StateMachine\\nSpecVersion: v1\\nName: my_flow_name\\nStartAt: my_state\\nStates:\\n - Type: Pass\\n Name: my_state\\n End: true"', - ], - 'Output' => [ - 'description' => '执行的输出，为JSON对象格式。', - 'type' => 'string', - 'example' => '{"key":"value"}', - ], - 'FlowName' => [ - 'description' => '流程名称。', - 'type' => 'string', - 'example' => 'my_flow_name', - ], - 'Name' => [ - 'description' => '执行名称。', - 'type' => 'string', - 'example' => 'my_exec_name', - ], - 'Input' => [ - 'description' => '执行的输入，为JSON对象格式。', - 'type' => 'string', - 'example' => '{"key":"value"}', - ], - 'Environment' => [ - 'title' => 'Flow 执行时使用的环境变量列表', - 'description' => 'Flow 执行时使用的环境变量列表', - 'type' => 'object', - 'properties' => [ - 'Variables' => [ - 'title' => 'Flow 执行时使用的环境变量列表', - 'description' => 'Flow 执行时使用的环境变量列表', - 'type' => 'array', - 'items' => [ - 'title' => 'Flow 执行期间可以访问的变量列表', - 'description' => 'Flow 执行期间可以访问的变量列表', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '变量名称', - 'description' => '变量名称', - 'type' => 'string', - 'example' => 'key', - ], - 'Value' => [ - 'title' => '变量值', - 'description' => '变量值', - 'type' => 'string', - 'example' => 'value', - ], - ], - ], + 'NextToken' => ['description' => '首次查询非必填，该字段是以返回的**ScheduleEventId**作为下次查询的Token；无数据时，该字段不返回。', 'type' => 'string', 'example' => '3'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestId'], + 'Events' => [ + 'description' => '事件信息。', + 'type' => 'array', + 'items' => [ + 'description' => '事件信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => '执行步骤类型。取值说明如下：'."\n" + .'- **StepEntered**'."\n" + .'- **StepStarted**'."\n" + .'- **StepSucceeded**'."\n" + .'- **StepFailed**'."\n" + .'- **StepExited**'."\n" + .'- **BranchEntered**'."\n" + .'- **BranchExited**'."\n" + .'- **IterationEntered**'."\n" + .'- **IterationExited**'."\n" + .'- **TaskScheduled**'."\n" + .'- **TaskStarted**'."\n" + .'- **TaskSubmitted**'."\n" + .'- **TaskSubmitFailed**'."\n" + .'- **TaskSucceeded**'."\n" + .'- **TaskFailed**'."\n" + .'- **TaskTimedOut**'."\n" + .'- **ExecutionStarted**'."\n" + .'- **ExecutionStopped**'."\n" + .'- **ExecutionSucceeded**'."\n" + .'- **ExecutionFailed**'."\n" + .'- **ExecutionTimedOut**', 'type' => 'string', 'example' => 'TaskSucceeded'], + 'EventId' => ['description' => '执行步骤ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'Time' => ['description' => '事件更新时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'], + 'ScheduleEventId' => ['description' => '调度步骤ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'EventDetail' => ['description' => '执行步骤详情。', 'type' => 'string', 'example' => '{}'], + 'StepName' => ['description' => '执行步骤名称。', 'type' => 'string', 'example' => 'passStep'], ], ], ], @@ -3108,96 +1550,52 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidArgument', - 'errorMessage' => 'Parameter error.', - ], - [ - 'errorCode' => 'MissingRequiredHeader', - 'errorMessage' => 'The HTTP header \'%s\' must be specified.', - ], - [ - 'errorCode' => 'MissingRequiredParams', - 'errorMessage' => 'The HTTP query \'%s\' must be specified.', - ], - [ - 'errorCode' => 'ActionNotSupported', - 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', - ], - [ - 'errorCode' => 'APIVersionNotSupported', - 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', - ], - [ - 'errorCode' => 'EntityTooLarge', - 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', - ], + ['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''], + ['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''], + ['errorCode' => 'EntityTooLarge', 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', 'description' => ''], + ['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => ''], + ['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => ''], + ['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'InvalidAccessKeyID', - 'errorMessage' => 'The AccessKey ID %s is invalid.', - ], - [ - 'errorCode' => 'RequestTimeTooSkewed', - 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', - ], - [ - 'errorCode' => 'SignatureNotMatch', - 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', - ], - [ - 'errorCode' => 'AccessDenied', - 'errorMessage' => 'The resources doesn\'t belong to you.', - ], + ['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''], + ['errorCode' => 'InvalidAccessKeyID', 'errorMessage' => 'The AccessKey ID %s is invalid.', 'description' => ''], + ['errorCode' => 'RequestTimeTooSkewed', 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', 'description' => ''], + ['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => ''], ], [ - [ - 'errorCode' => 'ExecutionNotExists', - 'errorMessage' => 'Execution %s for flow %s does not exist.', - ], - [ - 'errorCode' => 'FlowNotExists', - 'errorMessage' => 'Flow %s does not exist.', - ], - ], - 412 => [ - [ - 'errorCode' => 'PreconditionFailed', - 'errorMessage' => 'The resource to be modified has been changed.', - ], + ['errorCode' => 'ExecutionNotExists', 'errorMessage' => 'Execution %s for flow %s does not exist.', 'description' => ''], + ['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => ''], ], 415 => [ - [ - 'errorCode' => 'UnsupportedMediaType', - 'errorMessage' => 'The content type must be "application/json".', - ], - ], - 429 => [ - [ - 'errorCode' => 'ResourceThrottled', - 'errorMessage' => 'The request is throttled. Please try again later.', - ], + ['errorCode' => 'UnsupportedMediaType', 'errorMessage' => 'The content type must be "application/json".', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'An internal error has occurred. Please retry.', + ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"3\\",\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"Events\\": [\\n {\\n \\"Type\\": \\"TaskSucceeded\\",\\n \\"EventId\\": 2,\\n \\"Time\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"ScheduleEventId\\": 1,\\n \\"EventDetail\\": \\"{}\\",\\n \\"StepName\\": \\"passStep\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '获取一次执行的步骤详情', + 'summary' => '获取指定执行过程中的每个步骤详细信息。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'fnf:GetExecutionHistory', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"Succeeded\\",\\n \\"StoppedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"StartedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"FlowDefinition\\": \\"旧版：\\\\n\\\\\\"type: flow\\\\\\\\nversion: v1\\\\\\\\nname: my_flow_name\\\\\\\\nsteps:\\\\\\\\n - type: pass\\\\\\\\n name: mypass\\\\\\"\\\\n\\\\n新版：\\\\n\\\\\\"Type: StateMachine\\\\\\\\nSpecVersion: v1\\\\\\\\nName: my_flow_name\\\\\\\\nStartAt: my_state\\\\\\\\nStates:\\\\\\\\n - Type: Pass\\\\\\\\n Name: my_state\\\\\\\\n End: true\\\\\\"\\",\\n \\"Output\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"FlowName\\": \\"my_flow_name\\",\\n \\"Name\\": \\"my_exec_name\\",\\n \\"Input\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"Environment\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"key\\",\\n \\"Value\\": \\"value\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '获取一次执行的状态信息', ], 'ListExecutions' => [ 'summary' => '获取一个流程的所有历史执行。', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3210,128 +1608,72 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '98862', - 'abilityTreeNodes' => [ - 'FEATUREfnf8CPMA5', - ], + 'abilityTreeNodes' => ['FEATUREfnf8CPMA5'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'FlowName', 'in' => 'query', - 'schema' => [ - 'description' => '流程名称。该名称在同一地域内唯一，创建后不可修改。取值说明如下：'."\n" - ."\n" - .'- 支持英文字符（a~z）或（A~Z）、数字（0~9）、下划线（_）和短划线（-）。'."\n" - .'- 首字母必须为英文字母（a~z）、（A~Z）或下划线（_）。'."\n" - .'- 区分大小写。'."\n" - .'- 长度为1~128个字符。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_flow_name', - ], + 'schema' => ['description' => '流程名称。该名称在同一地域内唯一，创建后不可修改。取值说明如下：'."\n" + ."\n" + .'- 支持英文字符（a~z）或（A~Z）、数字（0~9）、下划线（_）和短划线（-）。'."\n" + .'- 首字母必须为英文字母（a~z）、（A~Z）或下划线（_）。'."\n" + .'- 区分大小写。'."\n" + .'- 长度为1~128个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_flow_name'], ], [ 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => '执行查询开始名称，根据本接口返回获取。首次查询非必填。', - 'type' => 'string', - 'required' => false, - 'example' => 'flow_xxx', - ], + 'schema' => ['description' => '执行查询开始名称，根据本接口返回获取。首次查询非必填。', 'type' => 'string', 'required' => false, 'example' => 'flow_xxx'], ], [ 'name' => 'Limit', 'in' => 'query', - 'schema' => [ - 'description' => '查询数量。取值范围\\[1,100]，默认值为60。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '查询数量。取值范围\\[1,100]，默认值为60。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => '需要过滤的执行状态。取值说明如下：'."\n" - .'- **Starting**'."\n" - .'- **Running**'."\n" - .'- **Stopped**'."\n" - .'- **Succeeded**'."\n" - .'- **Failed**'."\n" - .'- **TimedOut**', - 'type' => 'string', - 'required' => false, - 'example' => 'Succeeded', - ], + 'schema' => ['description' => '需要过滤的执行状态。取值说明如下：'."\n" + .'- **Starting**'."\n" + .'- **Running**'."\n" + .'- **Stopped**'."\n" + .'- **Succeeded**'."\n" + .'- **Failed**'."\n" + .'- **TimedOut**', 'type' => 'string', 'required' => false, 'example' => 'Succeeded'], ], [ 'name' => 'StartedTimeBegin', 'in' => 'query', - 'schema' => [ - 'description' => '筛选某个执行的起始时间后的所有执行，格式为UTC RFC3339。', - 'type' => 'string', - 'required' => false, - 'example' => '2020-12-02T02:39:20.402Z', - ], + 'schema' => ['description' => '筛选某个执行的起始时间后的所有执行，格式为UTC RFC3339。', 'type' => 'string', 'required' => false, 'example' => '2020-12-02T02:39:20.402Z'], ], [ 'name' => 'StartedTimeEnd', 'in' => 'query', - 'schema' => [ - 'description' => '筛选某个执行的起始时间前的所有执行，格式为UTC RFC3339。', - 'type' => 'string', - 'required' => false, - 'example' => '2020-12-02T02:23:54.817Z', - ], + 'schema' => ['description' => '筛选某个执行的起始时间前的所有执行，格式为UTC RFC3339。', 'type' => 'string', 'required' => false, 'example' => '2020-12-02T02:23:54.817Z'], ], [ 'name' => 'ExecutionNamePrefix', 'in' => 'query', - 'schema' => [ - 'description' => '执行的名称前缀。', - 'type' => 'string', - 'required' => false, - 'example' => 'run', - ], + 'schema' => ['description' => '执行的名称前缀。', 'type' => 'string', 'required' => false, 'example' => 'run'], ], [ 'name' => 'MetadataOnly', 'in' => 'query', - 'schema' => [ - 'title' => '是否只返回执行的元数据。为true时，返回值中不包括Flow定义、Input和Output，为false时会返回全部数据', - 'description' => '是否只返回执行的元数据。为true时，返回值中不包括Flow定义、Input和Output，为false时会返回全部数据', - 'type' => 'boolean', - 'required' => false, - ], + 'schema' => ['title' => '是否只返回执行的元数据。为true时，返回值中不包括Flow定义、Input和Output，为false时会返回全部数据', 'description' => '是否只返回执行的元数据。为true时，返回值中不包括Flow定义、Input和Output，为false时会返回全部数据', 'type' => 'boolean', 'required' => false], ], [ 'name' => 'Qualifier', 'in' => 'query', - 'schema' => [ - 'title' => '指定流程的版本或别名', - 'description' => '指定流程的版本或别名', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '指定流程的版本或别名', 'description' => '指定流程的版本或别名', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ 'name' => 'MapRunName', 'in' => 'query', - 'schema' => [ - 'title' => 'MapRun 名称', - 'description' => 'MapRun 名称，当 Execution 中发起 MapRun 执行后，会产生 MapRunStarted 事件，MapRunName 可以从 MapRunStarted 事件的 Output 中获取。'."\n" - ."\n" - .'可以通过设置 MapRunName 过滤当前 Flow 中指定 MapRun 发起的子执行。', - 'type' => 'string', - 'required' => false, - 'example' => 'c39142f1345b196d678333c41f113100', - ], + 'schema' => ['title' => 'MapRun 名称', 'description' => 'MapRun 名称，当 Execution 中发起 MapRun 执行后，会产生 MapRunStarted 事件，MapRunName 可以从 MapRunStarted 事件的 Output 中获取。'."\n" + ."\n" + .'可以通过设置 MapRunName 过滤当前 Flow 中指定 MapRun 发起的子执行。', 'type' => 'string', 'required' => false, 'example' => 'c39142f1345b196d678333c41f113100'], ], ], 'responses' => [ @@ -3340,18 +1682,10 @@ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => '下个查询起始Key，如无其他数据则不返回。'."\n" - .'> '."\n" - .'> 返回结果中，可能因为没有下一页内容不显示该参数。', - 'type' => 'string', - 'example' => '397aba96-4d85-11ef-9c97-************', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', - ], + 'NextToken' => ['description' => '下个查询起始Key，如无其他数据则不返回。'."\n" + .'> '."\n" + .'> 返回结果中，可能因为没有下一页内容不显示该参数。', 'type' => 'string', 'example' => '397aba96-4d85-11ef-9c97-************'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****'], 'Executions' => [ 'description' => '执行信息。', 'type' => 'array', @@ -3359,50 +1693,18 @@ 'description' => '执行信息。', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '执行的状态。', - 'type' => 'string', - 'example' => 'Succeeded', - ], - 'StoppedTime' => [ - 'description' => '执行停止时间。', - 'type' => 'string', - 'example' => '2019-01-01T01:01:01.001Z', - ], - 'StartedTime' => [ - 'description' => '执行开始时间。', - 'type' => 'string', - 'example' => '2019-01-01T01:01:01.001Z', - ], - 'FlowDefinition' => [ - 'description' => '执行的流程定义。', - 'type' => 'string', - 'example' => '旧版：'."\n" - .'"type: flow\\nversion: v1\\nname: my_flow_name\\nsteps:\\n - type: pass\\n name: mypass"'."\n" - ."\n" - .'新版：'."\n" - .'"Type: StateMachine\\nSpecVersion: v1\\nName: my_flow_name\\nStartAt: my_state\\nStates:\\n - Type: Pass\\n Name: my_state\\n End: true"', - ], - 'Output' => [ - 'description' => '执行的输出，为JSON对象格式。', - 'type' => 'string', - 'example' => '{"key":"value"}', - ], - 'FlowName' => [ - 'description' => '流程名称。', - 'type' => 'string', - 'example' => 'my_flow_name', - ], - 'Name' => [ - 'description' => '执行名称。', - 'type' => 'string', - 'example' => 'my_exec_name', - ], - 'Input' => [ - 'description' => '执行的输入，为JSON对象格式。', - 'type' => 'string', - 'example' => '{"key":"value"}', - ], + 'Status' => ['description' => '执行的状态。', 'type' => 'string', 'example' => 'Succeeded'], + 'StoppedTime' => ['description' => '执行停止时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'], + 'StartedTime' => ['description' => '执行开始时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'], + 'FlowDefinition' => ['description' => '执行的流程定义。', 'type' => 'string', 'example' => 'Legacy version:'."\n" + .'"type: flow\\nversion: v1\\nname: my_flow_name\\nsteps:\\n - type: pass\\n name: mypass"'."\n" + ."\n" + .'New version:'."\n" + .'"Type: StateMachine\\nSpecVersion: v1\\nName: my_flow_name\\nStartAt: my_state\\nStates:\\n - Type: Pass\\n Name: my_state\\n End: true"'], + 'Output' => ['description' => '执行的输出，为JSON对象格式。', 'type' => 'string', 'example' => '{"key":"value"}'], + 'FlowName' => ['description' => '流程名称。', 'type' => 'string', 'example' => 'my_flow_name'], + 'Name' => ['description' => '执行名称。', 'type' => 'string', 'example' => 'my_exec_name'], + 'Input' => ['description' => '执行的输入，为JSON对象格式。', 'type' => 'string', 'example' => '{"key":"value"}'], 'Environment' => [ 'title' => 'Flow 执行时使用的环境变量列表', 'description' => 'Flow 执行时使用的环境变量列表', @@ -3417,18 +1719,8 @@ 'description' => 'Flow 执行期间可以访问的变量列表', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '变量名称', - 'description' => '变量名称', - 'type' => 'string', - 'example' => 'key', - ], - 'Value' => [ - 'title' => '变量值', - 'description' => '变量值', - 'type' => 'string', - 'example' => 'value', - ], + 'Name' => ['title' => '变量名称', 'description' => '变量名称', 'type' => 'string', 'example' => 'key'], + 'Value' => ['title' => '变量值', 'description' => '变量值', 'type' => 'string', 'example' => 'value'], ], ], ], @@ -3443,81 +1735,36 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ActionNotSupported', - 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', - ], - [ - 'errorCode' => 'APIVersionNotSupported', - 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', - ], - [ - 'errorCode' => 'EntityTooLarge', - 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', - ], - [ - 'errorCode' => 'InvalidArgument', - 'errorMessage' => 'Parameter error.', - ], - [ - 'errorCode' => 'MissingRequiredHeader', - 'errorMessage' => 'The HTTP header \'%s\' must be specified.', - ], - [ - 'errorCode' => 'MissingRequiredParams', - 'errorMessage' => 'The HTTP query \'%s\' must be specified.', - ], + ['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''], + ['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''], + ['errorCode' => 'EntityTooLarge', 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', 'description' => '请求消息体过大。'], + ['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => '请求参数错误。具体内容请参考实际错误信息。'], + ['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'], + ['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'], ], 403 => [ - [ - 'errorCode' => 'AccessDenied', - 'errorMessage' => 'The resources doesn\'t belong to you.', - ], - [ - 'errorCode' => 'InvalidAccessKeyID', - 'errorMessage' => 'The AccessKey ID %s is invalid.', - ], - [ - 'errorCode' => 'RequestTimeTooSkewed', - 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', - ], - [ - 'errorCode' => 'SignatureNotMatch', - 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', - ], + ['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''], + ['errorCode' => 'InvalidAccessKeyID', 'errorMessage' => 'The AccessKey ID %s is invalid.', 'description' => 'AccessKey ID无效。'], + ['errorCode' => 'RequestTimeTooSkewed', 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', 'description' => '您的请求时间不正确，该请求已被识别为无效。请参考通用参数一节。'], + ['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => '您发起请求的签名与我们计算不一致，请检查您的签名算法及AccessKey Secret。'], ], [ - [ - 'errorCode' => 'FlowNotExists', - 'errorMessage' => 'Flow %s does not exist.', - ], + ['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => '所请求资源不存在，请确保流程已创建。'], ], 412 => [ - [ - 'errorCode' => 'PreconditionFailed', - 'errorMessage' => 'The resource to be modified has been changed.', - ], + ['errorCode' => 'PreconditionFailed', 'errorMessage' => 'The resource to be modified has been changed.', 'description' => '资源查看或更新检查失败，该资源可能已被更改。请稍后重试。'], ], 415 => [ - [ - 'errorCode' => 'UnsupportedMediaType', - 'errorMessage' => 'The content type must be "application/json".', - ], + ['errorCode' => 'UnsupportedMediaType', 'errorMessage' => 'The content type must be "application/json".', 'description' => '请求消息体类型错误。'], ], 429 => [ - [ - 'errorCode' => 'ResourceThrottled', - 'errorMessage' => 'The request is throttled. Please try again later.', - ], + ['errorCode' => 'ResourceThrottled', 'errorMessage' => 'The request is throttled. Please try again later.', 'description' => '因某些原因系统流量已达瓶颈。请稍后重试。'], ], 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'An internal error has occurred. Please retry.', - ], + ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => '服务器内部错误。请稍后重试。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"397aba96-4d85-11ef-9c97-************\\",\\n \\"RequestId\\": \\"69AD2AA7-DB47-449B-941B-B14409DF****\\",\\n \\"Executions\\": [\\n {\\n \\"Status\\": \\"Succeeded\\",\\n \\"StoppedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"StartedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"FlowDefinition\\": \\"旧版：\\\\n\\\\\\"type: flow\\\\\\\\nversion: v1\\\\\\\\nname: my_flow_name\\\\\\\\nsteps:\\\\\\\\n - type: pass\\\\\\\\n name: mypass\\\\\\"\\\\n\\\\n新版：\\\\n\\\\\\"Type: StateMachine\\\\\\\\nSpecVersion: v1\\\\\\\\nName: my_flow_name\\\\\\\\nStartAt: my_state\\\\\\\\nStates:\\\\\\\\n - Type: Pass\\\\\\\\n Name: my_state\\\\\\\\n End: true\\\\\\"\\",\\n \\"Output\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"FlowName\\": \\"my_flow_name\\",\\n \\"Name\\": \\"my_exec_name\\",\\n \\"Input\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"Environment\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"key\\",\\n \\"Value\\": \\"value\\"\\n }\\n ]\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"397aba96-4d85-11ef-9c97-************\\",\\n \\"RequestId\\": \\"69AD2AA7-DB47-449B-941B-B14409DF****\\",\\n \\"Executions\\": [\\n {\\n \\"Status\\": \\"Succeeded\\",\\n \\"StoppedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"StartedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"FlowDefinition\\": \\"Legacy version:\\\\n\\\\\\"type: flow\\\\\\\\nversion: v1\\\\\\\\nname: my_flow_name\\\\\\\\nsteps:\\\\\\\\n - type: pass\\\\\\\\n name: mypass\\\\\\"\\\\n\\\\nNew version:\\\\n\\\\\\"Type: StateMachine\\\\\\\\nSpecVersion: v1\\\\\\\\nName: my_flow_name\\\\\\\\nStartAt: my_state\\\\\\\\nStates:\\\\\\\\n - Type: Pass\\\\\\\\n Name: my_state\\\\\\\\n End: true\\\\\\"\\",\\n \\"Output\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"FlowName\\": \\"my_flow_name\\",\\n \\"Name\\": \\"my_exec_name\\",\\n \\"Input\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"Environment\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"key\\",\\n \\"Value\\": \\"value\\"\\n }\\n ]\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '获取一个流程的历史执行', 'description' => '## 接口说明'."\n" ."\n" @@ -3525,15 +1772,29 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetExecutionHistory' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'fnf:ListExecutions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListFlowAliases' => [ + 'summary' => '查询流程版本别名列表', + 'path' => '', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -3542,134 +1803,62 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '98861', - 'abilityTreeNodes' => [ - 'FEATUREfnf8CPMA5', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREfnf8CPMA5'], + 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'FlowName', 'in' => 'query', - 'schema' => [ - 'description' => '流程名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_flow_name', - ], - ], - [ - 'name' => 'ExecutionName', - 'in' => 'query', - 'schema' => [ - 'description' => '执行名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_exec_name', - ], + 'schema' => ['title' => '流程名称', 'description' => '流程名称', 'type' => 'string', 'required' => true, 'example' => 'example-flow-name'], ], [ 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'Event查询开始名称，根据本接口返回获取。', - 'type' => 'string', - 'required' => false, - 'example' => 'flow_xxx', - ], + 'schema' => ['title' => 'list token', 'description' => 'list token', 'type' => 'string', 'required' => false, 'example' => 'token'], ], [ 'name' => 'Limit', 'in' => 'query', - 'schema' => [ - 'description' => '查询数量。取值范围\\[1,1000)，默认值为60。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '最大返回的结果数量', 'description' => '最大返回的结果数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回数据。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => '首次查询非必填，该字段是以返回的**ScheduleEventId**作为下次查询的Token；无数据时，该字段不返回。', - 'type' => 'string', - 'example' => '3', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'testRequestId', - ], - 'Events' => [ - 'description' => '事件信息。', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3A44E113-9962-5B0B-AB92-14060EFE3164'], + 'NextToken' => ['title' => 'list token', 'description' => 'list token', 'type' => 'string', 'example' => 'testNextToken'], + 'Aliases' => [ + 'title' => '别名列表', + 'description' => '别名列表', 'type' => 'array', 'items' => [ - 'description' => '事件信息。', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => '执行步骤类型。取值说明如下：'."\n" - .'- **StepEntered**'."\n" - .'- **StepStarted**'."\n" - .'- **StepSucceeded**'."\n" - .'- **StepFailed**'."\n" - .'- **StepExited**'."\n" - .'- **BranchEntered**'."\n" - .'- **BranchExited**'."\n" - .'- **IterationEntered**'."\n" - .'- **IterationExited**'."\n" - .'- **TaskScheduled**'."\n" - .'- **TaskStarted**'."\n" - .'- **TaskSubmitted**'."\n" - .'- **TaskSubmitFailed**'."\n" - .'- **TaskSucceeded**'."\n" - .'- **TaskFailed**'."\n" - .'- **TaskTimedOut**'."\n" - .'- **ExecutionStarted**'."\n" - .'- **ExecutionStopped**'."\n" - .'- **ExecutionSucceeded**'."\n" - .'- **ExecutionFailed**'."\n" - .'- **ExecutionTimedOut**', - 'type' => 'string', - 'example' => 'TaskSucceeded', - ], - 'EventId' => [ - 'description' => '执行步骤ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'Time' => [ - 'description' => '事件更新时间。', - 'type' => 'string', - 'example' => '2019-01-01T01:01:01.001Z', - ], - 'ScheduleEventId' => [ - 'description' => '调度步骤ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'EventDetail' => [ - 'description' => '执行步骤详情。', - 'type' => 'string', - 'example' => '{}', - ], - 'StepName' => [ - 'description' => '执行步骤名称。', - 'type' => 'string', - 'example' => 'passStep', + 'Name' => ['title' => '别名名称', 'description' => '别名名称', 'type' => 'string', 'example' => 'my-alias-name'], + 'Description' => ['title' => '别名描述', 'description' => '别名描述', 'type' => 'string', 'example' => 'my alias description'], + 'RoutingConfigurations' => [ + 'title' => '权重配置', + 'description' => '流量分发配置，支持配置一个或两个流程版本。当指定别名发起执行时，系统会根据权重选择对应的流程版本进行执行。', + 'type' => 'array', + 'items' => [ + 'description' => '流量分发配置，支持配置一个或两个流程版本。当指定别名发起执行时，系统会根据权重选择对应的流程版本进行执行。', + 'type' => 'object', + 'properties' => [ + 'Version' => ['title' => '版本', 'description' => '版本', 'type' => 'string', 'example' => '1'], + 'Weight' => ['title' => '权重', 'description' => '权重', 'type' => 'string', 'example' => '20'], + ], + ], ], + 'CreatedTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-10-24T14:11:26+08:00'], ], ], ], @@ -3677,238 +1866,169 @@ ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ActionNotSupported', - 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', - ], - [ - 'errorCode' => 'APIVersionNotSupported', - 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', - ], - [ - 'errorCode' => 'EntityTooLarge', - 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', - ], - [ - 'errorCode' => 'InvalidArgument', - 'errorMessage' => 'Parameter error.', - ], - [ - 'errorCode' => 'MissingRequiredHeader', - 'errorMessage' => 'The HTTP header \'%s\' must be specified.', - ], - [ - 'errorCode' => 'MissingRequiredParams', - 'errorMessage' => 'The HTTP query \'%s\' must be specified.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询流程别名列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3A44E113-9962-5B0B-AB92-14060EFE3164\\",\\n \\"NextToken\\": \\"testNextToken\\",\\n \\"Aliases\\": [\\n {\\n \\"Name\\": \\"my-alias-name\\",\\n \\"Description\\": \\"my alias description\\",\\n \\"RoutingConfigurations\\": [\\n {\\n \\"Version\\": \\"1\\",\\n \\"Weight\\": \\"20\\"\\n }\\n ],\\n \\"CreatedTime\\": \\"2025-10-24T14:11:26+08:00\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListFlowVersions' => [ + 'summary' => '查询流程版本列表', + 'path' => '', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], ], - 403 => [ - [ - 'errorCode' => 'AccessDenied', - 'errorMessage' => 'The resources doesn\'t belong to you.', - ], - [ - 'errorCode' => 'InvalidAccessKeyID', - 'errorMessage' => 'The AccessKey ID %s is invalid.', - ], - [ - 'errorCode' => 'RequestTimeTooSkewed', - 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', - ], - [ - 'errorCode' => 'SignatureNotMatch', - 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', - ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREfnf8CPMA5'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'FlowName', + 'in' => 'query', + 'schema' => ['title' => '流程名称', 'description' => '流程名称', 'type' => 'string', 'required' => true, 'example' => 'example-flow-name'], ], [ - [ - 'errorCode' => 'ExecutionNotExists', - 'errorMessage' => 'Execution %s for flow %s does not exist.', - ], - [ - 'errorCode' => 'FlowNotExists', - 'errorMessage' => 'Flow %s does not exist.', - ], + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['title' => 'list token', 'description' => 'list token', 'type' => 'string', 'required' => false, 'example' => 'token'], ], - 415 => [ - [ - 'errorCode' => 'UnsupportedMediaType', - 'errorMessage' => 'The content type must be "application/json".', - ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => ['title' => '返回的最大结果数量', 'description' => '返回的最大结果数量', 'type' => 'string', 'required' => false, 'example' => '10'], ], - 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'An internal error has occurred. Please retry.', + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '294D68C1-5108-5971-853A-1A9CC87B4816'], + 'NextToken' => ['title' => 'list token', 'description' => 'list token', 'type' => 'string', 'example' => 'token'], + 'FlowVersions' => [ + 'title' => '流程版本列表', + 'description' => '流程版本列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Version' => ['title' => '版本名称', 'description' => '版本名称', 'type' => 'string', 'example' => '1'], + 'Description' => ['title' => '版本描述', 'description' => '版本描述', 'type' => 'string', 'example' => 'version description'], + 'CreatedTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-10-24T14:11:26+08:00'], + ], + ], + ], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"3\\",\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"Events\\": [\\n {\\n \\"Type\\": \\"TaskSucceeded\\",\\n \\"EventId\\": 2,\\n \\"Time\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"ScheduleEventId\\": 1,\\n \\"EventDetail\\": \\"{}\\",\\n \\"StepName\\": \\"passStep\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '获取一次执行的步骤详情', - 'summary' => '获取指定执行过程中的每个步骤详细信息。', - ], - 'StartSyncExecution' => [ - 'summary' => '同步调用开始一个流程的执行。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询流程版本列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"294D68C1-5108-5971-853A-1A9CC87B4816\\",\\n \\"NextToken\\": \\"token\\",\\n \\"FlowVersions\\": [\\n {\\n \\"Version\\": \\"1\\",\\n \\"Description\\": \\"version description\\",\\n \\"CreatedTime\\": \\"2025-10-24T14:11:26+08:00\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListFlows' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'paid', - 'abilityTreeCode' => '195751', - 'abilityTreeNodes' => [ - 'FEATUREfnf8CPMA5', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '98863', + 'abilityTreeNodes' => ['FEATUREfnf8CPMA5'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'FlowName', - 'in' => 'formData', - 'schema' => [ - 'description' => '开始执行的流程名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_flow_name', - ], - ], - [ - 'name' => 'ExecutionName', - 'in' => 'formData', - 'schema' => [ - 'description' => '执行名称。取值说明如下：'."\n" - ."\n" - .'- 支持英文字符（a~z）或（A~Z）、数字（0~9）、下划线（_）和短划线（-）。'."\n" - .'- 首字母必须为英文字母（a~z）、（A~Z）或下划线（_）。'."\n" - .'- 区分大小写。'."\n" - .'- 长度为1~128个字符。'."\n" - ."\n" - .'不同于StartExecution接口，考虑到同步调用的特殊性，在同步执行模式下，不再要求执行名称在同一流程内唯一，调用侧可以选择提供执行名称，对本次执行进行标识，系统会在当前执行名称后添加UUID，具体形式如 {ExecutionName}:{UUID}，如果用户没有指定相关的执行名称信息，那么系统会自动生成标识本次执行的ExecutionName。', - 'type' => 'string', - 'required' => false, - 'example' => 'my_exec_name', - ], + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => '流程查询开始名称。', 'type' => 'string', 'required' => false, 'example' => 'flow_nextxxx'], ], [ - 'name' => 'Input', - 'in' => 'formData', - 'schema' => [ - 'description' => '执行的输入，为JSON对象格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{"key":"value"}', - ], + 'name' => 'Limit', + 'in' => 'query', + 'schema' => ['description' => '查询数量。取值范围\\[1,1000)，默认值为60。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'Qualifier', - 'in' => 'formData', - 'schema' => [ - 'title' => '指定流程版本或别名', - 'description' => '指定流程版本或别名', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'example' => 'rg-xxx'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '流程列表。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'testRequestId', - ], - 'FlowName' => [ - 'description' => '流程名称。', - 'type' => 'string', - 'example' => 'my_flow_name', - ], - 'Name' => [ - 'description' => '流程执行名称。', - 'type' => 'string', - 'example' => 'my_exec_name:{UUID}', - ], - 'Status' => [ - 'description' => '执行状态。取值说明如下：'."\n" - .'- **Starting**'."\n" - .'- **Running**'."\n" - .'- **Stopped**'."\n" - .'- **Succeeded**'."\n" - .'- **Failed**'."\n" - .'- **TimedOut**', - 'type' => 'string', - 'example' => 'Succeeded', - ], - 'ErrorCode' => [ - 'description' => '执行错误时的错误码。', - 'type' => 'string', - 'example' => 'ActionNotSupported', - ], - 'ErrorMessage' => [ - 'description' => '执行超时。', - 'type' => 'string', - 'example' => 'Standard execution is not supported', - ], - 'Output' => [ - 'description' => '执行的输出，为JSON对象格式。', - 'type' => 'string', - 'example' => '{"key":"value"}', - ], - 'StartedTime' => [ - 'description' => '执行开始时间。', - 'type' => 'string', - 'example' => '2019-01-01T01:01:01.001Z', - ], - 'StoppedTime' => [ - 'description' => '执行停止时间。', - 'type' => 'string', - 'example' => '2019-01-01T01:01:01.001Z', - ], - 'Environment' => [ - 'title' => 'Flow 执行时使用的环境变量列表', - 'description' => 'Flow 执行时使用的环境变量列表', - 'type' => 'object', - 'properties' => [ - 'Variables' => [ - 'title' => 'Flow 执行时使用的环境变量列表', - 'description' => 'Flow 执行时使用的环境变量列表', - 'type' => 'array', - 'items' => [ + 'NextToken' => ['description' => '下次查询起始Key，如果没有其他数据则不返回。', 'type' => 'string', 'example' => 'flow_nextxxx'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestId'], + 'Flows' => [ + 'description' => '流程列表。', + 'type' => 'array', + 'items' => [ + 'description' => '流程列表。', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => '流程类型。', 'type' => 'string', 'example' => 'FDL'], + 'Definition' => ['description' => '流程定义，遵循FDL语法标准。', 'type' => 'string', 'example' => 'version: v1.0\\ntype: flow\\nname: test\\nsteps:\\n - type: pass\\n name: mypass'], + 'RoleArn' => ['description' => '流程执行所需资源描述符信息。', 'type' => 'string', 'example' => 'acs:ram::${accountID}:${role}'], + 'Description' => ['description' => '流程描述。', 'type' => 'string', 'example' => 'my test flow'], + 'Name' => ['description' => '流程名称。', 'type' => 'string', 'example' => 'my_flow_name'], + 'CreatedTime' => ['description' => '流程创建时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'], + 'LastModifiedTime' => ['description' => '流程最后更改时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'], + 'Id' => ['description' => '流程的唯一ID。', 'type' => 'string', 'example' => 'e589e092-e2c0-4dee-b306-3574ddf5****'], + 'ExecutionMode' => ['title' => '执行模式，枚举类型，可以是Express和Standard，空串等价于Standard', 'description' => '执行模式，枚举类型，可以是Express和Standard，空串等价于Standard', 'type' => 'string', 'example' => 'Standard'], + 'Environment' => [ 'title' => 'Flow 执行期间可以访问的变量列表', 'description' => 'Flow 执行期间可以访问的变量列表', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '变量名称', - 'description' => '变量名称', - 'type' => 'string', - 'example' => 'key', - ], - 'Value' => [ - 'title' => '变量值', - 'description' => '变量值', - 'type' => 'string', - 'example' => 'value', + 'Variables' => [ + 'title' => 'Flow 执行期间可以访问的变量列表', + 'description' => 'Flow 执行期间可以访问的变量列表', + 'type' => 'array', + 'items' => [ + 'title' => 'Flow 执行期间可以访问的变量列表', + 'description' => 'Flow 执行期间可以访问的变量列表', + 'type' => 'object', + 'properties' => [ + 'Description' => ['title' => '变量描述', 'description' => '变量描述', 'type' => 'string', 'example' => 'description'], + 'Name' => ['title' => '变量名称', 'description' => '变量名称', 'type' => 'string', 'example' => 'key'], + 'Value' => ['title' => '变量值', 'description' => '变量值', 'type' => 'string', 'example' => 'value'], + ], + ], ], ], ], + 'ResourceGroupId' => ['type' => 'string', 'example' => 'rg-xxx'], ], ], ], @@ -3918,93 +2038,52 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'EntityTooLarge', - 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', - ], - [ - 'errorCode' => 'ExecutionAlreadyExists', - 'errorMessage' => 'Execution %s for flow %s already exists.', - ], - [ - 'errorCode' => 'InvalidArgument', - 'errorMessage' => 'Parameter error.', - ], - [ - 'errorCode' => 'MissingRequiredHeader', - 'errorMessage' => 'The HTTP header \'%s\' must be specified.', - ], - [ - 'errorCode' => 'MissingRequiredParams', - 'errorMessage' => 'The HTTP query \'%s\' must be specified.', - ], - [ - 'errorCode' => 'ActionNotSupported', - 'errorMessage' => 'The requested API operation %s is incorrect. Please check.', - ], - [ - 'errorCode' => 'APIVersionNotSupported', - 'errorMessage' => 'The requested API version %s is not supported yet. Please check.', - ], + ['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''], + ['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''], + ['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => '请求参数错误。具体内容请参考实际错误信息。'], + ['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'], + ['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'], ], 403 => [ - [ - 'errorCode' => 'InvalidAccessKeyID', - 'errorMessage' => 'The AccessKey ID %s is invalid.', - ], - [ - 'errorCode' => 'RequestTimeTooSkewed', - 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', - ], - [ - 'errorCode' => 'SignatureNotMatch', - 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', - ], - [ - 'errorCode' => 'AccessDenied', - 'errorMessage' => 'The resources does not belong to you.', - ], - ], - [ - [ - 'errorCode' => 'FlowNotExists', - 'errorMessage' => 'Flow %s does not exist.', - ], + ['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''], + ['errorCode' => 'InvalidAccessKeyID', 'errorMessage' => 'The AccessKey ID %s is invalid.', 'description' => 'AccessKey ID无效。'], + ['errorCode' => 'RequestTimeTooSkewed', 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', 'description' => '您的请求时间不正确，该请求已被识别为无效。请参考通用参数一节。'], + ['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => '您发起请求的签名与我们计算不一致，请检查您的签名算法及AccessKey Secret。'], ], 415 => [ - [ - 'errorCode' => 'UnsupportedMediaType', - 'errorMessage' => 'The content type must be "application/json".', - ], + ['errorCode' => 'UnsupportedMediaType', 'errorMessage' => 'The content type must be "application/json".', 'description' => '请求消息体类型错误。'], ], 429 => [ - [ - 'errorCode' => 'ResourceThrottled', - 'errorMessage' => 'The request is throttled. Please try again later.', - ], + ['errorCode' => 'ResourceThrottled', 'errorMessage' => 'The request is throttled. Please try again later.', 'description' => '因某些原因系统流量已达瓶颈。请稍后重试。'], ], 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'An internal error has occurred. Please retry.', - ], + ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => '服务器内部错误。请稍后重试。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '批量查询流程信息', + 'summary' => '批量查询流程信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'fnf:ListFlows', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => 'Flow', 'arn' => 'acs:fnf:{#regionId}:{#accountId}:flow/*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"FlowName\\": \\"my_flow_name\\",\\n \\"Name\\": \\"my_exec_name:{UUID}\\",\\n \\"Status\\": \\"Succeeded\\",\\n \\"ErrorCode\\": \\"ActionNotSupported\\",\\n \\"ErrorMessage\\": \\"Standard execution is not supported\\",\\n \\"Output\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"StartedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"StoppedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"Environment\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"key\\",\\n \\"Value\\": \\"value\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '同步调用开始一个流程的执行', - 'description' => '- 仅支持 Express 执行模式的流程。', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"flow_nextxxx\\",\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"Flows\\": [\\n {\\n \\"Type\\": \\"FDL\\",\\n \\"Definition\\": \\"version: v1.0\\\\\\\\ntype: flow\\\\\\\\nname: test\\\\\\\\nsteps:\\\\\\\\n - type: pass\\\\\\\\n name: mypass\\",\\n \\"RoleArn\\": \\"acs:ram::${accountID}:${role}\\",\\n \\"Description\\": \\"my test flow\\",\\n \\"Name\\": \\"my_flow_name\\",\\n \\"CreatedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"LastModifiedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"Id\\": \\"e589e092-e2c0-4dee-b306-3574ddf5****\\",\\n \\"ExecutionMode\\": \\"Standard\\",\\n \\"Environment\\": {\\n \\"Variables\\": [\\n {\\n \\"Description\\": \\"description\\",\\n \\"Name\\": \\"key\\",\\n \\"Value\\": \\"value\\"\\n }\\n ]\\n },\\n \\"ResourceGroupId\\": \\"rg-xxx\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', ], - 'DescribeMapRun' => [ - 'summary' => '查询 MapRun 详情', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListSchedules' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4014,154 +2093,57 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '227531', - 'abilityTreeNodes' => [ - 'FEATUREfnfR0JC2A', - ], + 'abilityTreeCode' => '98864', + 'abilityTreeNodes' => ['FEATUREfnf06LH4G'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'RequestId', - 'in' => 'query', - 'schema' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'required' => false, - 'example' => '3A44E113-9962-5B0B-AB92-14060EFE3164', - ], - ], - [ 'name' => 'FlowName', 'in' => 'query', - 'schema' => [ - 'description' => '流程名称', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_flow_name', - ], + 'schema' => ['description' => '定时调度绑定的流程名称。该名称在同一地域内唯一，创建后不可修改。取值说明如下：'."\n" + ."\n" + .'- 支持英文字符（a~z）或（A~Z）、数字（0~9）、下划线（_）和短划线（-）。'."\n" + .'- 首字母必须为英文字母（a~z）、（A~Z）或下划线（_）。'."\n" + .'- 区分大小写。'."\n" + .'- 长度为1~128个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_flow_name'], ], [ - 'name' => 'ExecutionName', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => '执行名称', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_exec_name', - ], + 'schema' => ['description' => '首次查询非必填，**NextToken**是以**FlowName**作为下次查询的Token，无下一页数据时，该字段不返回。', 'type' => 'string', 'required' => false, 'example' => 'testNextToken'], ], [ - 'name' => 'MapRunName', + 'name' => 'Limit', 'in' => 'query', - 'schema' => [ - 'description' => 'MapRun 名称，当 Execution 中发起 MapRun 执行后，会产生 MapRunStarted 事件，MapRunName 可以从 MapRunStarted 事件的 Output 中获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'c39142f1345b196d678333c41f113200', - ], + 'schema' => ['description' => '查询数量。取值范围\\[1,1000]。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', 'default' => '60'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '执行状态。取值说明如下：'."\n" - .'- **Pending**'."\n" - .'- **Running**'."\n" - .'- **Failed**'."\n" - .'- **Succeeded**'."\n" - .'- **Aborted**', - 'type' => 'string', - 'example' => 'Succeeded', - ], - 'StoppedTime' => [ - 'description' => '执行停止时间。', - 'type' => 'string', - 'example' => '2025-10-24T14:11:28+08:00', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '3A44E113-9962-5B0B-AB92-14060EFE3164', - ], - 'StartedTime' => [ - 'description' => '执行开始时间。', - 'type' => 'string', - 'example' => '2025-10-24T14:11:26+08:00', - ], - 'Concurrency' => [ - 'description' => 'MapRun 运行时的并发限制。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ToleratedFailedCount' => [ - 'description' => '允许失败的 Item 数量的最大值', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'ToleratedFailedPercentage' => [ - 'description' => '允许失败的 Item 数量占全部 Item 数量的最大百分比', - 'type' => 'number', - 'format' => 'float', - 'example' => '20', - ], - 'ExecutionName' => [ - 'description' => '执行名称', - 'type' => 'string', - 'example' => 'my_exec_name', - ], - 'MapRunName' => [ - 'description' => 'MapRun 名称', - 'type' => 'string', - 'example' => 'c39142f1345b196d678333c41f113000', - ], - 'ItemCounts' => [ - 'description' => 'MapRun 任务中处于不同处理状态的 Item 数量汇总', - 'type' => 'object', - 'properties' => [ - 'Pending' => [ - 'description' => '待开始的 Item 数量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'Running' => [ - 'description' => '正在处理的 Item 数量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'Succeed' => [ - 'description' => '处理完成的 Item 数量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'Failed' => [ - 'description' => '处理失败的 Item 数量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'Aborted' => [ - 'description' => '处理终止的 Item 数量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'Total' => [ - 'description' => 'Item 总数量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '500', + 'NextToken' => ['description' => '下一次查询的开始Token。', 'type' => 'string', 'example' => 'testNextToken'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestId'], + 'Schedules' => [ + 'description' => '定时调度信息。', + 'type' => 'array', + 'items' => [ + 'description' => '定时调度信息。'."\n", + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => '定时调度的描述。', 'type' => 'string', 'example' => 'test description'], + 'ScheduleId' => ['description' => '定时调度的ID。', 'type' => 'string', 'example' => 'testScheduleId'], + 'Payload' => ['description' => '定时调度的触发消息。', 'type' => 'string', 'example' => '{"key": "value"}'], + 'ScheduleName' => ['description' => '定时调度的名称。', 'type' => 'string', 'example' => 'my_schedule_name'], + 'CreatedTime' => ['description' => '定时调度的创建时间。', 'type' => 'string', 'example' => '2020-01-01T01:01:01.001Z'], + 'LastModifiedTime' => ['description' => '定时调度最近一次的更改时间。', 'type' => 'string', 'example' => '2020-01-01T01:01:01.001Z'], + 'CronExpression' => ['description' => 'Cron表达式。', 'type' => 'string', 'example' => '0 * * * * *'], + 'Enable' => ['description' => '是否启用定时调度。取值说明如下：'."\n" + .'- **true**：启用。'."\n" + .'- **false**：禁用。', 'type' => 'boolean', 'example' => 'true'], ], ], ], @@ -4171,189 +2153,74 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidArgument', - 'errorMessage' => 'Parameter error.', - ], - [ - 'errorCode' => 'MissingRequiredHeader', - 'errorMessage' => 'The HTTP header \'%s\' must be specified.', - ], - [ - 'errorCode' => 'MissingRequiredParams', - 'errorMessage' => 'The HTTP query \'%s\' must be specified.', - ], - [ - 'errorCode' => 'ActionNotSupported', - 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', - ], - [ - 'errorCode' => 'APIVersionNotSupported', - 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', - ], - [ - 'errorCode' => 'EntityTooLarge', - 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', - ], + ['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''], + ['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''], + ['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => ''], + ['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => ''], + ['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'InvalidAccessKeyID', - 'errorMessage' => 'The AccessKey ID %s is invalid.', - ], - [ - 'errorCode' => 'RequestTimeTooSkewed', - 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', - ], - [ - 'errorCode' => 'SignatureNotMatch', - 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', - ], - [ - 'errorCode' => 'AccessDenied', - 'errorMessage' => 'The resources doesn\'t belong to you.', - ], + ['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''], ], [ - [ - 'errorCode' => 'ExecutionNotExists', - 'errorMessage' => 'Execution %s for flow %s does not exist.', - ], - [ - 'errorCode' => 'FlowNotExists', - 'errorMessage' => 'Flow %s does not exist.', - ], + ['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => ''], ], 412 => [ - [ - 'errorCode' => 'PreconditionFailed', - 'errorMessage' => 'The resource to be modified has been changed.', - ], - ], - 415 => [ - [ - 'errorCode' => 'UnsupportedMediaType', - 'errorMessage' => 'The content type must be "application/json".', - ], - ], - 429 => [ - [ - 'errorCode' => 'ResourceThrottled', - 'errorMessage' => 'The request is throttled. Please try again later.', - ], + ['errorCode' => 'PreconditionFailed', 'errorMessage' => 'The resource to be modified has been changed.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'An internal error has occurred. Please retry.', - ], + ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"testNextToken\\",\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"Schedules\\": [\\n {\\n \\"Description\\": \\"test description\\",\\n \\"ScheduleId\\": \\"testScheduleId\\",\\n \\"Payload\\": \\"{\\\\\\"key\\\\\\": \\\\\\"value\\\\\\"}\\",\\n \\"ScheduleName\\": \\"my_schedule_name\\",\\n \\"CreatedTime\\": \\"2020-01-01T01:01:01.001Z\\",\\n \\"LastModifiedTime\\": \\"2020-01-01T01:01:01.001Z\\",\\n \\"CronExpression\\": \\"0 * * * * *\\",\\n \\"Enable\\": true\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '获取定时调度列表（仅适用于旧版工作流）', + 'summary' => '获取定时调度列表。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'fnf:ListSchedules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"Succeeded\\",\\n \\"StoppedTime\\": \\"2025-10-24T14:11:28+08:00\\",\\n \\"RequestId\\": \\"3A44E113-9962-5B0B-AB92-14060EFE3164\\",\\n \\"StartedTime\\": \\"2025-10-24T14:11:26+08:00\\",\\n \\"Concurrency\\": 1,\\n \\"ToleratedFailedCount\\": 100,\\n \\"ToleratedFailedPercentage\\": 20,\\n \\"ExecutionName\\": \\"my_exec_name\\",\\n \\"MapRunName\\": \\"c39142f1345b196d678333c41f113000\\",\\n \\"ItemCounts\\": {\\n \\"Pending\\": 100,\\n \\"Running\\": 100,\\n \\"Succeed\\": 100,\\n \\"Failed\\": 100,\\n \\"Aborted\\": 100,\\n \\"Total\\": 500\\n }\\n}","type":"json"}]', - 'title' => '查询 MapRun 执行详情', ], - 'UpdateMapRun' => [ - 'summary' => '更新 MapRun 配置', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'PublishFlowVersion' => [ + 'summary' => '以当前工作流的定义发布新的流程版本，版本号从1递增，流程版本会包含工作流定义、描述、环境变量设置和执行角色定义信息。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227533', - 'abilityTreeNodes' => [ - 'FEATUREfnfR0JC2A', - ], + 'abilityTreeNodes' => ['FEATUREfnf8CPMA5'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'RequestId', - 'in' => 'query', - 'schema' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'required' => false, - 'example' => '3A44E113-9962-5B0B-AB92-14060EFE3164', - ], - ], - [ 'name' => 'FlowName', - 'in' => 'query', - 'schema' => [ - 'description' => '流程名称', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_flow_name', - ], - ], - [ - 'name' => 'ExecutionName', - 'in' => 'query', - 'schema' => [ - 'description' => '执行名称', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_exec_name', - ], - ], - [ - 'name' => 'MapRunName', - 'in' => 'query', - 'schema' => [ - 'description' => 'MapRun 名称，当 Execution 中发起 MapRun 执行后，会产生 MapRunStarted 事件，MapRunName 可以从 MapRunStarted 事件的 Output 中获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'c39142f1345b196d678333c41f113100', - ], - ], - [ - 'name' => 'Concurrency', - 'in' => 'query', - 'schema' => [ - 'description' => 'MapRun 运行时的并发限制。单账户配额默认最大300，可以通过配额中心提升。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'ToleratedFailedCount', - 'in' => 'query', - 'schema' => [ - 'description' => '允许失败的 Item 数量的最大值', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100', - ], + 'in' => 'formData', + 'schema' => ['title' => '流程名称', 'description' => '流程名称', 'type' => 'string', 'required' => true, 'example' => 'example-flow-name'], ], [ - 'name' => 'ToleratedFailedPercentage', - 'in' => 'query', - 'schema' => [ - 'description' => '允许失败的 Item 数量占全部 Item 数量的最大百分比。取值区间为 0 - 100。', - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'example' => '20', - ], + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['title' => '版本描述', 'description' => '版本描述', 'type' => 'string', 'required' => false, 'example' => 'example flow description'], ], ], 'responses' => [ @@ -4363,143 +2230,27 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '3A44E113-9962-5B0B-AB92-14060EFE3164', - ], - 'FlowName' => [ - 'description' => '流程名称', - 'type' => 'string', - 'example' => 'my_flow_name', - ], - 'ExecutionName' => [ - 'description' => '执行名称。', - 'type' => 'string', - 'example' => 'my_exec_name', - ], - 'MapRunName' => [ - 'description' => 'MapRun 名称，当 Execution 中发起 MapRun 执行后，会产生 MapRunStarted 事件，MapRunName 可以从 MapRunStarted 事件的 Output 中获取。', - 'type' => 'string', - 'example' => 'c39142f1345b196d678333c41f113000', - ], - 'Concurrency' => [ - 'description' => 'MapRun 运行时的并发限制。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ToleratedFailedCount' => [ - 'description' => '允许失败的 Item 数量的最大值', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'ToleratedFailedPercentage' => [ - 'description' => '允许失败的 Item 数量占全部 Item 数量的最大百分比', - 'type' => 'number', - 'format' => 'float', - 'example' => '20', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '294D68C1-5108-5971-853A-1A9CC87B4816'], + 'FlowName' => ['title' => '流程名称', 'description' => '流程名称', 'type' => 'string', 'example' => 'my-flow-name'], + 'Version' => ['title' => '流程版本', 'description' => '流程版本', 'type' => 'string', 'example' => '1'], + 'Description' => ['title' => '流程版本描述', 'description' => '流程版本描述', 'type' => 'string', 'example' => 'my flow description'], + 'CreatedTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-10-24T14:11:26+08:00'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidArgument', - 'errorMessage' => 'Parameter error.', - ], - [ - 'errorCode' => 'MissingRequiredHeader', - 'errorMessage' => 'The HTTP header \'%s\' must be specified.', - ], - [ - 'errorCode' => 'MissingRequiredParams', - 'errorMessage' => 'The HTTP query \'%s\' must be specified.', - ], - [ - 'errorCode' => 'ActionNotSupported', - 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', - ], - [ - 'errorCode' => 'APIVersionNotSupported', - 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', - ], - [ - 'errorCode' => 'EntityTooLarge', - 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', - ], - ], - 403 => [ - [ - 'errorCode' => 'InvalidAccessKeyID', - 'errorMessage' => 'The AccessKey ID %s is invalid.', - ], - [ - 'errorCode' => 'RequestTimeTooSkewed', - 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', - ], - [ - 'errorCode' => 'SignatureNotMatch', - 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', - ], - [ - 'errorCode' => 'AccessDenied', - 'errorMessage' => 'The resources doesn\'t belong to you.', - ], - ], - [ - [ - 'errorCode' => 'ExecutionNotExists', - 'errorMessage' => 'Execution %s for flow %s does not exist.', - ], - [ - 'errorCode' => 'FlowNotExists', - 'errorMessage' => 'Flow %s does not exist.', - ], - ], - 412 => [ - [ - 'errorCode' => 'PreconditionFailed', - 'errorMessage' => 'The resource to be modified has been changed.', - ], - ], - 415 => [ - [ - 'errorCode' => 'UnsupportedMediaType', - 'errorMessage' => 'The content type must be "application/json".', - ], - ], - 429 => [ - [ - 'errorCode' => 'ResourceThrottled', - 'errorMessage' => 'The request is throttled. Please try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'An internal error has occurred. Please retry.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '发布流程版本', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3A44E113-9962-5B0B-AB92-14060EFE3164\\",\\n \\"FlowName\\": \\"my_flow_name\\",\\n \\"ExecutionName\\": \\"my_exec_name\\",\\n \\"MapRunName\\": \\"c39142f1345b196d678333c41f113000\\",\\n \\"Concurrency\\": 1,\\n \\"ToleratedFailedCount\\": 100,\\n \\"ToleratedFailedPercentage\\": 20\\n}","type":"json"}]', - 'title' => '更新 MapRun 执行配置', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"294D68C1-5108-5971-853A-1A9CC87B4816\\",\\n \\"FlowName\\": \\"my-flow-name\\",\\n \\"Version\\": \\"1\\",\\n \\"Description\\": \\"my flow description\\",\\n \\"CreatedTime\\": \\"2025-10-24T14:11:26+08:00\\"\\n}","type":"json"}]', ], 'ReportTaskFailed' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4509,44 +2260,25 @@ 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '98865', - 'abilityTreeNodes' => [ - 'FEATUREfnf8CPMA5', - ], + 'abilityTreeNodes' => ['FEATUREfnf8CPMA5'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TaskToken', 'in' => 'query', - 'schema' => [ - 'description' => '汇报任务指定的令牌。TaskToken会传递给被调用的服务，比如消息队列MNS或函数计算FC。对于MNS，用户可以从接收到的消息中获取，对于FC，用户可以从Event中获取。'."\n" - .'详情请参见[服务集成模式](~~2592915~~)。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'djEjYSNkZTdkYWZjMi0zMGRlLTRlMDMtOTA2OC0yMTMxYmM5NGJlZTIjNSMvV1ZHYks3RTc0WUsra25nQTNYSmtFa0t6****', - ], + 'schema' => ['description' => '汇报任务指定的令牌。TaskToken会传递给被调用的服务，比如消息队列MNS或函数计算FC。对于MNS，用户可以从接收到的消息中获取，对于FC，用户可以从Event中获取。'."\n" + .'详情请参见[服务集成模式](~~2592915~~)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'djEjYSNkZTdkYWZjMi0zMGRlLTRlMDMtOTA2OC0yMTMxYmM5NGJlZTIjNSMvV1ZHYks3RTc0WUsra25nQTNYSmtFa0t6****'], ], [ 'name' => 'Error', 'in' => 'formData', - 'schema' => [ - 'description' => '失败错误代码。长度为1~128个字符。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'InvalidArgument', - ], + 'schema' => ['description' => '失败错误代码。长度为1~128个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'InvalidArgument'], ], [ 'name' => 'Cause', 'in' => 'formData', - 'schema' => [ - 'description' => '失败错误原因。长度为1~4096个字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'emptyString', - ], + 'schema' => ['description' => '失败错误原因。长度为1~4096个字符。', 'type' => 'string', 'required' => false, 'example' => 'emptyString'], ], ], 'responses' => [ @@ -4555,93 +2287,39 @@ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'EventId' => [ - 'description' => '事件ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'testRequestId', - ], + 'EventId' => ['description' => '事件ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestId'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ActionNotSupported', - 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', - ], - [ - 'errorCode' => 'APIVersionNotSupported', - 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', - ], - [ - 'errorCode' => 'EntityTooLarge', - 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', - ], - [ - 'errorCode' => 'InvalidArgument', - 'errorMessage' => 'Parameter error.', - ], - [ - 'errorCode' => 'MissingRequiredHeader', - 'errorMessage' => 'The HTTP header \'%s\' must be specified.', - ], - [ - 'errorCode' => 'MissingRequiredParams', - 'errorMessage' => 'The HTTP query \'%s\' must be specified.', - ], - [ - 'errorCode' => 'TaskAlreadyCompleted', - 'errorMessage' => 'Task %s has already completed.', - ], + ['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''], + ['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''], + ['errorCode' => 'EntityTooLarge', 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', 'description' => ''], + ['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => ''], + ['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => ''], + ['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => ''], + ['errorCode' => 'TaskAlreadyCompleted', 'errorMessage' => 'Task %s has already completed.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessDenied', - 'errorMessage' => 'The resources doesn\'t belong to you.', - ], - [ - 'errorCode' => 'InvalidAccessKeyID', - 'errorMessage' => 'The AccessKey ID %s is invalid.', - ], - [ - 'errorCode' => 'RequestTimeTooSkewed', - 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', - ], - [ - 'errorCode' => 'SignatureNotMatch', - 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', - ], + ['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''], + ['errorCode' => 'InvalidAccessKeyID', 'errorMessage' => 'The AccessKey ID %s is invalid.', 'description' => ''], + ['errorCode' => 'RequestTimeTooSkewed', 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', 'description' => ''], + ['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => ''], ], 409 => [ - [ - 'errorCode' => 'TaskInvalidState', - 'errorMessage' => 'Task is in an invalid state, please retry.', - ], + ['errorCode' => 'TaskInvalidState', 'errorMessage' => 'Task is in an invalid state, please retry.', 'description' => ''], ], 415 => [ - [ - 'errorCode' => 'UnsupportedMediaType', - 'errorMessage' => 'The content type must be "application/json".', - ], + ['errorCode' => 'UnsupportedMediaType', 'errorMessage' => 'The content type must be "application/json".', 'description' => ''], ], 429 => [ - [ - 'errorCode' => 'ResourceThrottled', - 'errorMessage' => 'The request is throttled. Please try again later.', - ], + ['errorCode' => 'ResourceThrottled', 'errorMessage' => 'The request is throttled. Please try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'An internal error has occurred. Please retry.', - ], + ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"EventId\\": 1,\\n \\"RequestId\\": \\"testRequestId\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', @@ -4651,15 +2329,24 @@ .'在旧版Serverless 工作流中，使用该接口回调`pattern: waitForCallback`的任务步骤，表明当前任务执行失败。'."\n" ."\n" .'在新版云工作流中，使用该接口回调`TaskMode: WaitForCustomCallback`的任务步骤，表明当前任务执行失败。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'fnf:ReportTaskFailed', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], ], 'ReportTaskSucceeded' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4669,33 +2356,19 @@ 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '98866', - 'abilityTreeNodes' => [ - 'FEATUREfnf8CPMA5', - ], + 'abilityTreeNodes' => ['FEATUREfnf8CPMA5'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TaskToken', 'in' => 'query', - 'schema' => [ - 'description' => '汇报任务指定的令牌。TaskToken会传递给被调用的服务，比如消息队列MNS或函数计算FC。对于MNS，用户可以从接收到的消息中获取，对于FC，用户可以从Event中获取。详情请参见[服务集成模式](~~2592915~~)。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'djEjYSNkZTdkYWZjMi0zMGRlLTRlMDMtOTA2OC0yMTMxYmM5NGJlZTIjNSMvV1ZHYks3RTc0WUsra25nQTNYSmtFa0t6U****', - ], + 'schema' => ['description' => '汇报任务指定的令牌。TaskToken会传递给被调用的服务，比如消息队列MNS或函数计算FC。对于MNS，用户可以从接收到的消息中获取，对于FC，用户可以从Event中获取。详情请参见[服务集成模式](~~2592915~~)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'djEjYSNkZTdkYWZjMi0zMGRlLTRlMDMtOTA2OC0yMTMxYmM5NGJlZTIjNSMvV1ZHYks3RTc0WUsra25nQTNYSmtFa0t6U****'], ], [ 'name' => 'Output', 'in' => 'formData', - 'schema' => [ - 'description' => '汇报任务指定的输出信息。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{"key":"value"}', - ], + 'schema' => ['description' => '汇报任务指定的输出信息。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"key":"value"}'], ], ], 'responses' => [ @@ -4704,93 +2377,39 @@ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'EventId' => [ - 'description' => '事件ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'testRequestId', - ], + 'EventId' => ['description' => '事件ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestId'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ActionNotSupported', - 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', - ], - [ - 'errorCode' => 'APIVersionNotSupported', - 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', - ], - [ - 'errorCode' => 'EntityTooLarge', - 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', - ], - [ - 'errorCode' => 'InvalidArgument', - 'errorMessage' => 'Parameter error.', - ], - [ - 'errorCode' => 'MissingRequiredHeader', - 'errorMessage' => 'The HTTP header \'%s\' must be specified.', - ], - [ - 'errorCode' => 'MissingRequiredParams', - 'errorMessage' => 'The HTTP query \'%s\' must be specified.', - ], - [ - 'errorCode' => 'TaskAlreadyCompleted', - 'errorMessage' => 'Task %s has already completed.', - ], + ['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''], + ['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''], + ['errorCode' => 'EntityTooLarge', 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', 'description' => ''], + ['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => ''], + ['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => ''], + ['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => ''], + ['errorCode' => 'TaskAlreadyCompleted', 'errorMessage' => 'Task %s has already completed.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessDenied', - 'errorMessage' => 'The resources doesn\'t belong to you.', - ], - [ - 'errorCode' => 'InvalidAccessKeyID', - 'errorMessage' => 'The AccessKey ID %s is invalid.', - ], - [ - 'errorCode' => 'RequestTimeTooSkewed', - 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', - ], - [ - 'errorCode' => 'SignatureNotMatch', - 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', - ], + ['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''], + ['errorCode' => 'InvalidAccessKeyID', 'errorMessage' => 'The AccessKey ID %s is invalid.', 'description' => ''], + ['errorCode' => 'RequestTimeTooSkewed', 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', 'description' => ''], + ['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => ''], ], 409 => [ - [ - 'errorCode' => 'TaskInvalidState', - 'errorMessage' => 'Task is in an invalid state, please retry.', - ], + ['errorCode' => 'TaskInvalidState', 'errorMessage' => 'Task is in an invalid state, please retry.', 'description' => ''], ], 415 => [ - [ - 'errorCode' => 'UnsupportedMediaType', - 'errorMessage' => 'The content type must be "application/json".', - ], + ['errorCode' => 'UnsupportedMediaType', 'errorMessage' => 'The content type must be "application/json".', 'description' => ''], ], 429 => [ - [ - 'errorCode' => 'ResourceThrottled', - 'errorMessage' => 'The request is throttled. Please try again later.', - ], + ['errorCode' => 'ResourceThrottled', 'errorMessage' => 'The request is throttled. Please try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'An internal error has occurred. Please retry.', - ], + ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"EventId\\": 1,\\n \\"RequestId\\": \\"testRequestId\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', @@ -4800,15 +2419,25 @@ .'在旧版Serverless 工作流中，使用该接口回调pattern: waitForCallback的任务步骤，表明当前任务执行成功。'."\n" ."\n" .'在新版云工作流中，使用该接口回调TaskMode: WaitForCustomCallback的任务步骤，表明当前任务执行成功。', - ], - 'CreateSchedule' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'fnf:ReportTaskSucceeded', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'StartExecution' => [ + 'summary' => '开始一个流程的执行。', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4817,134 +2446,217 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '98855', - 'abilityTreeNodes' => [ - 'FEATUREfnf06LH4G', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '98867', + 'abilityTreeNodes' => ['FEATUREfnf8CPMA5'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'FlowName', 'in' => 'formData', - 'schema' => [ - 'description' => '定时调度绑定的工作流名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_flow_name', - ], + 'schema' => ['description' => '开始执行的流程名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_flow_name'], ], [ - 'name' => 'ScheduleName', + 'name' => 'ExecutionName', 'in' => 'formData', - 'schema' => [ - 'description' => '定时调度的名称。取值说明如下：'."\n" - ."\n" - .'- 支持英文字符（a~z）或（A~Z）、数字（0~9）、下划线（_）和短划线（-）。'."\n" - .'- 首字母必须为英文字母（a~z）、（A~Z）或下划线（_）。'."\n" - .'- 区分大小写。'."\n" - .'- 长度为1~128个字符。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_schedule_name', - ], + 'schema' => ['description' => '执行名称，在同一流程内唯一。取值说明如下：'."\n" + ."\n" + .'- 首字母必须为英文字母（a~z）、（A~Z）或下划线（_）。'."\n" + .'- 支持英文字符（a~z）或（A~Z）、数字（0~9）、下划线（_）和短划线（-）。'."\n" + .'- 区分大小写。'."\n" + .'- 长度为1~128个字符。', 'type' => 'string', 'required' => false, 'example' => 'my_exec_name'], ], [ - 'name' => 'Description', + 'name' => 'Input', 'in' => 'formData', - 'schema' => [ - 'description' => '定时调度的描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'my test schedule', - ], + 'schema' => ['description' => '执行的输入，为JSON对象格式。', 'type' => 'string', 'required' => false, 'example' => '{"key":"value"}'], ], [ - 'name' => 'Payload', + 'name' => 'CallbackFnFTaskToken', 'in' => 'formData', - 'schema' => [ - 'description' => '定时调度的触发消息，必须为JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{"key": "value"}', - ], + 'schema' => ['description' => '流程执行结束后回调**TaskToken**相关任务。', 'type' => 'string', 'required' => false, 'example' => '12'], ], [ - 'name' => 'CronExpression', + 'name' => 'Qualifier', 'in' => 'formData', + 'schema' => ['title' => '指定流程版本或别名', 'description' => '指定流程版本或别名', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Cron表达式。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0 * * * * *', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '执行状态。取值说明如下：'."\n" + .'- **Starting**'."\n" + .'- **Running**'."\n" + .'- **Stopped**'."\n" + .'- **Succeeded**'."\n" + .'- **Failed**'."\n" + .'- **TimedOut**', 'type' => 'string', 'example' => 'Succeeded'], + 'StoppedTime' => ['description' => '执行停止时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestId'], + 'StartedTime' => ['description' => '执行开始时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'], + 'FlowDefinition' => ['description' => '执行的流程定义。', 'type' => 'string', 'example' => 'Legacy version:'."\n" + .'"type: flow\\nversion: v1\\nname: my_flow_name\\nsteps:\\n - type: pass\\n name: mypass"'."\n" + ."\n" + .'New version:'."\n" + .'"Type: StateMachine\\nSpecVersion: v1\\nName: my_flow_name\\nStartAt: my_state\\nStates:\\n - Type: Pass\\n Name: my_state\\n End: true"'], + 'Output' => ['description' => '执行的输出，为JSON对象格式。', 'type' => 'string', 'example' => '{"key":"value"}'], + 'FlowName' => ['description' => '流程名称。', 'type' => 'string', 'example' => 'my_flow_name'], + 'Name' => ['description' => '执行名称。', 'type' => 'string', 'example' => 'my_exec_name'], + 'Input' => ['description' => '执行的输入，为JSON对象格式。', 'type' => 'string', 'example' => '{"key":"value"}'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''], + ['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''], + ['errorCode' => 'EntityTooLarge', 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', 'description' => '请求消息体过大。'], + ['errorCode' => 'ExecutionAlreadyExists', 'errorMessage' => 'Execution %s for flow %s already exists.', 'description' => '对应流程下已存在同名执行。'], + ['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => '请求参数错误。具体内容请参考实际错误信息。'], + ['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'], + ['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'], + ], + 403 => [ + ['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''], + ['errorCode' => 'InvalidAccessKeyID', 'errorMessage' => 'The AccessKey ID %s is invalid.', 'description' => 'AccessKey ID无效。'], + ['errorCode' => 'RequestTimeTooSkewed', 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', 'description' => '您的请求时间不正确，该请求已被识别为无效。请参考通用参数一节。'], + ['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => '您发起请求的签名与我们计算不一致，请检查您的签名算法及AccessKey Secret。'], + ], [ - 'name' => 'Enable', - 'in' => 'formData', - 'schema' => [ - 'description' => '是否启用定时调度。取值说明如下：'."\n" - .'- **true**：启用。'."\n" - .'- **false**：禁用。'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + ['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => '所请求资源不存在，请确保流程已创建。'], + ], + 415 => [ + ['errorCode' => 'UnsupportedMediaType', 'errorMessage' => 'The content type must be "application/json".', 'description' => '请求消息体类型错误。'], + ], + 429 => [ + ['errorCode' => 'ResourceThrottled', 'errorMessage' => 'The request is throttled. Please try again later.', 'description' => '因某些原因系统流量已达瓶颈。请稍后重试。'], + ], + 500 => [ + ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => '服务器内部错误。请稍后重试。'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"Succeeded\\",\\n \\"StoppedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"StartedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"FlowDefinition\\": \\"Legacy version:\\\\n\\\\\\"type: flow\\\\\\\\nversion: v1\\\\\\\\nname: my_flow_name\\\\\\\\nsteps:\\\\\\\\n - type: pass\\\\\\\\n name: mypass\\\\\\"\\\\n\\\\nNew version:\\\\n\\\\\\"Type: StateMachine\\\\\\\\nSpecVersion: v1\\\\\\\\nName: my_flow_name\\\\\\\\nStartAt: my_state\\\\\\\\nStates:\\\\\\\\n - Type: Pass\\\\\\\\n Name: my_state\\\\\\\\n End: true\\\\\\"\\",\\n \\"Output\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"FlowName\\": \\"my_flow_name\\",\\n \\"Name\\": \\"my_exec_name\\",\\n \\"Input\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '异步调用开始一个流程的执行', + 'description' => '## 接口说明'."\n" + .'- 流程必须已经存在，当前仅支持 Standard 执行模式的流程。'."\n" + .'- 如果没有指定执行名称，则服务会自动生成执行名称并开始执行。'."\n" + .'- 如果有同名执行正在进行，则不会开始新的执行，直接返回正在进行中的同名执行。'."\n" + .'- 如果同名执行已经结束（成功或者失败），则会返回`ExecutionAlreadyExists`。'."\n" + .'- 如果没有同名执行，则开始新的执行。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'fnf:StartExecution', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], + ], + 'StartSyncExecution' => [ + 'summary' => '同步调用开始一个流程的执行。', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '195751', + 'abilityTreeNodes' => ['FEATUREfnf8CPMA5'], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'FlowName', + 'in' => 'formData', + 'schema' => ['description' => '开始执行的流程名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_flow_name'], + ], + [ + 'name' => 'ExecutionName', + 'in' => 'formData', + 'schema' => ['description' => '执行名称。取值说明如下：'."\n" + ."\n" + .'- 支持英文字符（a~z）或（A~Z）、数字（0~9）、下划线（_）和短划线（-）。'."\n" + .'- 首字母必须为英文字母（a~z）、（A~Z）或下划线（_）。'."\n" + .'- 区分大小写。'."\n" + .'- 长度为1~128个字符。'."\n" + ."\n" + .'不同于StartExecution接口，考虑到同步调用的特殊性，在同步执行模式下，不再要求执行名称在同一流程内唯一，调用侧可以选择提供执行名称，对本次执行进行标识，系统会在当前执行名称后添加UUID，具体形式如 {ExecutionName}:{UUID}，如果用户没有指定相关的执行名称信息，那么系统会自动生成标识本次执行的ExecutionName。', 'type' => 'string', 'required' => false, 'example' => 'my_exec_name'], + ], + [ + 'name' => 'Input', + 'in' => 'formData', + 'schema' => ['description' => '执行的输入，为JSON对象格式。', 'type' => 'string', 'required' => false, 'example' => '{"key":"value"}'], + ], + [ + 'name' => 'Qualifier', + 'in' => 'formData', + 'schema' => ['title' => '指定流程版本或别名', 'description' => '指定流程版本或别名', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'testRequestId', - ], - 'Description' => [ - 'description' => '定时调度的描述。', - 'type' => 'string', - 'example' => 'test description', - ], - 'ScheduleId' => [ - 'description' => '定时调度的ID。', - 'type' => 'string', - 'example' => 'testScheduleId', - ], - 'Payload' => [ - 'description' => '定时调度的触发消息。', - 'type' => 'string', - 'example' => '{"key": "value"}', - ], - 'ScheduleName' => [ - 'description' => '定时调度的名称。', - 'type' => 'string', - 'example' => 'testScheduleName', - ], - 'CreatedTime' => [ - 'description' => '定时调度的创建时间。', - 'type' => 'string', - 'example' => '2020-01-01T01:01:01.001Z', - ], - 'LastModifiedTime' => [ - 'description' => '定时调度最近一次的更改时间。', - 'type' => 'string', - 'example' => '2020-01-01T01:01:01.001Z', - ], - 'CronExpression' => [ - 'description' => 'Cron表达式。', - 'type' => 'string', - 'example' => '0 * * * * *', - ], - 'Enable' => [ - 'description' => '是否启用定时调度。', - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestId'], + 'FlowName' => ['description' => '流程名称。', 'type' => 'string', 'example' => 'my_flow_name'], + 'Name' => ['description' => '流程执行名称。', 'type' => 'string', 'example' => 'my_exec_name:{UUID}'], + 'Status' => ['description' => '执行状态。取值说明如下：'."\n" + .'- **Starting**'."\n" + .'- **Running**'."\n" + .'- **Stopped**'."\n" + .'- **Succeeded**'."\n" + .'- **Failed**'."\n" + .'- **TimedOut**', 'type' => 'string', 'example' => 'Succeeded'], + 'ErrorCode' => ['description' => '执行错误时的错误码。', 'type' => 'string', 'example' => 'ActionNotSupported'], + 'ErrorMessage' => ['description' => '执行超时。', 'type' => 'string', 'example' => 'Standard execution is not supported'], + 'Output' => ['description' => '执行的输出，为JSON对象格式。', 'type' => 'string', 'example' => '{"key":"value"}'], + 'StartedTime' => ['description' => '执行开始时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'], + 'StoppedTime' => ['description' => '执行停止时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'], + 'Environment' => [ + 'title' => 'Flow 执行时使用的环境变量列表', + 'description' => 'Flow 执行时使用的环境变量列表', + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'title' => 'Flow 执行时使用的环境变量列表', + 'description' => 'Flow 执行时使用的环境变量列表', + 'type' => 'array', + 'items' => [ + 'title' => 'Flow 执行期间可以访问的变量列表', + 'description' => 'Flow 执行期间可以访问的变量列表', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '变量名称', 'description' => '变量名称', 'type' => 'string', 'example' => 'key'], + 'Value' => ['title' => '变量值', 'description' => '变量值', 'type' => 'string', 'example' => 'value'], + ], + ], + ], + ], ], ], ], @@ -4952,67 +2664,58 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'APIVersionNotSupported', - 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', - ], - [ - 'errorCode' => 'InvalidArgument', - 'errorMessage' => 'Parameter error.', - ], - [ - 'errorCode' => 'MissingRequiredHeader', - 'errorMessage' => 'The HTTP header \'%s\' must be specified.', - ], - [ - 'errorCode' => 'MissingRequiredParams', - 'errorMessage' => 'The HTTP query \'%s\' must be specified.', - ], + ['errorCode' => 'EntityTooLarge', 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', 'description' => '请求消息体过大。'], + ['errorCode' => 'ExecutionAlreadyExists', 'errorMessage' => 'Execution %s for flow %s already exists.', 'description' => '对应流程下已存在同名执行。'], + ['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => '请求参数错误。具体内容请参考实际错误信息。'], + ['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'], + ['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'], + ['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation %s is incorrect. Please check.', 'description' => '所请求方法错误。请参照API文档并检查拼写。'], + ['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version %s is not supported yet. Please check.', 'description' => '所请求接口版本不正确。请参考API简介。'], ], 403 => [ - [ - 'errorCode' => 'AccessDenied', - 'errorMessage' => 'The resources doesn\'t belong to you.', - ], + ['errorCode' => 'InvalidAccessKeyID', 'errorMessage' => 'The AccessKey ID %s is invalid.', 'description' => 'AccessKey ID无效。'], + ['errorCode' => 'RequestTimeTooSkewed', 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', 'description' => '您的请求时间不正确，该请求已被识别为无效。请参考通用参数一节。'], + ['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => '您发起请求的签名与我们计算不一致，请检查您的签名算法及AccessKey Secret。'], + ['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources does not belong to you.', 'description' => '请求鉴权未通过，具体内容请参考实际错误信息。'], ], [ - [ - 'errorCode' => 'FlowNotExists', - 'errorMessage' => 'Flow %s does not exist.', - ], + ['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => '所请求资源不存在，请确保流程已创建。'], ], - 409 => [ - [ - 'errorCode' => 'ConcurrentUpdateError', - 'errorMessage' => 'Update conflict, please retry.', - ], - [ - 'errorCode' => 'ScheduleAlreadyExists', - 'errorMessage' => 'The schedule %s already exists in flow %s.', - ], + 415 => [ + ['errorCode' => 'UnsupportedMediaType', 'errorMessage' => 'The content type must be "application/json".', 'description' => '请求消息体类型错误。'], + ], + 429 => [ + ['errorCode' => 'ResourceThrottled', 'errorMessage' => 'The request is throttled. Please try again later.', 'description' => '因某些原因系统流量已达瓶颈。请稍后重试。'], ], 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'An internal error has occurred. Please retry.', - ], + ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => '服务器内部错误。请稍后重试。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"FlowName\\": \\"my_flow_name\\",\\n \\"Name\\": \\"my_exec_name:{UUID}\\",\\n \\"Status\\": \\"Succeeded\\",\\n \\"ErrorCode\\": \\"ActionNotSupported\\",\\n \\"ErrorMessage\\": \\"Standard execution is not supported\\",\\n \\"Output\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"StartedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"StoppedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"Environment\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"key\\",\\n \\"Value\\": \\"value\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '同步调用开始一个流程的执行', + 'description' => '- 仅支持 Express 执行模式的流程。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'fnf:StartSyncExecution', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"Description\\": \\"test description\\",\\n \\"ScheduleId\\": \\"testScheduleId\\",\\n \\"Payload\\": \\"{\\\\\\"key\\\\\\": \\\\\\"value\\\\\\"}\\",\\n \\"ScheduleName\\": \\"testScheduleName\\",\\n \\"CreatedTime\\": \\"2020-01-01T01:01:01.001Z\\",\\n \\"LastModifiedTime\\": \\"2020-01-01T01:01:01.001Z\\",\\n \\"CronExpression\\": \\"0 * * * * *\\",\\n \\"Enable\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '创建一个定时调度（仅适用于旧版工作流）', - 'summary' => '创建一个定时调度。', ], - 'DeleteSchedule' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StopExecution' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5021,35 +2724,31 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '98857', - 'abilityTreeNodes' => [ - 'FEATUREfnf06LH4G', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '98868', + 'abilityTreeNodes' => ['FEATUREfnf8CPMA5'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'FlowName', 'in' => 'formData', - 'schema' => [ - 'description' => '待删除调度任务绑定的流程名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'flow', - ], + 'schema' => ['description' => '需要停止的流程名称，可以通过**ListFlows**的返回值获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_flow_name'], ], [ - 'name' => 'ScheduleName', + 'name' => 'ExecutionName', 'in' => 'formData', - 'schema' => [ - 'description' => '待删除调度的名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'testScheduleName', - ], + 'schema' => ['description' => '需要停止的执行名称，可以通过**ListExecutions**的返回值获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_exec_name'], + ], + [ + 'name' => 'Cause', + 'in' => 'formData', + 'schema' => ['description' => '停止错误原因。长度为1~4096个字符。', 'type' => 'string', 'required' => false, 'example' => 'for test'], + ], + [ + 'name' => 'Error', + 'in' => 'formData', + 'schema' => ['description' => '停止错误代码。长度为1~128个字符。', 'type' => 'string', 'required' => false, 'example' => 'InvalidArgument'], ], ], 'responses' => [ @@ -5058,88 +2757,91 @@ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'testRequestId', - ], + 'Status' => ['description' => '执行状态。取值说明如下：'."\n" + .'- **Starting**'."\n" + .'- **Running**'."\n" + .'- **Stopped**'."\n" + .'- **Succeeded**'."\n" + .'- **Failed**'."\n" + .'- **TimedOut**', 'type' => 'string', 'example' => 'Running'], + 'StoppedTime' => ['description' => '执行停止时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestId'], + 'StartedTime' => ['description' => '执行开始时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'], + 'FlowDefinition' => ['description' => '执行的流程定义。', 'type' => 'string', 'example' => 'Legacy version:'."\n" + .'"type: flow\\nversion: v1\\nname: my_flow_name\\nsteps:\\n - type: pass\\n name: mypass"'."\n" + ."\n" + .'New version:'."\n" + .'"Type: StateMachine\\nSpecVersion: v1\\nName: my_flow_name\\nStartAt: my_state\\nStates:\\n - Type: Pass\\n Name: my_state\\n End: true"'], + 'Output' => ['description' => '执行的输出，为JSON对象格式。', 'type' => 'string', 'example' => '{"key":"value"}'], + 'FlowName' => ['description' => '流程名称。', 'type' => 'string', 'example' => 'my_flow_name'], + 'Name' => ['description' => '执行名称。', 'type' => 'string', 'example' => 'my_exec_name'], + 'Input' => ['description' => '执行的输入，为JSON对象格式。', 'type' => 'string', 'example' => '{"key":"value"}'], + 'RoleArn' => ['description' => '执行的角色权限配置。若流程定义中的RoleArn在执行期间发生变更，系统将记录并返回执行初始时刻的RoleArn的快照。'."\n" + .'> 如果您的流程在执行时未配置执行角色，则该字段不会出现。', 'type' => 'string', 'example' => 'acs:ram:${region}:${accountID}:${role}'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ActionNotSupported', - 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', - ], - [ - 'errorCode' => 'APIVersionNotSupported', - 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', - ], - [ - 'errorCode' => 'InvalidArgument', - 'errorMessage' => 'Parameter error.', - ], - [ - 'errorCode' => 'MissingRequiredHeader', - 'errorMessage' => 'The HTTP header \'%s\' must be specified.', - ], - [ - 'errorCode' => 'MissingRequiredParams', - 'errorMessage' => 'The HTTP query \'%s\' must be specified.', - ], + ['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''], + ['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''], + ['errorCode' => 'EntityTooLarge', 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', 'description' => '请求消息体过大。'], + ['errorCode' => 'ExecutionAlreadyCompleted', 'errorMessage' => 'Execution \'%s\' for flow \'%s\' has already completed.', 'description' => ''], + ['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => '请求参数错误。具体内容请参考实际错误信息。'], + ['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'], + ['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'], ], 403 => [ - [ - 'errorCode' => 'AccessDenied', - 'errorMessage' => 'The resources doesn\'t belong to you.', - ], + ['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''], + ['errorCode' => 'InvalidAccessKeyID', 'errorMessage' => 'The AccessKey ID %s is invalid.', 'description' => 'AccessKey ID无效。'], + ['errorCode' => 'RequestTimeTooSkewed', 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', 'description' => '您的请求时间不正确，该请求已被识别为无效。请参考通用参数一节。'], + ['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => '您发起请求的签名与我们计算不一致，请检查您的签名算法及AccessKey Secret。'], ], [ - [ - 'errorCode' => 'FlowNotExists', - 'errorMessage' => 'Flow %s does not exist.', - ], - [ - 'errorCode' => 'ScheduleNotExists', - 'errorMessage' => 'The schedule %s for flow %s does not exist.', - ], + ['errorCode' => 'ExecutionNotExists', 'errorMessage' => 'Execution %s for flow %s does not exist.', 'description' => '所请求资源不存在，请确保流程已创建并存在待查询的执行。'], + ['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => '所请求资源不存在，请确保流程已创建。'], ], 409 => [ - [ - 'errorCode' => 'ConcurrentUpdateError', - 'errorMessage' => 'Update conflict, please retry.', - ], + ['errorCode' => 'ConcurrentUpdateError', 'errorMessage' => 'Update conflict, please retry.', 'description' => '所请求资源存在并发写操作。请等待一段时间后再次操作。'], ], - 412 => [ - [ - 'errorCode' => 'PreconditionFailed', - 'errorMessage' => 'The resource to be modified has been changed.', - ], + 415 => [ + ['errorCode' => 'UnsupportedMediaType', 'errorMessage' => 'The content type must be "application/json".', 'description' => '请求消息体类型错误。'], + ], + 429 => [ + ['errorCode' => 'ResourceThrottled', 'errorMessage' => 'The request is throttled. Please try again later.', 'description' => '因某些原因系统流量已达瓶颈。请稍后重试。'], ], 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'An internal error has occurred. Please retry.', - ], + ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => '服务器内部错误。请稍后重试。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"Running\\",\\n \\"StoppedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"StartedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"FlowDefinition\\": \\"Legacy version:\\\\n\\\\\\"type: flow\\\\\\\\nversion: v1\\\\\\\\nname: my_flow_name\\\\\\\\nsteps:\\\\\\\\n - type: pass\\\\\\\\n name: mypass\\\\\\"\\\\n\\\\nNew version:\\\\n\\\\\\"Type: StateMachine\\\\\\\\nSpecVersion: v1\\\\\\\\nName: my_flow_name\\\\\\\\nStartAt: my_state\\\\\\\\nStates:\\\\\\\\n - Type: Pass\\\\\\\\n Name: my_state\\\\\\\\n End: true\\\\\\"\\",\\n \\"Output\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"FlowName\\": \\"my_flow_name\\",\\n \\"Name\\": \\"my_exec_name\\",\\n \\"Input\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"RoleArn\\": \\"acs:ram:${region}:${accountID}:${role}\\"\\n}","errorExample":""},{"type":"xml","example":"<StopExecutionResponse>\\n <Status>Running</Status>\\n <StoppedTime>2019-01-01T01:01:01.001Z</StoppedTime>\\n <RequestId>testRequestId</RequestId>\\n <StartedTime>2019-01-01T01:01:01.001Z</StartedTime>\\n <FlowDefinition>version: v1.0\\\\ntype: flow\\\\nname: test\\\\nsteps:\\\\n - type: pass\\\\n name: mypass</FlowDefinition>\\n <Output>{\\"key\\":\\"value\\"}</Output>\\n <FlowName>flow</FlowName>\\n <Name>exec</Name>\\n <Input>{\\"key\\":\\"value\\"}</Input>\\n</StopExecutionResponse>","errorExample":""}]', + 'title' => '停止一个正在执行的流程', + 'summary' => '停止一个正在执行的流程。', + 'description' => '## 接口说明'."\n" + .'流程必须为执行中。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'fnf:StopExecution', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"testRequestId\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '删除一个定时调度（仅适用于旧版工作流）', - 'summary' => '删除一个定时调度。', ], - 'UpdateSchedule' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateFlow' => [ + 'summary' => '更新一个流程的内容。', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5149,84 +2851,87 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '98870', - 'abilityTreeNodes' => [ - 'FEATUREfnf06LH4G', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '98869', + 'abilityTreeNodes' => ['FEATUREfnf8CPMA5'], ], 'parameters' => [ [ - 'name' => 'FlowName', + 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => '定时调度绑定的流程名称。该名称在同一地域内唯一，创建后不可修改。取值说明如下：'."\n" - ."\n" - .'- 支持英文字符（a~z）或（A~Z）、数字（0~9）、下划线（_）和短划线（-）。'."\n" - .'- 首字母必须为英文字母（a~z）、（A~Z）或下划线（_）。'."\n" - .'- 区分大小写。'."\n" - .'- 长度为1~128个字符。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_flow_name', - ], + 'schema' => ['description' => '已创建的流程名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_flow_name'], ], [ - 'name' => 'ScheduleName', + 'name' => 'Definition', 'in' => 'formData', - 'schema' => [ - 'description' => '定时调度的名称。取值说明如下：'."\n" - ."\n" - .'- 支持英文字符（a~z）或（A~Z）、数字（0~9）、下划线（_）和短划线（-）。'."\n" - .'- 首字母必须为英文字母（a~z）、（A~Z）或下划线（_）。'."\n" - .'- 区分大小写。'."\n" - .'- 长度为1~128个字符。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_schedule_name', - ], + 'schema' => ['description' => '流程定义，遵循Flow Definition Language (FDL)语法标准。考虑到向前兼容，当系统支持两种规范的流程定义规范。'."\n" + .'> '."\n" + .'> 以上流程定义示例中Name：my_flow_name是指流程名称，需和入参Name保持一致', 'type' => 'string', 'required' => false, 'example' => 'Legacy version:'."\n" + .'"'."\n" + .'type: flow'."\n" + .'version: v1'."\n" + .'name: my_flow_name'."\n" + .'steps:'."\n" + .' - type: pass'."\n" + .' name: mypass'."\n" + .'"'."\n" + ."\n" + .'New version:'."\n" + .'"'."\n" + .'Type: StateMachine'."\n" + .'SpecVersion: v1'."\n" + .'Name: my_flow_name'."\n" + .'StartAt: my_state'."\n" + .'States:'."\n" + .' - Type: Pass'."\n" + .' Name: my_state'."\n" + .' End: true'."\n" + .'"'], ], [ 'name' => 'Description', 'in' => 'formData', - 'schema' => [ - 'description' => '定时调度的描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'my test schedule', - ], + 'schema' => ['description' => '流程描述。', 'type' => 'string', 'required' => false, 'example' => 'my test flow'], ], [ - 'name' => 'Payload', + 'name' => 'Type', 'in' => 'formData', - 'schema' => [ - 'description' => '定时调度的触发消息，必须为JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{"key": "value"}', - ], + 'schema' => ['description' => '流程类型，取值：**FDL**。', 'type' => 'string', 'required' => false, 'example' => 'FDL'], ], [ - 'name' => 'CronExpression', + 'name' => 'RoleArn', 'in' => 'formData', - 'schema' => [ - 'description' => 'Cron表达式。', - 'type' => 'string', - 'required' => false, - 'example' => '0 * * * * *', - ], + 'schema' => ['description' => '流程执行依赖的授权角色资源描述符信息。用于在执行流程时，流程执行引擎扮演该角色（AssumeRole）调用相关的流程资源API。', 'type' => 'string', 'required' => false, 'example' => 'acs:ram:${region}:${accountID}:${role}'], ], [ - 'name' => 'Enable', + 'name' => 'Environment', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '是否启用定时调度。取值说明如下：'."\n" - .'- **true**：启用。'."\n" - .'- **false**：禁用。', - 'type' => 'boolean', + 'title' => '配置 Flow 执行期间可以访问的变量列表', + 'description' => '配置 Flow 执行期间可以访问的变量列表', + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'title' => '配置 Flow 执行期间可以访问的变量列表', + 'description' => '配置 Flow 执行期间可以访问的变量列表', + 'type' => 'array', + 'items' => [ + 'title' => '配置 Flow 执行期间可以访问的变量列表', + 'description' => '配置 Flow 执行期间可以访问的变量列表', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '变量名称', 'description' => '变量名称', 'type' => 'string', 'required' => false, 'example' => 'key'], + 'Value' => ['title' => '变量值', 'description' => '变量值', 'type' => 'string', 'required' => false, 'example' => 'value'], + 'Description' => ['title' => '变量描述', 'description' => '变量描述', 'type' => 'string', 'required' => false, 'example' => 'description'], + ], + 'required' => false, + ], + 'required' => false, + ], + ], 'required' => false, - 'example' => 'true', ], ], ], @@ -5236,123 +2941,208 @@ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'testRequestId', - ], - 'Description' => [ - 'description' => '定时调度的描述。', - 'type' => 'string', - 'example' => 'my test schedule', - ], - 'ScheduleId' => [ - 'description' => '定时调度的ID。', - 'type' => 'string', - 'example' => 'testScheduleId', - ], - 'Payload' => [ - 'description' => '定时调度的触发消息。', - 'type' => 'string', - 'example' => '{"key": "value"}', - ], - 'ScheduleName' => [ - 'description' => '定时调度的名称。', - 'type' => 'string', - 'example' => 'my_schedule_name', - ], - 'CreatedTime' => [ - 'description' => '定时调度的创建时间。', - 'type' => 'string', - 'example' => '2020-01-01T01:01:01.001Z', - ], - 'LastModifiedTime' => [ - 'description' => '定时调度最近一次的更新时间。', - 'type' => 'string', - 'example' => '2020-01-01T01:01:01.001Z', - ], - 'CronExpression' => [ - 'description' => 'Cron表达式。', - 'type' => 'string', - 'example' => '0 * * * * *', - ], - 'Enable' => [ - 'description' => '是否启用定时调度。取值说明如下：'."\n" - .'- **true**：启用。'."\n" - .'- **false**：禁用。', - 'type' => 'boolean', - 'example' => 'true', + 'Type' => ['description' => '流程类型。', 'type' => 'string', 'example' => 'FDL'], + 'Definition' => ['description' => '流程定义，遵循Flow Definition Language (FDL)语法标准。考虑到向前兼容，当系统支持两种规范的流程定义规范。', 'type' => 'string', 'example' => 'Legacy version:'."\n" + .'"type: flow\\nversion: v1\\nname: my_flow_name\\nsteps:\\n - type: pass\\n name: mypass"'."\n" + ."\n" + .'New version:'."\n" + .'"Type: StateMachine\\nSpecVersion: v1\\nName: my_flow_name\\nStartAt: my_state\\nStates:\\n - Type: Pass\\n Name: my_state\\n End: true"'], + 'RoleArn' => ['description' => '流程执行依赖的授权角色资源描述符信息。用于在执行流程时，流程执行引擎扮演该角色（AssumeRole）调用相关的流程资源API。', 'type' => 'string', 'example' => 'acs:ram:${region}:${accountID}:${role}'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestID'], + 'Description' => ['description' => '流程描述。', 'type' => 'string', 'example' => 'my test flow'], + 'ExternalStorageLocation' => ['description' => '外部存储位置。', 'type' => 'string', 'example' => '/path'], + 'Name' => ['description' => '流程名称。', 'type' => 'string', 'example' => 'my_flow_name'], + 'CreatedTime' => ['description' => '流程创建时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'], + 'LastModifiedTime' => ['description' => '流程最近一次的更改时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'], + 'Id' => ['description' => '流程的唯一ID。', 'type' => 'string', 'example' => 'e589e092-e2c0-4dee-b306-3574ddfdddf5****'], + 'Environment' => [ + 'title' => 'Flow 执行期间可以访问的变量列表', + 'description' => 'Flow 执行期间可以访问的变量列表', + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'title' => 'Flow 执行期间可以访问的变量列表', + 'description' => 'Flow 执行期间可以访问的变量列表', + 'type' => 'array', + 'items' => [ + 'title' => 'Flow 执行期间可以访问的变量列表', + 'description' => 'Flow 执行期间可以访问的变量列表', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '变量名称', 'description' => '变量名称', 'type' => 'string', 'example' => 'key'], + 'Value' => ['title' => '变量值', 'description' => '变量值', 'type' => 'string', 'example' => 'value'], + 'Description' => ['title' => '变量描述', 'description' => '变量描述', 'type' => 'string', 'example' => 'description'], + ], + ], + ], + ], ], + 'ResourceGroupId' => ['title' => '资源组id', 'type' => 'string', 'example' => 'rg-xxx'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'APIVersionNotSupported', - 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', - ], - [ - 'errorCode' => 'InvalidArgument', - 'errorMessage' => 'Parameter error.', - ], - [ - 'errorCode' => 'MissingRequiredHeader', - 'errorMessage' => 'The HTTP header \'%s\' must be specified.', - ], - [ - 'errorCode' => 'MissingRequiredParams', - 'errorMessage' => 'The HTTP query \'%s\' must be specified.', - ], + ['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''], + ['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''], + ['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => '请求参数错误。具体内容请参考实际错误信息。'], + ['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'], + ['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'], ], 403 => [ - [ - 'errorCode' => 'AccessDenied', - 'errorMessage' => 'The resources doesn\'t belong to you.', - ], + ['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''], + ['errorCode' => 'InvalidAccessKeyID', 'errorMessage' => 'The AccessKey ID %s is invalid.', 'description' => 'AccessKey ID无效。'], + ['errorCode' => 'RequestTimeTooSkewed', 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', 'description' => '您的请求时间不正确，该请求已被识别为无效。请参考通用参数一节。'], + ['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => '您发起请求的签名与我们计算不一致，请检查您的签名算法及AccessKey Secret。'], ], [ - [ - 'errorCode' => 'FlowNotExists', - 'errorMessage' => 'Flow %s does not exist.', - ], - [ - 'errorCode' => 'ScheduleNotExists', - 'errorMessage' => 'The schedule %s for flow %s does not exist.', - ], + ['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => '所请求资源不存在，请确保流程已创建。'], ], 409 => [ - [ - 'errorCode' => 'ConcurrentUpdateError', - 'errorMessage' => 'Update conflict, please retry.', - ], + ['errorCode' => 'ConcurrentUpdateError', 'errorMessage' => 'Update conflict, please retry.', 'description' => '所请求资源存在并发写操作。请等待一段时间后再次操作。'], ], 412 => [ - [ - 'errorCode' => 'PreconditionFailed', - 'errorMessage' => 'The resource to be modified has been changed.', - ], + ['errorCode' => 'PreconditionFailed', 'errorMessage' => 'The resource to be modified has been changed.', 'description' => '资源查看或更新检查失败，该资源可能已被更改。请稍后重试。'], + ], + 415 => [ + ['errorCode' => 'UnsupportedMediaType', 'errorMessage' => 'The content type must be "application/json".', 'description' => '请求消息体类型错误。'], + ], + 429 => [ + ['errorCode' => 'ResourceThrottled', 'errorMessage' => 'The request is throttled. Please try again later.', 'description' => '因某些原因系统流量已达瓶颈。请稍后重试。'], ], 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'An internal error has occurred. Please retry.', + ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => '服务器内部错误。请稍后重试。'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Type\\": \\"FDL\\",\\n \\"Definition\\": \\"Legacy version:\\\\n\\\\\\"type: flow\\\\\\\\nversion: v1\\\\\\\\nname: my_flow_name\\\\\\\\nsteps:\\\\\\\\n - type: pass\\\\\\\\n name: mypass\\\\\\"\\\\n\\\\nNew version:\\\\n\\\\\\"Type: StateMachine\\\\\\\\nSpecVersion: v1\\\\\\\\nName: my_flow_name\\\\\\\\nStartAt: my_state\\\\\\\\nStates:\\\\\\\\n - Type: Pass\\\\\\\\n Name: my_state\\\\\\\\n End: true\\\\\\"\\",\\n \\"RoleArn\\": \\"acs:ram:${region}:${accountID}:${role}\\",\\n \\"RequestId\\": \\"testRequestID\\",\\n \\"Description\\": \\"my test flow\\",\\n \\"ExternalStorageLocation\\": \\"/path\\",\\n \\"Name\\": \\"my_flow_name\\",\\n \\"CreatedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"LastModifiedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"Id\\": \\"e589e092-e2c0-4dee-b306-3574ddfdddf5****\\",\\n \\"Environment\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"key\\",\\n \\"Value\\": \\"value\\",\\n \\"Description\\": \\"description\\"\\n }\\n ]\\n },\\n \\"ResourceGroupId\\": \\"rg-xxx\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '更新一个已有流程', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'fnf:UpdateFlow', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"Description\\": \\"my test schedule\\",\\n \\"ScheduleId\\": \\"testScheduleId\\",\\n \\"Payload\\": \\"{\\\\\\"key\\\\\\": \\\\\\"value\\\\\\"}\\",\\n \\"ScheduleName\\": \\"my_schedule_name\\",\\n \\"CreatedTime\\": \\"2020-01-01T01:01:01.001Z\\",\\n \\"LastModifiedTime\\": \\"2020-01-01T01:01:01.001Z\\",\\n \\"CronExpression\\": \\"0 * * * * *\\",\\n \\"Enable\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '更新一个定时调度（仅适用于旧版工作流）', - 'summary' => '更新一个定时调度。', ], - 'DescribeSchedule' => [ - 'methods' => [ - 'get', + 'UpdateFlowAlias' => [ + 'summary' => '更新流程版本别名配置', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREfnf8CPMA5'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'FlowName', + 'in' => 'formData', + 'schema' => ['title' => '流程名称', 'description' => '流程名称', 'type' => 'string', 'required' => true, 'example' => 'example-flow-name'], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['title' => '别名名称', 'description' => '别名名称', 'type' => 'string', 'required' => true, 'example' => 'alias name'], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['title' => '别名描述', 'description' => '别名描述', 'type' => 'string', 'required' => false, 'example' => 'example description'], + ], + [ + 'name' => 'RoutingConfigurations', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '权重配置', + 'description' => '权重配置', + 'type' => 'array', + 'items' => [ + 'description' => '流量分发配置，支持配置一个或两个流程版本。当指定别名发起执行时，系统会根据权重选择对应的流程版本进行执行。', + 'type' => 'object', + 'properties' => [ + 'Version' => ['title' => '版本', 'description' => '版本', 'type' => 'string', 'required' => false, 'example' => '1'], + 'Weight' => ['description' => '权重', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '294D68C1-5108-5971-853A-1A9CC87B4816'], + 'Alias' => [ + 'title' => '别名信息', + 'description' => '别名信息', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '别名名称', 'description' => '别名名称', 'type' => 'string', 'example' => 'my-alias-name'], + 'Description' => ['title' => '别名描述', 'description' => '别名描述', 'type' => 'string', 'example' => 'my alias description'], + 'RoutingConfigurations' => [ + 'title' => '权重配置', + 'description' => '权重配置', + 'type' => 'array', + 'items' => [ + 'description' => '流量分发配置，支持配置一个或两个流程版本。当指定别名发起执行时，系统会根据权重选择对应的流程版本进行执行。', + 'type' => 'object', + 'properties' => [ + 'Version' => ['title' => '版本', 'description' => '版本', 'type' => 'string', 'example' => '1'], + 'Weight' => ['title' => '权重', 'description' => '权重', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + ], + ], + ], + 'CreatedTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-10-24T14:11:26+08:00'], + ], + ], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新流程别名配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"294D68C1-5108-5971-853A-1A9CC87B4816\\",\\n \\"Alias\\": {\\n \\"Name\\": \\"my-alias-name\\",\\n \\"Description\\": \\"my alias description\\",\\n \\"RoutingConfigurations\\": [\\n {\\n \\"Version\\": \\"1\\",\\n \\"Weight\\": 20\\n }\\n ],\\n \\"CreatedTime\\": \\"2025-10-24T14:11:26+08:00\\"\\n }\\n}","type":"json"}]', + ], + 'UpdateMapRun' => [ + 'summary' => '更新 MapRun 配置', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -5362,220 +3152,165 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '98860', - 'abilityTreeNodes' => [ - 'FEATUREfnf06LH4G', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227533', + 'abilityTreeNodes' => ['FEATUREfnfR0JC2A'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ + 'name' => 'RequestId', + 'in' => 'query', + 'schema' => ['description' => '请求ID。', 'type' => 'string', 'required' => false, 'example' => '3A44E113-9962-5B0B-AB92-14060EFE3164'], + ], + [ 'name' => 'FlowName', 'in' => 'query', - 'schema' => [ - 'description' => '定时调度绑定的流程名称。该名称在同一地域内唯一，创建后不可修改。取值说明如下：'."\n" - ."\n" - .'- 支持英文字符（a~z）或（A~Z）、数字（0~9）、下划线（_）和短划线（-）。'."\n" - .'- 首字母必须为英文字母（a~z）、（A~Z）或下划线（_）。'."\n" - .'- 区分大小写。'."\n" - .'- 长度为1~128个字符。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_test_flow', - ], + 'schema' => ['description' => '流程名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_flow_name'], ], [ - 'name' => 'ScheduleName', + 'name' => 'ExecutionName', 'in' => 'query', - 'schema' => [ - 'description' => '定时调度的名称。取值说明如下：'."\n" - ."\n" - .'- 支持英文字符（a~z）或（A~Z）、数字（0~9）、下划线（_）和短划线（-）。'."\n" - .'- 首字母必须为英文字母（a~z）、（A~Z）或下划线（_）。'."\n" - .'- 区分大小写。'."\n" - .'- 长度为1~128个字符。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_schedule_name', - ], + 'schema' => ['description' => '执行名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_exec_name'], + ], + [ + 'name' => 'MapRunName', + 'in' => 'query', + 'schema' => ['description' => 'MapRun 名称，当 Execution 中发起 MapRun 执行后，会产生 MapRunStarted 事件，MapRunName 可以从 MapRunStarted 事件的 Output 中获取。', 'type' => 'string', 'required' => true, 'example' => 'c39142f1345b196d678333c41f113100'], + ], + [ + 'name' => 'Concurrency', + 'in' => 'query', + 'schema' => ['description' => 'MapRun 运行时的并发限制。单账户配额默认最大300，可以通过配额中心提升。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ToleratedFailedCount', + 'in' => 'query', + 'schema' => ['description' => '允许失败的 Item 数量的最大值', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'], + ], + [ + 'name' => 'ToleratedFailedPercentage', + 'in' => 'query', + 'schema' => ['description' => '允许失败的 Item 数量占全部 Item 数量的最大百分比。取值区间为 0 - 100。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '20'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回数据。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'testRequestId', - ], - 'Description' => [ - 'description' => '定时调度的描述。', - 'type' => 'string', - 'example' => 'test description', - ], - 'ScheduleId' => [ - 'description' => '定时调度的ID。', - 'type' => 'string', - 'example' => 'testScheduleId', - ], - 'Payload' => [ - 'description' => '定时调度的触发消息。', - 'type' => 'string', - 'example' => '{"key": "value"}', - ], - 'ScheduleName' => [ - 'description' => '定时调度的名称。', - 'type' => 'string', - 'example' => 'my_schedule_name', - ], - 'CreatedTime' => [ - 'description' => '定时调度的创建时间。', - 'type' => 'string', - 'example' => '2020-01-01T01:01:01.001Z', - ], - 'LastModifiedTime' => [ - 'description' => '定时调度最近一次的更改时间。', - 'type' => 'string', - 'example' => '2020-01-01T01:01:01.001Z', - ], - 'CronExpression' => [ - 'description' => 'Cron表达式。', - 'type' => 'string', - 'example' => '0 * * * * *', - ], - 'Enable' => [ - 'description' => '是否启用定时调度。取值说明如下：'."\n" - .'- **true**：启用。'."\n" - .'- **false**：禁用。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3A44E113-9962-5B0B-AB92-14060EFE3164'], + 'FlowName' => ['description' => '流程名称', 'type' => 'string', 'example' => 'my_flow_name'], + 'ExecutionName' => ['description' => '执行名称。', 'type' => 'string', 'example' => 'my_exec_name'], + 'MapRunName' => ['description' => 'MapRun 名称，当 Execution 中发起 MapRun 执行后，会产生 MapRunStarted 事件，MapRunName 可以从 MapRunStarted 事件的 Output 中获取。', 'type' => 'string', 'example' => 'c39142f1345b196d678333c41f113000'], + 'Concurrency' => ['description' => 'MapRun 运行时的并发限制。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ToleratedFailedCount' => ['description' => '允许失败的 Item 数量的最大值', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'ToleratedFailedPercentage' => ['description' => '允许失败的 Item 数量占全部 Item 数量的最大百分比', 'type' => 'number', 'format' => 'float', 'example' => '20'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ActionNotSupported', - 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', - ], - [ - 'errorCode' => 'APIVersionNotSupported', - 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', - ], - [ - 'errorCode' => 'InvalidArgument', - 'errorMessage' => 'Parameter error.', - ], - [ - 'errorCode' => 'MissingRequiredHeader', - 'errorMessage' => 'The HTTP header \'%s\' must be specified.', - ], - [ - 'errorCode' => 'MissingRequiredParams', - 'errorMessage' => 'The HTTP query \'%s\' must be specified.', - ], + ['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => '请求参数错误。具体内容请参考实际错误信息。'], + ['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'], + ['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'], + ['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''], + ['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''], + ['errorCode' => 'EntityTooLarge', 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', 'description' => '请求消息体过大。'], ], 403 => [ - [ - 'errorCode' => 'AccessDenied', - 'errorMessage' => 'The resources doesn\'t belong to you.', - ], + ['errorCode' => 'InvalidAccessKeyID', 'errorMessage' => 'The AccessKey ID %s is invalid.', 'description' => 'AccessKey ID无效。'], + ['errorCode' => 'RequestTimeTooSkewed', 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', 'description' => '您的请求时间不正确，该请求已被识别为无效。请参考通用参数一节。'], + ['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => '您发起请求的签名与我们计算不一致，请检查您的签名算法及AccessKey Secret。'], + ['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''], ], [ - [ - 'errorCode' => 'FlowNotExists', - 'errorMessage' => 'Flow %s does not exist.', - ], - [ - 'errorCode' => 'ScheduleNotExists', - 'errorMessage' => 'The schedule %s for flow %s does not exist.', - ], + ['errorCode' => 'ExecutionNotExists', 'errorMessage' => 'Execution %s for flow %s does not exist.', 'description' => '所请求资源不存在，请确保流程已创建并存在待查询的执行。'], + ['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => '所请求资源不存在，请确保流程已创建。'], + ], + 412 => [ + ['errorCode' => 'PreconditionFailed', 'errorMessage' => 'The resource to be modified has been changed.', 'description' => '资源查看或更新检查失败，该资源可能已被更改。请稍后重试。'], + ], + 415 => [ + ['errorCode' => 'UnsupportedMediaType', 'errorMessage' => 'The content type must be "application/json".', 'description' => '请求消息体类型错误。'], + ], + 429 => [ + ['errorCode' => 'ResourceThrottled', 'errorMessage' => 'The request is throttled. Please try again later.', 'description' => '因某些原因系统流量已达瓶颈。请稍后重试。'], ], 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'An internal error has occurred. Please retry.', - ], + ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => '服务器内部错误。请稍后重试。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新 MapRun 执行配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"Description\\": \\"test description\\",\\n \\"ScheduleId\\": \\"testScheduleId\\",\\n \\"Payload\\": \\"{\\\\\\"key\\\\\\": \\\\\\"value\\\\\\"}\\",\\n \\"ScheduleName\\": \\"my_schedule_name\\",\\n \\"CreatedTime\\": \\"2020-01-01T01:01:01.001Z\\",\\n \\"LastModifiedTime\\": \\"2020-01-01T01:01:01.001Z\\",\\n \\"CronExpression\\": \\"0 * * * * *\\",\\n \\"Enable\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '获取一个定时调度（仅适用于旧版工作流）', - 'summary' => '获取一个定时调度信息。', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3A44E113-9962-5B0B-AB92-14060EFE3164\\",\\n \\"FlowName\\": \\"my_flow_name\\",\\n \\"ExecutionName\\": \\"my_exec_name\\",\\n \\"MapRunName\\": \\"c39142f1345b196d678333c41f113000\\",\\n \\"Concurrency\\": 1,\\n \\"ToleratedFailedCount\\": 100,\\n \\"ToleratedFailedPercentage\\": 20\\n}","type":"json"}]', ], - 'ListSchedules' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateSchedule' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '98864', - 'abilityTreeNodes' => [ - 'FEATUREfnf06LH4G', - ], - 'tenantRelevance' => 'publicInformation', + 'operationType' => 'update', + 'abilityTreeCode' => '98870', + 'abilityTreeNodes' => ['FEATUREfnf06LH4G'], ], 'parameters' => [ [ 'name' => 'FlowName', - 'in' => 'query', - 'schema' => [ - 'description' => '定时调度绑定的流程名称。该名称在同一地域内唯一，创建后不可修改。取值说明如下：'."\n" - ."\n" - .'- 支持英文字符（a~z）或（A~Z）、数字（0~9）、下划线（_）和短划线（-）。'."\n" - .'- 首字母必须为英文字母（a~z）、（A~Z）或下划线（_）。'."\n" - .'- 区分大小写。'."\n" - .'- 长度为1~128个字符。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_flow_name', - ], + 'in' => 'formData', + 'schema' => ['description' => '定时调度绑定的流程名称。该名称在同一地域内唯一，创建后不可修改。取值说明如下：'."\n" + ."\n" + .'- 支持英文字符（a~z）或（A~Z）、数字（0~9）、下划线（_）和短划线（-）。'."\n" + .'- 首字母必须为英文字母（a~z）、（A~Z）或下划线（_）。'."\n" + .'- 区分大小写。'."\n" + .'- 长度为1~128个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_flow_name'], ], [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => '首次查询非必填，**NextToken**是以**FlowName**作为下次查询的Token，无下一页数据时，该字段不返回。', - 'type' => 'string', - 'required' => false, - 'example' => 'testNextToken', - ], + 'name' => 'ScheduleName', + 'in' => 'formData', + 'schema' => ['description' => '定时调度的名称。取值说明如下：'."\n" + ."\n" + .'- 支持英文字符（a~z）或（A~Z）、数字（0~9）、下划线（_）和短划线（-）。'."\n" + .'- 首字母必须为英文字母（a~z）、（A~Z）或下划线（_）。'."\n" + .'- 区分大小写。'."\n" + .'- 长度为1~128个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_schedule_name'], ], [ - 'name' => 'Limit', - 'in' => 'query', - 'schema' => [ - 'description' => '查询数量。取值范围\\[1,1000]。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '1000', - 'minimum' => '1', - 'example' => '1', - 'default' => '60', - ], + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => '定时调度的描述。', 'type' => 'string', 'required' => false, 'example' => 'my test schedule'], + ], + [ + 'name' => 'Payload', + 'in' => 'formData', + 'schema' => ['description' => '定时调度的触发消息，必须为JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{"key": "value"}'], + ], + [ + 'name' => 'CronExpression', + 'in' => 'formData', + 'schema' => ['description' => 'Cron表达式。', 'type' => 'string', 'required' => false, 'example' => '0 * * * * *'], + ], + [ + 'name' => 'Enable', + 'in' => 'formData', + 'schema' => ['description' => '是否启用定时调度。取值说明如下：'."\n" + .'- **true**：启用。'."\n" + .'- **false**：禁用。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ @@ -5584,156 +3319,355 @@ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => '下一次查询的开始Token。', - 'type' => 'string', - 'example' => 'testNextToken', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'testRequestId', - ], - 'Schedules' => [ - 'description' => '定时调度信息。', - 'type' => 'array', - 'items' => [ - 'description' => '定时调度信息。'."\n", - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => '定时调度的描述。', - 'type' => 'string', - 'example' => 'test description', - ], - 'ScheduleId' => [ - 'description' => '定时调度的ID。', - 'type' => 'string', - 'example' => 'testScheduleId', - ], - 'Payload' => [ - 'description' => '定时调度的触发消息。', - 'type' => 'string', - 'example' => '{"key": "value"}', - ], - 'ScheduleName' => [ - 'description' => '定时调度的名称。', - 'type' => 'string', - 'example' => 'my_schedule_name', - ], - 'CreatedTime' => [ - 'description' => '定时调度的创建时间。', - 'type' => 'string', - 'example' => '2020-01-01T01:01:01.001Z', - ], - 'LastModifiedTime' => [ - 'description' => '定时调度最近一次的更改时间。', - 'type' => 'string', - 'example' => '2020-01-01T01:01:01.001Z', - ], - 'CronExpression' => [ - 'description' => 'Cron表达式。', - 'type' => 'string', - 'example' => '0 * * * * *', - ], - 'Enable' => [ - 'description' => '是否启用定时调度。取值说明如下：'."\n" - .'- **true**：启用。'."\n" - .'- **false**：禁用。', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestId'], + 'Description' => ['description' => '定时调度的描述。', 'type' => 'string', 'example' => 'my test schedule'], + 'ScheduleId' => ['description' => '定时调度的ID。', 'type' => 'string', 'example' => 'testScheduleId'], + 'Payload' => ['description' => '定时调度的触发消息。', 'type' => 'string', 'example' => '{"key": "value"}'], + 'ScheduleName' => ['description' => '定时调度的名称。', 'type' => 'string', 'example' => 'my_schedule_name'], + 'CreatedTime' => ['description' => '定时调度的创建时间。', 'type' => 'string', 'example' => '2020-01-01T01:01:01.001Z'], + 'LastModifiedTime' => ['description' => '定时调度最近一次的更新时间。', 'type' => 'string', 'example' => '2020-01-01T01:01:01.001Z'], + 'CronExpression' => ['description' => 'Cron表达式。', 'type' => 'string', 'example' => '0 * * * * *'], + 'Enable' => ['description' => '是否启用定时调度。取值说明如下：'."\n" + .'- **true**：启用。'."\n" + .'- **false**：禁用。', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ActionNotSupported', - 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', + ['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''], + ['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => ''], + ['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => ''], + ['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''], + ], + [ + ['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => ''], + ['errorCode' => 'ScheduleNotExists', 'errorMessage' => 'The schedule %s for flow %s does not exist.', 'description' => ''], + ], + 409 => [ + ['errorCode' => 'ConcurrentUpdateError', 'errorMessage' => 'Update conflict, please retry.', 'description' => ''], + ], + 412 => [ + ['errorCode' => 'PreconditionFailed', 'errorMessage' => 'The resource to be modified has been changed.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"Description\\": \\"my test schedule\\",\\n \\"ScheduleId\\": \\"testScheduleId\\",\\n \\"Payload\\": \\"{\\\\\\"key\\\\\\": \\\\\\"value\\\\\\"}\\",\\n \\"ScheduleName\\": \\"my_schedule_name\\",\\n \\"CreatedTime\\": \\"2020-01-01T01:01:01.001Z\\",\\n \\"LastModifiedTime\\": \\"2020-01-01T01:01:01.001Z\\",\\n \\"CronExpression\\": \\"0 * * * * *\\",\\n \\"Enable\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '更新一个定时调度（仅适用于旧版工作流）', + 'summary' => '更新一个定时调度。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'fnf:UpdateSchedule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], - [ - 'errorCode' => 'APIVersionNotSupported', - 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', + ], + ], + ], + ], + 'endpoints' => [ + ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ap-southeast-1.fnf.aliyuncs.com', 'endpoint' => 'ap-southeast-1.fnf.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cn-beijing.fnf.aliyuncs.com', 'endpoint' => 'cn-beijing.fnf.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cn-hangzhou.fnf.aliyuncs.com', 'endpoint' => 'cn-hangzhou.fnf.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-qingdao', 'regionName' => '华北1（青岛）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cn-qingdao.fnf.aliyuncs.com', 'endpoint' => 'cn-qingdao.fnf.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cn-shanghai.fnf.aliyuncs.com', 'endpoint' => 'cn-shanghai.fnf.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cn-shenzhen.fnf.aliyuncs.com', 'endpoint' => 'cn-shenzhen.fnf.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'us-west-1', 'regionName' => '美国（硅谷）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'us-west-1.fnf.aliyuncs.com', 'endpoint' => 'us-west-1.fnf.aliyuncs.com', 'vpc' => ''], + ], + 'errorCodes' => [ + ['code' => 'AccessDenied', 'message' => 'The resources does not belong to you.', 'http_code' => 403, 'description' => '请求鉴权未通过，具体内容请参考实际错误信息。'], + ['code' => 'ActionNotSupported', 'message' => 'The requested API operation %s is incorrect. Please check.', 'http_code' => 400, 'description' => '所请求方法错误。请参照API文档并检查拼写。'], + ['code' => 'APIVersionNotSupported', 'message' => 'The requested API version %s is not supported yet. Please check.', 'http_code' => 400, 'description' => '所请求接口版本不正确。请参考API简介。'], + ['code' => 'ConcurrentUpdateError', 'message' => 'Update conflict, please retry.', 'http_code' => 409, 'description' => '所请求资源存在并发写操作。请等待一段时间后再次操作。'], + ['code' => 'EntityTooLarge', 'message' => 'The payload size exceeds maximum allowed size (%s bytes).', 'http_code' => 400, 'description' => '请求消息体过大。'], + ['code' => 'ExecutionAlreadyCompleted', 'message' => 'Execution %s for flow %s has already completed.', 'http_code' => 400, 'description' => '该执行已处于中止状态。'], + ['code' => 'ExecutionAlreadyExists', 'message' => 'Execution %s for flow %s already exists.', 'http_code' => 400, 'description' => '对应流程下已存在同名执行。'], + ['code' => 'ExecutionNotExists', 'message' => 'Execution %s for flow %s does not exist.', 'http_code' => 404, 'description' => '所请求资源不存在，请确保流程已创建并存在待查询的执行。'], + ['code' => 'FlowAlreadyExists', 'message' => 'Flow %s already exists.', 'http_code' => 409, 'description' => '已存在同名流程。'], + ['code' => 'FlowNotEmpty', 'message' => 'The flow %s has schedules. Please delete all its schedules before deleting the flow.', 'http_code' => 409, 'description' => '删除工作流之前，请先删除工作流绑定的调度器。'], + ['code' => 'FlowNotExists', 'message' => 'Flow %s does not exist.', 'http_code' => 404, 'description' => '所请求资源不存在，请确保流程已创建。'], + ['code' => 'InternalServerError', 'message' => 'An internal error has occurred. Please retry.', 'http_code' => 500, 'description' => '服务器内部错误。请稍后重试。'], + ['code' => 'InvalidAccessKeyID', 'message' => 'The AccessKey ID %s is invalid.', 'http_code' => 403, 'description' => 'AccessKey ID无效。'], + ['code' => 'InvalidArgument', 'message' => 'Parameter error.', 'http_code' => 400, 'description' => '请求参数错误。具体内容请参考实际错误信息。'], + ['code' => 'MissingRequiredHeader', 'message' => 'The HTTP header \'%s\' must be specified.', 'http_code' => 400, 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'], + ['code' => 'MissingRequiredParams', 'message' => 'The HTTP query \'%s\' must be specified.', 'http_code' => 400, 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'], + ['code' => 'PreconditionFailed', 'message' => 'The resource to be modified has been changed.', 'http_code' => 412, 'description' => '资源查看或更新检查失败，该资源可能已被更改。请稍后重试。'], + ['code' => 'RequestTimeTooSkewed', 'message' => 'The difference between the request time %s and the current time %s is too large.', 'http_code' => 403, 'description' => '您的请求时间不正确，该请求已被识别为无效。请参考通用参数一节。'], + ['code' => 'ResourceThrottled', 'message' => 'The request is throttled. Please try again later.', 'http_code' => 429, 'description' => '因某些原因系统流量已达瓶颈。请稍后重试。'], + ['code' => 'ScheduleAlreadyExists', 'message' => 'The schedule %s already exists in flow %s.', 'http_code' => 409, 'description' => '定时调度已存在。'], + ['code' => 'ScheduleNotExists', 'message' => 'The schedule %s for flow %s does not exist.', 'http_code' => 404, 'description' => '定时调度不存在。'], + ['code' => 'SignatureNotMatch', 'message' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'http_code' => 403, 'description' => '您发起请求的签名与我们计算不一致，请检查您的签名算法及AccessKey Secret。'], + ['code' => 'TaskAlreadyCompleted', 'message' => 'Task %s has already completed.', 'http_code' => 400, 'description' => '指定任务已经完成。'], + ['code' => 'TaskInvalidState', 'message' => 'Task is in an invalid state, please retry.', 'http_code' => 409, 'description' => '任务目前在无效的状态，请稍后重试。'], + ['code' => 'UnsupportedMediaType', 'message' => 'The content type must be "application/json".', 'http_code' => 415, 'description' => '请求消息体类型错误。'], + ], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ], + ], + 'ram' => [ + 'productCode' => 'FnF', + 'productName' => '云工作流', + 'ramCodes' => ['fnf'], + 'ramLevel' => '资源级', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'StartSyncExecution', + 'description' => '同步调用开始一个流程的执行', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'fnf:StartSyncExecution', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidArgument', - 'errorMessage' => 'Parameter error.', + ], + ], + [ + 'apiName' => 'DeleteFlow', + 'description' => '删除一个已存在的流程', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'fnf:DeleteFlow', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], ], - [ - 'errorCode' => 'MissingRequiredHeader', - 'errorMessage' => 'The HTTP header \'%s\' must be specified.', + ], + ], + [ + 'apiName' => 'DescribeExecution', + 'description' => '获取一次执行的状态信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'fnf:DescribeExecution', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], ], - [ - 'errorCode' => 'MissingRequiredParams', - 'errorMessage' => 'The HTTP query \'%s\' must be specified.', + ], + ], + [ + 'apiName' => 'CreateSchedule', + 'description' => '创建一个定时调度（仅适用于旧版工作流）', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'fnf:CreateSchedule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'AccessDenied', - 'errorMessage' => 'The resources doesn\'t belong to you.', + ], + [ + 'apiName' => 'CreateFlow', + 'description' => '创建一个流程', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'fnf:CreateFlow', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => 'Flow', 'arn' => 'acs:fnf:{#regionId}:{#accountId}:flow/*'], ], ], - [ - [ - 'errorCode' => 'FlowNotExists', - 'errorMessage' => 'Flow %s does not exist.', + ], + [ + 'apiName' => 'DescribeSchedule', + 'description' => '获取一个定时调度（仅适用于旧版工作流）', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'fnf:DescribeSchedule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - 412 => [ - [ - 'errorCode' => 'PreconditionFailed', - 'errorMessage' => 'The resource to be modified has been changed.', + ], + [ + 'apiName' => 'UpdateSchedule', + 'description' => '更新一个定时调度（仅适用于旧版工作流）', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'fnf:UpdateSchedule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - 500 => [ - [ - 'errorCode' => 'InternalServerError', - 'errorMessage' => 'An internal error has occurred. Please retry.', + ], + [ + 'apiName' => 'ReportTaskFailed', + 'description' => '汇报指定的任务执行失败', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'fnf:ReportTaskFailed', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'StartExecution', + 'description' => '异步调用开始一个流程的执行', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'fnf:StartExecution', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateFlow', + 'description' => '更新一个已有流程', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'fnf:UpdateFlow', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteSchedule', + 'description' => '删除一个定时调度（仅适用于旧版工作流）', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'fnf:DeleteSchedule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ReportTaskSucceeded', + 'description' => '汇报指定的任务执行成功', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'fnf:ReportTaskSucceeded', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListExecutions', + 'description' => '获取一个流程的历史执行', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'fnf:ListExecutions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetExecutionHistory', + 'description' => '获取一次执行的步骤详情', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'fnf:GetExecutionHistory', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StopExecution', + 'description' => '停止一个正在执行的流程', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'fnf:StopExecution', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListSchedules', + 'description' => '获取定时调度列表（仅适用于旧版工作流）', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'fnf:ListSchedules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeFlow', + 'description' => '获取一个流程的相关信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'fnf:DescribeFlow', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListFlows', + 'description' => '批量查询流程信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'fnf:ListFlows', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'FnF', 'resourceType' => 'Flow', 'arn' => 'acs:fnf:{#regionId}:{#accountId}:flow/*'], + ], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"testNextToken\\",\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"Schedules\\": [\\n {\\n \\"Description\\": \\"test description\\",\\n \\"ScheduleId\\": \\"testScheduleId\\",\\n \\"Payload\\": \\"{\\\\\\"key\\\\\\": \\\\\\"value\\\\\\"}\\",\\n \\"ScheduleName\\": \\"my_schedule_name\\",\\n \\"CreatedTime\\": \\"2020-01-01T01:01:01.001Z\\",\\n \\"LastModifiedTime\\": \\"2020-01-01T01:01:01.001Z\\",\\n \\"CronExpression\\": \\"0 * * * * *\\",\\n \\"Enable\\": true\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '获取定时调度列表（仅适用于旧版工作流）', - 'summary' => '获取定时调度列表。', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'cn-qingdao', - 'endpoint' => 'cn-qingdao.fnf.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'cn-beijing.fnf.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'cn-hangzhou.fnf.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'cn-shanghai.fnf.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'cn-shenzhen.fnf.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'ap-southeast-1.fnf.aliyuncs.com', ], - [ - 'regionId' => 'us-west-1', - 'endpoint' => 'us-west-1.fnf.aliyuncs.com', + 'resourceTypes' => [ + ['validationType' => 'always', 'resourceType' => 'Flow', 'arn' => 'acs:fnf:*:{#accountId}:flow/{#FlowName}'], + ['validationType' => 'always', 'resourceType' => 'Execution', 'arn' => 'acs:fnf:*:{#accountId}:flow/{#FlowName}/execution/{#ExecutionName}'], + ['validationType' => 'always', 'resourceType' => 'Schedule', 'arn' => 'acs:fnf:*:{#accountId}:flow/{#FlowName}/schedule/*'], + ['validationType' => 'always', 'resourceType' => 'Flow', 'arn' => 'acs:fnf:{#regionId}:{#accountId}:flow/*'], + ['validationType' => 'always', 'resourceType' => 'Schedule', 'arn' => 'acs:fnf:*:{#accountId}:flow/{#FlowName}/schedule/{#ScheduleName}'], + ['validationType' => 'always', 'resourceType' => 'Execution', 'arn' => 'acs:fnf:*:{#accountId}:flow/{#FlowName}/execution/*'], ], ], ]; |