diff options
Diffstat (limited to 'data/en_us/fnf')
| -rw-r--r-- | data/en_us/fnf/2019-03-15/api-docs.php | 5566 |
1 files changed, 5566 insertions, 0 deletions
diff --git a/data/en_us/fnf/2019-03-15/api-docs.php b/data/en_us/fnf/2019-03-15/api-docs.php new file mode 100644 index 0000000..2768903 --- /dev/null +++ b/data/en_us/fnf/2019-03-15/api-docs.php @@ -0,0 +1,5566 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'fnf', + 'version' => '2019-03-15', + ], + 'directories' => [ + [ + 'id' => 308092, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeRegions', + ], + ], + [ + 'id' => 308094, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateFlow', + 'DeleteFlow', + 'UpdateFlow', + 'DescribeFlow', + 'ListFlows', + [ + 'id' => 308100, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'PublishFlowVersion', + 'ListFlowVersions', + 'DeleteFlowVersion', + ], + ], + [ + 'id' => 308104, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListFlowAliases', + 'CreateFlowAlias', + 'DescribeFlowAlias', + 'UpdateFlowAlias', + 'DeleteFlowAlias', + ], + ], + ], + ], + [ + 'id' => 308110, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'StartExecution', + 'StopExecution', + 'DescribeExecution', + 'ListExecutions', + 'GetExecutionHistory', + 'StartSyncExecution', + 'DescribeMapRun', + 'UpdateMapRun', + ], + ], + [ + 'id' => 308119, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ReportTaskFailed', + 'ReportTaskSucceeded', + ], + ], + [ + 'id' => 308122, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateSchedule', + 'DeleteSchedule', + 'UpdateSchedule', + 'DescribeSchedule', + 'ListSchedules', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'DescribeRegions' => [ + 'summary' => 'Queries the regions where CloudFlow is available.', + '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。', + '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' => '', + 'type' => 'string', + 'example' => '0aa3f793-6e5f-8472-c7a2-70d2b84c04ac', + ], + 'Regions' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-qingdao', + ], + 'RegionEndpoint' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-qingdao.fnf.aliyuncs.com', + ], + 'LocalName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => 'DescribeRegions', + ], + 'CreateFlow' => [ + 'summary' => 'Creates a flow.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '98854', + 'abilityTreeNodes' => [ + 'FEATUREfnf8CPMA5', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the flow. The name is unique within the same region and cannot be modified after the flow is created. Set this parameter based on the following rules:'."\n" + ."\n" + .'* The name can contain letters, digits, underscores (\\_), and hyphens (-).'."\n" + .'* The name must start with a letter or an underscore (\\_).'."\n" + .'* The name is case-sensitive.'."\n" + .'* The name must be 1 to 128 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'flow', + ], + ], + [ + 'name' => 'Definition', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The definition of the workflow. The definition must comply with the flow definition language (FDL) syntax. Considering compatibility, the system supports two flow definition specifications.'."\n" + ."\n" + .'> In the preceding flow definition example, Name:my_flow_name is the workflow name, which must be consistent with the input parameter Name'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'version: v1.0<br/>type: flow<br/>steps:<br/> - type: pass<br/> name: mypass', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The description of the flow.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test flow', + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The type of the flow. Set this parameter to **FDL**.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'FDL' => '', + ], + 'example' => 'FDL', + ], + ], + [ + 'name' => 'RoleArn', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The Alibaba Cloud resource name (ARN) of the authorized role on which the execution of the flow relies. During the execution of the flow, CloudFlow assumes the role to call API operations of relevant services.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'acs:ram:${region}:${accountID}:${role}', + ], + ], + [ + 'name' => 'ExternalStorageLocation', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The path of the external storage.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/path', + ], + ], + [ + 'name' => 'ExecutionMode', + 'in' => 'formData', + 'schema' => [ + 'title' => '执行模式，枚举类型，可以是Express和Standard，空串等价于Standard', + 'description' => 'The execution mode. Valid values: Express and Standard. Considering compatibility, an empty string is equivalent to the Standard execution mode.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Express' => '', + 'Standard' => '', + ], + 'example' => 'Standard', + ], + ], + [ + 'name' => 'Environment', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '配置 Flow 执行期间可以访问的变量列表', + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'title' => '配置 Flow 执行期间可以访问的变量列表', + 'type' => 'array', + 'items' => [ + 'title' => '配置 Flow 执行期间可以访问的变量列表', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '变量名称', + 'type' => 'string', + 'example' => 'key', + ], + 'Value' => [ + 'title' => '变量值', + 'type' => 'string', + 'example' => 'value', + ], + 'Description' => [ + 'title' => '变量描述', + 'type' => 'string', + 'example' => 'description', + ], + ], + ], + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The schema of response.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the flow.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'* FDL'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'FDL' => '', + ], + 'example' => 'FDL', + ], + 'Definition' => [ + 'description' => 'Considering compatibility, the system supports two flow definition specifications.'."\n", + 'type' => 'string', + 'example' => 'version: v1.0\\ntype: flow\\nname: test\\nsteps:\\n - type: pass\\n name: mypass', + ], + 'RoleArn' => [ + 'description' => 'The Alibaba Cloud resource name (ARN) of the authorized role on which the execution of the flow relies. During the execution of the flow, CloudFlow assumes the role to call API operations of relevant services.'."\n", + 'type' => 'string', + 'example' => 'acs:ram:${region}:${accountID}:${role}', + ], + 'RequestId' => [ + 'description' => 'The request ID. Each time an `HTTP status code` is returned, Serverless Workflow returns a value for the parameter.'."\n", + 'type' => 'string', + 'example' => 'testRequestID', + ], + 'Description' => [ + 'description' => 'The description of the flow.'."\n", + 'type' => 'string', + 'example' => 'test flow', + ], + 'Name' => [ + 'description' => 'The name of the flow.'."\n", + 'type' => 'string', + 'example' => 'flow', + ], + 'CreatedTime' => [ + 'description' => 'The time when the flow was created.'."\n", + 'type' => 'string', + 'example' => '2019-01-01T01:01:01.001Z', + ], + 'LastModifiedTime' => [ + 'description' => 'The time when the flow was last modified.'."\n", + 'type' => 'string', + 'example' => '2019-01-01T01:01:01.001Z', + ], + 'Id' => [ + 'description' => 'The unique ID of the flow.'."\n", + 'type' => 'string', + 'example' => 'e589e092-e2c0-4dee-b306-3574ddfdddf5****', + ], + 'ExecutionMode' => [ + 'title' => '执行模式，枚举类型，可以是Express和Standard，空串等价于Standard', + 'description' => 'The execution mode. Valid values: Express and Standard. Considering compatibility, an empty string is equivalent to the Standard execution mode.'."\n", + 'type' => 'string', + 'example' => 'Standard', + ], + 'Environment' => [ + 'title' => 'Flow 执行期间可以访问的变量列表', + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'title' => 'Flow 执行期间可以访问的变量列表', + 'type' => 'array', + 'items' => [ + 'title' => 'Flow 执行期间可以访问的变量列表', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '变量名称', + 'type' => 'string', + 'example' => 'key', + ], + 'Value' => [ + 'title' => '变量值', + 'type' => 'string', + 'example' => 'value', + ], + 'Description' => [ + 'title' => '变量描述', + 'type' => 'string', + 'example' => 'description', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + 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.', + ], + ], + 409 => [ + [ + 'errorCode' => 'FlowAlreadyExists', + 'errorMessage' => 'Flow %s already exists.', + ], + ], + 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 \\"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":""}]', + 'title' => 'CreateFlow', + 'description' => '## [](#)Usage notes'."\n" + ."\n" + .'* The number of flows that each user can create is restricted by resources. For more information, see [Limits](~~122093~~). If you want to create more flows, submit a ticket.'."\n" + .'* At the user level, flows are distinguished by name. The name of a flow within one account must be unique.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteFlow' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '98856', + 'abilityTreeNodes' => [ + 'FEATUREfnf8CPMA5', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the workflow that you want to delete.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'flow', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + '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' => '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' => 'DeleteFlow', + 'summary' => 'Deletes an existing flow.', + 'description' => '## [](#)Usage notes'."\n" + ."\n" + .'A delete operation is asynchronous. If this operation is successful, the system returns a successful response. If an existing flow is pending to be deleted, a new flow of the same name will not be affected by the existing one. After you delete a flow, you cannot query its historical executions. All executions in progress will stop after their most recent steps are complete.'."\n", + ], + 'UpdateFlow' => [ + 'summary' => 'Updates a flow.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '98869', + 'abilityTreeNodes' => [ + 'FEATUREfnf8CPMA5', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the workflow.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'flow', + ], + ], + [ + 'name' => 'Definition', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The definition of the workflow. The definition must comply with the flow definition language (FDL) syntax. Considering compatibility, the system supports the two workflow definition specifications.'."\n" + ."\n" + .'> In the preceding workflow definition example, Name:my_flow_name is the workflow name, which must be consistent with the input parameter Name'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'version: v1.0\\ntype: flow\\nname: test\\nsteps:\\n - type: pass\\n name: mypass', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The description of the flow.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test definition', + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The type of the flow. Valid value: **FDL**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'FDL', + ], + ], + [ + 'name' => 'RoleArn', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The Alibaba Cloud resource name (ARN) of the authorized role on which the execution of the flow relies. During the execution of the flow, the flow execution engine assumes the role to call API operations of relevant services.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'acs:ram::${accountID}:${role}', + ], + ], + [ + 'name' => 'Environment', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '配置 Flow 执行期间可以访问的变量列表', + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'title' => '配置 Flow 执行期间可以访问的变量列表', + 'type' => 'array', + 'items' => [ + 'title' => '配置 Flow 执行期间可以访问的变量列表', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '变量名称', + 'type' => 'string', + 'example' => 'key', + ], + 'Value' => [ + 'title' => '变量值', + 'type' => 'string', + 'example' => 'value', + ], + 'Description' => [ + 'title' => '变量描述', + 'type' => 'string', + 'example' => 'description', + ], + ], + ], + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The schema of response.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the flow.'."\n", + 'type' => 'string', + 'example' => 'FDL', + ], + 'Definition' => [ + 'description' => 'The flow definition, which follows the FDL syntax standard. Considering compatibility, the system supports the two flow definition specifications.'."\n", + 'type' => 'string', + 'example' => 'version: v1.0\\ntype: flow\\nname: test\\nsteps:\\n - type: pass\\n name: mypass', + ], + 'RoleArn' => [ + 'description' => 'The Alibaba Cloud resource name (ARN) of the authorized role on which the execution of the flow relies. During the execution of the flow, the flow execution engine assumes the role to call API operations of relevant services.'."\n", + 'type' => 'string', + 'example' => 'acs:ram::${accountID}:${role}', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'testRequestID', + ], + 'Description' => [ + 'description' => 'The description of the flow.'."\n", + 'type' => 'string', + 'example' => 'test definition', + ], + 'ExternalStorageLocation' => [ + 'description' => 'The path of the external storage.'."\n", + 'type' => 'string', + 'example' => '/path', + ], + 'Name' => [ + 'description' => 'The name of the flow.'."\n", + 'type' => 'string', + 'example' => 'flow', + ], + 'CreatedTime' => [ + 'description' => 'The time when the flow was created.'."\n", + 'type' => 'string', + 'example' => '2019-01-01T01:01:01.001Z', + ], + 'LastModifiedTime' => [ + 'description' => 'The time when the flow was last modified.'."\n", + 'type' => 'string', + 'example' => '2019-01-01T01:01:01.001Z', + ], + 'Id' => [ + 'description' => 'The unique ID of the flow.'."\n", + 'type' => 'string', + 'example' => 'e589e092-e2c0-4dee-b306-3574ddfdddf5****', + ], + 'Environment' => [ + 'title' => 'Flow 执行期间可以访问的变量列表', + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'title' => 'Flow 执行期间可以访问的变量列表', + 'type' => 'array', + 'items' => [ + 'title' => 'Flow 执行期间可以访问的变量列表', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '变量名称', + 'type' => 'string', + 'example' => 'key', + ], + 'Value' => [ + 'title' => '变量值', + 'type' => 'string', + 'example' => 'value', + ], + 'Description' => [ + 'title' => '变量描述', + 'type' => 'string', + 'example' => 'description', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + [ + [ + '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".', + ], + ], + 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 \\"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' => 'UpdateFlow', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeFlow' => [ + 'summary' => 'Queries the information about a flow.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '98859', + 'abilityTreeNodes' => [ + 'FEATUREfnf8CPMA5', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the flow.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'flow', + ], + ], + [ + 'name' => 'FlowVersion', + 'in' => 'query', + 'schema' => [ + 'title' => '版本', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of response.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the workflow.'."\n", + 'type' => 'string', + 'example' => 'FDL', + ], + 'Definition' => [ + 'description' => 'The definition of the workflow. The definition must comply with the flow definition language (FDL) syntax. Considering compatibility, the system supports the flow definition specifications of the old version and new version.'."\n", + 'type' => 'string', + 'example' => 'version: v1.0\\ntype: flow\\nname: test\\nsteps:\\n - type: pass\\n name: mypass', + ], + 'RoleArn' => [ + 'description' => 'The Alibaba Cloud resource name (ARN) of the authorized role on which the execution of the flow relies. During the execution of the flow, CloudFlow assumes the role to call API operations of relevant services.'."\n", + 'type' => 'string', + 'example' => 'acs:ram::${accountID}:${role}', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'testRequestId', + ], + 'Description' => [ + 'description' => 'The description of the flow.'."\n", + 'type' => 'string', + 'example' => 'test flow', + ], + 'Name' => [ + 'description' => 'The name of the flow.'."\n", + 'type' => 'string', + 'example' => 'flow', + ], + 'CreatedTime' => [ + 'description' => 'The time when the flow was created.'."\n", + 'type' => 'string', + 'example' => '2019-01-01T01:01:01.001Z', + ], + 'LastModifiedTime' => [ + 'description' => 'The time when the flow was last modified.'."\n", + 'type' => 'string', + 'example' => '2019-01-01T01:01:01.001Z', + ], + 'Id' => [ + 'description' => 'The unique ID of the flow.'."\n", + 'type' => 'string', + 'example' => 'e589e092-e2c0-4dee-b306-3574ddfdddf5****', + ], + 'ExecutionMode' => [ + 'title' => '执行模式，枚举类型，可以是Express和Standard，空串等价于Standard', + 'description' => 'The execution mode or the enumeration type. Valid values: Express and Standard. A value of Standard indicates an empty string.'."\n", + 'type' => 'string', + 'example' => 'Standard', + ], + 'Environment' => [ + 'title' => 'Flow 执行期间可以访问的变量列表', + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'title' => 'Flow 执行期间可以访问的变量列表', + 'type' => 'array', + 'items' => [ + 'title' => 'Flow 执行期间可以访问的变量列表', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '变量名称', + 'type' => 'string', + 'example' => 'key', + ], + 'Value' => [ + 'title' => '变量值', + 'type' => 'string', + 'example' => 'value', + ], + 'Description' => [ + 'title' => '变量描述', + 'type' => 'string', + 'example' => 'description', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + 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.', + ], + ], + 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.', + ], + ], + ], + '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' => 'DescribeFlow', + ], + 'ListFlows' => [ + 'summary' => 'Queries a list of flows.', + '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' => 'The token to start the query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'flow_nextxxx', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of workflows that you want to query. Valid values: 1 - 999. Default value: 60.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The details of flows.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The start key for the next query. This parameter is not returned if all results have been returned.'."\n", + 'type' => 'string', + 'example' => 'flow_nextxxx', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'testRequestId', + ], + 'Flows' => [ + 'description' => 'The details of flows.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the flow.'."\n", + 'type' => 'string', + 'example' => 'FDL', + ], + 'Definition' => [ + 'description' => 'The definition of the flow. The definition must comply with the Flow Definition Language (FDL) syntax.'."\n", + 'type' => 'string', + 'example' => 'version: v1.0\\ntype: flow\\nname: test\\nsteps:\\n - type: pass\\n name: mypass', + ], + 'RoleArn' => [ + 'description' => 'The Alibaba Cloud resource name (ARN) of the specified Resource Access Management (RAM) role that Serverless Workflow assumes to invoke resources when the flow is executed.'."\n", + 'type' => 'string', + 'example' => 'acs:ram::${accountID}:${role}', + ], + 'Description' => [ + 'description' => 'The description of the flow.'."\n", + 'type' => 'string', + 'example' => 'test flow', + ], + 'Name' => [ + 'description' => 'The name of the flow.'."\n", + 'type' => 'string', + 'example' => 'flow', + ], + 'CreatedTime' => [ + 'description' => 'The time when the flow was created.'."\n", + 'type' => 'string', + 'example' => '2019-01-01T01:01:01.001Z', + ], + 'LastModifiedTime' => [ + 'description' => 'The time when the flow was last modified.'."\n", + 'type' => 'string', + 'example' => '2019-01-01T01:01:01.001Z', + ], + 'Id' => [ + 'description' => 'The unique ID of the flow.'."\n", + 'type' => 'string', + 'example' => 'e589e092-e2c0-4dee-b306-3574ddf5****', + ], + 'ExecutionMode' => [ + 'title' => '执行模式，枚举类型，可以是Express和Standard，空串等价于Standard', + 'description' => 'The execution mode or the enumeration type. Valid values: Express and Standard. A value of Standard indicates an empty string.'."\n", + 'type' => 'string', + 'example' => 'Standard', + ], + 'Environment' => [ + 'title' => 'Flow 执行期间可以访问的变量列表', + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'title' => 'Flow 执行期间可以访问的变量列表', + 'type' => 'array', + 'items' => [ + 'title' => 'Flow 执行期间可以访问的变量列表', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'title' => '变量描述', + 'type' => 'string', + 'example' => 'description', + ], + 'Name' => [ + 'title' => '变量名称', + 'type' => 'string', + 'example' => 'key', + ], + 'Value' => [ + 'title' => '变量值', + 'type' => 'string', + 'example' => 'value', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => 'ListFlows', + ], + 'PublishFlowVersion' => [ + 'summary' => '发布流程版本', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + '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' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '版本描述', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'example flow 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' => '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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"}]', + ], + 'ListFlowVersions' => [ + 'summary' => '查询流程版本列表', + 'path' => '', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + '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', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'list token', + 'description' => 'list token', + 'type' => 'string', + 'required' => false, + 'example' => 'token', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'title' => '返回的最大结果数量', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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"}]', + ], + 'DeleteFlowVersion' => [ + 'summary' => '删除流程版本', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREfnf8CPMA5', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'FlowName', + 'in' => 'formData', + 'schema' => [ + 'title' => '流程名称', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'example-flow', + ], + ], + [ + 'name' => 'FlowVersion', + 'in' => 'formData', + 'schema' => [ + 'title' => '流程版本', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3A44E113-9962-5B0B-AB92-14060EFE3164\\"\\n}","type":"json"}]', + ], + 'ListFlowAliases' => [ + 'summary' => '查询流程版本别名列表', + 'path' => '', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + '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', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'list token', + 'description' => 'list token', + 'type' => 'string', + 'required' => false, + 'example' => 'token', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'title' => '最大返回的结果数量', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + 'CreatedTime' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'string', + 'example' => '2025-10-24T14:11:26+08:00', + ], + ], + ], + ], + ], + ], + ], + ], + '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"}]', + ], + 'CreateFlowAlias' => [ + 'summary' => '创建流程版本别名', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + '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' => [ + '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, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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"}]', + ], + 'DescribeFlowAlias' => [ + 'summary' => '查询流程版本别名详情', + 'path' => '', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + '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', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '别名', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'example-alias-name', + ], + ], + ], + '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' => 'alias-name', + ], + 'Description' => [ + 'title' => '别名描述', + 'description' => '', + 'type' => 'string', + 'example' => 'alias description', + ], + 'RoutingConfigurations' => [ + 'title' => '权重配置', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Version' => [ + 'title' => '版本', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Weight' => [ + 'title' => '权重', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + 'CreatedTime' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'string', + 'example' => '2024-04-22T06:09:39.907Z', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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"}]', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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"}]', + ], + 'DeleteFlowAlias' => [ + 'summary' => '删除流程别名', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREfnf8CPMA5', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'FlowName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'my_flow_name', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'alias_name', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3A44E113-9962-5B0B-AB92-14060EFE3164\\"\\n}","type":"json"}]', + ], + 'StartExecution' => [ + 'summary' => 'Starts the execution of a workflow.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '98867', + 'abilityTreeNodes' => [ + 'FEATUREfnf8CPMA5', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'FlowName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the workflow to be executed.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'flow', + ], + ], + [ + 'name' => 'ExecutionName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the execution. The execution name is unique within a workflow. Configure this parameter based on the following rules:'."\n" + ."\n" + .'* The name must start with a letter or an underscore (\\_).'."\n" + .'* The name can contain letters, digits, underscores (\\_), and hyphens (-).'."\n" + .'* The name is case-sensitive.'."\n" + .'* The name must be 1 to 128 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'exec', + ], + ], + [ + 'name' => 'Input', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The input of the execution, which is in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"key":"value"}', + ], + ], + [ + 'name' => 'CallbackFnFTaskToken', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Specifies that the **TaskToken**-related tasks are called back after the execution in the flow ends.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '12', + ], + ], + [ + 'name' => 'Qualifier', + 'in' => 'formData', + 'schema' => [ + 'title' => '指定流程版本或别名', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The execution status. Valid values:'."\n" + ."\n" + .'* **Starting**'."\n" + .'* **Running**'."\n" + .'* **Stopped**'."\n" + .'* **Succeeded**'."\n" + .'* **Failed**'."\n" + .'* **TimedOut**'."\n", + 'type' => 'string', + 'example' => 'Succeeded', + ], + 'StoppedTime' => [ + 'description' => 'The time when the execution stopped.'."\n", + 'type' => 'string', + 'example' => '2019-01-01T01:01:01.001Z', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'testRequestId', + ], + 'StartedTime' => [ + 'description' => 'The time when the execution started.'."\n", + 'type' => 'string', + 'example' => '2019-01-01T01:01:01.001Z', + ], + 'FlowDefinition' => [ + 'description' => 'The definition of the flow.'."\n", + 'type' => 'string', + 'example' => 'version: v1.0\\ntype: flow\\nname: test\\nsteps:\\n - type: pass\\n name: mypass', + ], + 'Output' => [ + 'description' => 'The execution result, which is in the JSON format.'."\n", + 'type' => 'string', + 'example' => '{"key":"value"}', + ], + 'FlowName' => [ + 'description' => 'The name of the workflow.'."\n", + 'type' => 'string', + 'example' => 'flow', + ], + 'Name' => [ + 'description' => 'The name of the execution.'."\n", + 'type' => 'string', + 'example' => 'exec1', + ], + 'Input' => [ + 'description' => 'The input of the execution, which is in the JSON format.'."\n", + 'type' => 'string', + 'example' => '{"key":"value"}', + ], + ], + ], + ], + ], + '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.', + ], + ], + 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.', + ], + ], + ], + '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' => 'StartExecution', + 'description' => '## [](#)Usage notes'."\n" + ."\n" + .'* The flow is created. A flow only in standard mode is supported.'."\n" + .'* If you do not specify an execution, the system automatically generates an execution and starts the execution.'."\n" + .'* If an ongoing execution has the same name as that of the execution to be started, the system directly returns the ongoing execution.'."\n" + .'* If the ongoing execution with the same name has ended (succeeded or failed), `ExecutionAlreadyExists` is returned.'."\n" + .'* If no execution with the same name exists, the system starts a new execution.'."\n", + ], + 'StopExecution' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '98868', + 'abilityTreeNodes' => [ + 'FEATUREfnf8CPMA5', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'FlowName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the workflow to be stopped. You can call the **ListFlows** operation to obtain the value of this parameter.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'flow', + ], + ], + [ + 'name' => 'ExecutionName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the execution to be stopped. You can call the **ListExecutions** operation to obtain the value of this parameter.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'exec', + ], + ], + [ + 'name' => 'Cause', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The reason for stopping the execution. The value must be 1 to 4,096 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'for test', + ], + ], + [ + 'name' => 'Error', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The error code for stopping the execution. The error code must be 1 to 128 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'nill', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of response.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The execution status. Valid values:'."\n" + ."\n" + .'* **Starting**'."\n" + .'* **Running**'."\n" + .'* **Stopped**'."\n" + .'* **Succeeded**'."\n" + .'* **Failed**'."\n" + .'* **TimedOut**'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + 'StoppedTime' => [ + 'description' => 'The time when the execution stopped.'."\n", + 'type' => 'string', + 'example' => '2019-01-01T01:01:01.001Z', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'testRequestId', + ], + 'StartedTime' => [ + 'description' => 'The time when the execution started.'."\n", + 'type' => 'string', + 'example' => '2019-01-01T01:01:01.001Z', + ], + 'FlowDefinition' => [ + 'description' => 'The definition of the flow.'."\n", + 'type' => 'string', + 'example' => 'version: v1.0\\ntype: flow\\nname: test\\nsteps:\\n - type: pass\\n name: mypass', + ], + 'Output' => [ + 'description' => 'The execution result, which is in the JSON format.'."\n", + 'type' => 'string', + 'example' => '{"key":"value"}', + ], + 'FlowName' => [ + 'description' => 'The name of the flow.'."\n", + 'type' => 'string', + 'example' => 'flow', + ], + 'Name' => [ + 'description' => 'The name of the execution.'."\n", + 'type' => 'string', + 'example' => 'exec', + ], + 'Input' => [ + 'description' => 'The input of the execution, which is in the JSON format.'."\n", + 'type' => 'string', + 'example' => '{"key":"value"}', + ], + 'RoleArn' => [ + 'description' => 'The Alibaba Cloud resource name (ARN) of the role that executed the flow. If the RoleArn in the flow definition is changed during the execution of the flow, the system records and returns a snapshot of the original RoleArn.'."\n" + ."\n" + .'> If you do not specify the RoleArn parameter in the request parameters, the response parameters do not contain the RoleArn parameter.'."\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' => '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.', + ], + ], + 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' => '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.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalServerError', + 'errorMessage' => 'An internal error has occurred. Please retry.', + ], + ], + ], + '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' => 'StopExecution', + 'summary' => 'Stops an execution that is in progress in a flow.', + 'description' => '## [](#)Usage notes'."\n" + ."\n" + .'The flow must be in progress.'."\n", + ], + 'DescribeExecution' => [ + 'summary' => 'Queries an execution in a flow. The long polling mode is supported. The maximum waiting period for long polling depends on the value of the WaitTimeSeconds parameter.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '98858', + 'abilityTreeNodes' => [ + 'FEATUREfnf8CPMA5', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'FlowName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the workflow.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'flow', + ], + ], + [ + 'name' => 'ExecutionName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the execution.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'exec', + ], + ], + [ + 'name' => 'WaitTimeSeconds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum period of time for long polling waits. Valid values: 0 to 60. Unit: seconds. Configure this parameter based on the following rules:'."\n" + ."\n" + .'* If the value is 0, the system immediately returns the current execution status.'."\n" + .'* If the value is greater than 0, the long polling request waits until the execution ends or the specified period elapses.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The execution status. Valid values:'."\n" + ."\n" + .'* **Starting**'."\n" + .'* **Running**'."\n" + .'* **Stopped**'."\n" + .'* **Succeeded**'."\n" + .'* **Failed**'."\n" + .'* **TimedOut**'."\n", + 'type' => 'string', + 'example' => 'Succeeded', + ], + 'StoppedTime' => [ + 'description' => 'The time when the execution stopped.'."\n", + 'type' => 'string', + 'example' => '2019-01-01T01:01:01.001Z', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'testRequestId', + ], + 'StartedTime' => [ + 'description' => 'The time when the execution started.'."\n", + 'type' => 'string', + 'example' => '2019-01-01T01:01:01.001Z', + ], + 'FlowDefinition' => [ + 'description' => 'The definition of the flow.'."\n", + 'type' => 'string', + 'example' => 'version: v1.0\\ntype: flow\\nname: test\\nsteps:\\n - type: pass\\n name: mypass', + ], + 'Output' => [ + 'description' => 'The execution result, which is in the JSON format.'."\n", + 'type' => 'string', + 'example' => '{"key":"value"}', + ], + 'FlowName' => [ + 'description' => 'The name of the flow.'."\n", + 'type' => 'string', + 'example' => 'flow', + ], + 'Name' => [ + 'description' => 'The name of the execution.'."\n", + 'type' => 'string', + 'example' => 'exec', + ], + 'Input' => [ + 'description' => 'The input of the execution, which is in the JSON format.'."\n", + 'type' => 'string', + 'example' => '{"key":"value"}', + ], + 'Environment' => [ + 'title' => 'Flow 执行时使用的环境变量列表', + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'title' => 'Flow 执行时使用的环境变量列表', + 'type' => 'array', + 'items' => [ + 'title' => 'Flow 执行期间可以访问的变量列表', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '变量名称', + 'type' => 'string', + 'example' => 'key', + ], + 'Value' => [ + 'title' => '变量值', + 'type' => 'string', + 'example' => 'value', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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' => 'DescribeExecution', + ], + 'ListExecutions' => [ + 'summary' => 'Queries all historical executions of a flow.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '98862', + 'abilityTreeNodes' => [ + 'FEATUREfnf8CPMA5', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'FlowName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the flow. The name must be unique within the region and cannot be modified after the flow is created. The name must meet the following conventions:'."\n" + ."\n" + .'* The name can contain letters, digits, underscores (\\_), and hyphens (-).'."\n" + .'* The name must start with a letter or an underscore (\\_).'."\n" + .'* The name is case-sensitive.'."\n" + .'* The name must be 1 to 128 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'flow', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the execution to start the query. You can obtain the value from the response data. You do not need to specify this parameter for the first request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'flow_xxx', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of executions that you want to query. Valid values: 1-99. Default value: 60.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the execution that you want to filter. Valid values:'."\n" + ."\n" + .'* **Starting**'."\n" + .'* **Running**'."\n" + .'* **Stopped**'."\n" + .'* **Succeeded**'."\n" + .'* **Failed**'."\n" + .'* **TimedOut**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Succeeded', + ], + ], + [ + 'name' => 'StartedTimeBegin', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query executions. Specify the value in the UTC RFC3339 format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2020-12-02T02:39:20.402Z', + ], + ], + [ + 'name' => 'StartedTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query executions. Specify the value in the UTC RFC3339 format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2020-12-02T02:23:54.817Z', + ], + ], + [ + 'name' => 'ExecutionNamePrefix', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name prefix of the execution.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'run', + ], + ], + [ + 'name' => 'MetadataOnly', + 'in' => 'query', + 'schema' => [ + 'title' => '是否只返回执行的元数据。为true时，返回值中不包括Flow定义、Input和Output，为false时会返回全部数据', + 'type' => 'boolean', + ], + ], + [ + 'name' => 'Qualifier', + 'in' => 'query', + 'schema' => [ + 'title' => '指定流程的版本或别名', + 'type' => 'string', + 'example' => '1', + ], + ], + [ + 'name' => 'MapRunName', + 'in' => 'query', + 'schema' => [ + 'title' => 'MapRun 名称', + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The start key for the next query. This parameter is not returned if this is the last query.'."\n" + ."\n" + .'> This parameter may not be displayed in the response because no next page exists.'."\n", + 'type' => 'string', + 'example' => 'exec2', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'testRequestId', + ], + 'Executions' => [ + 'description' => 'The information about executions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the execution.'."\n", + 'type' => 'string', + 'example' => 'Succeeded', + ], + 'StoppedTime' => [ + 'description' => 'The time when the execution stopped.'."\n", + 'type' => 'string', + 'example' => '2019-01-01T01:01:01.001Z', + ], + 'StartedTime' => [ + 'description' => 'The time when the execution started.'."\n", + 'type' => 'string', + 'example' => '2019-01-01T01:01:01.001Z', + ], + 'FlowDefinition' => [ + 'description' => 'The definition of the flow.'."\n", + 'type' => 'string', + 'example' => 'version: v1.0\\ntype: flow\\nname: test\\nsteps:\\n - type: pass\\n name: mypass', + ], + 'Output' => [ + 'description' => 'The output of the execution, which is in the JSON format'."\n", + 'type' => 'string', + 'example' => '{"key":"value"}', + ], + 'FlowName' => [ + 'description' => 'The name of the flow.'."\n", + 'type' => 'string', + 'example' => 'flow', + ], + 'Name' => [ + 'description' => 'The name of the execution.'."\n", + 'type' => 'string', + 'example' => 'exec', + ], + 'Input' => [ + 'description' => 'The input of the execution, which is in the JSON format.'."\n", + 'type' => 'string', + 'example' => '{"key":"value"}', + ], + 'Environment' => [ + 'title' => 'Flow 执行时使用的环境变量列表', + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'title' => 'Flow 执行时使用的环境变量列表', + 'type' => 'array', + 'items' => [ + 'title' => 'Flow 执行期间可以访问的变量列表', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '变量名称', + 'type' => 'string', + 'example' => 'key', + ], + 'Value' => [ + 'title' => '变量值', + 'type' => 'string', + 'example' => 'value', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + 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.', + ], + ], + 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.', + ], + ], + ], + '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":""}]', + 'title' => 'ListExecutions', + 'description' => '## [](#)Usage notes'."\n" + ."\n" + .'After you delete a flow, you cannot query its historical executions, even if you create a flow of the same name.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetExecutionHistory' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '98861', + 'abilityTreeNodes' => [ + 'FEATUREfnf8CPMA5', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'FlowName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the workflow.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'flow', + ], + ], + [ + 'name' => 'ExecutionName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the execution.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'exec', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the event to start the query. You can obtain the value from the response data.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'flow_xxx', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of workflows that you want to query. Valid values: 1-999. Default value: 60.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'You do not need to specify this parameter for the first request. The returned value of **ScheduleEventId** is used as the token for the next query. No value is returned for the last query.'."\n", + 'type' => 'string', + 'example' => '3', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'testRequestId', + ], + 'Events' => [ + 'description' => 'The events.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the execution step. Valid values:'."\n" + ."\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**'."\n", + 'type' => 'string', + 'example' => 'TaskSucceeded', + ], + 'EventId' => [ + 'description' => 'The ID of the execution step.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Time' => [ + 'description' => 'The time when the event was updated.'."\n", + 'type' => 'string', + 'example' => '2019-01-01T01:01:01.001Z', + ], + 'ScheduleEventId' => [ + 'description' => 'The ID of the scheduling step.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'EventDetail' => [ + 'description' => 'The details about the execution step.'."\n", + 'type' => 'string', + 'example' => '{}', + ], + 'StepName' => [ + 'description' => 'The name of the execution step.'."\n", + 'type' => 'string', + 'example' => 'passStep', + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + 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' => 'ExecutionNotExists', + 'errorMessage' => 'Execution %s for flow %s does not exist.', + ], + [ + 'errorCode' => 'FlowNotExists', + 'errorMessage' => 'Flow %s does not exist.', + ], + ], + 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 \\"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' => 'GetExecutionHistory', + 'summary' => 'Queries the details about each step in an execution process.', + ], + 'StartSyncExecution' => [ + 'summary' => 'Synchronously starts an execution in a flow.', + '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' => 'The name of the workflow to be executed.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_flow_name', + ], + ], + [ + 'name' => 'ExecutionName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the execution that you want to start. The name must meet the following conventions:'."\n" + ."\n" + .'* The name can contain letters, digits, underscores (\\_), and hyphens (-).'."\n" + .'* The name must start with a letter or an underscore (\\_).'."\n" + .'* The name is case-sensitive.'."\n" + .'* The name must be 1 to 128 characters in length.'."\n" + ."\n" + .'Different from the StartExecution operation, in the synchronous execution mode, the execution name is no longer required to be unique within a flow. You can choose to provide an execution name to identify the current execution. In this case, the system adds a UUID to the current execution name. The used format is {ExecutionName}:{UUID}. If you do not specify the execution name, the system automatically generates an execution name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'my_exec_name', + ], + ], + [ + 'name' => 'Input', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The input of the execution, which is in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"key":"value"}', + ], + ], + [ + 'name' => 'Qualifier', + 'in' => 'formData', + 'schema' => [ + 'title' => '指定流程版本或别名', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'testRequestId', + ], + 'FlowName' => [ + 'description' => 'The name of the flow.'."\n", + 'type' => 'string', + 'example' => 'my_flow_name', + ], + 'Name' => [ + 'description' => 'The name of the execution.'."\n", + 'type' => 'string', + 'example' => 'my_exec_name:{UUID}', + ], + 'Status' => [ + 'description' => 'The status of the execution. Valid values:'."\n" + ."\n" + .'* **Starting**'."\n" + .'* **Running**'."\n" + .'* **Stopped**'."\n" + .'* **Succeeded**'."\n" + .'* **Failed**'."\n" + .'* **TimedOut**'."\n", + 'type' => 'string', + 'example' => 'Succeeded', + ], + 'ErrorCode' => [ + 'description' => 'The error code that is returned if the execution failed.'."\n", + 'type' => 'string', + 'example' => 'ActionNotSupported', + ], + 'ErrorMessage' => [ + 'description' => 'The error message that indicates the execution timed out.'."\n", + 'type' => 'string', + 'example' => 'Standard execution is not supported', + ], + 'Output' => [ + 'description' => 'The output of the execution, which is in the JSON format.'."\n", + 'type' => 'string', + 'example' => '{"key":"value"}', + ], + 'StartedTime' => [ + 'description' => 'The time when the execution started.'."\n", + 'type' => 'string', + 'example' => '2019-01-01T01:01:01.001Z', + ], + 'StoppedTime' => [ + 'description' => 'The time when the execution stopped.'."\n", + 'type' => 'string', + 'example' => '2019-01-01T01:01:01.001Z', + ], + 'Environment' => [ + 'title' => 'Flow 执行时使用的环境变量列表', + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'title' => 'Flow 执行时使用的环境变量列表', + 'type' => 'array', + 'items' => [ + 'title' => 'Flow 执行期间可以访问的变量列表', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '变量名称', + 'type' => 'string', + 'example' => 'key', + ], + 'Value' => [ + 'title' => '变量值', + 'type' => 'string', + 'example' => 'value', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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.', + ], + ], + 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.', + ], + ], + 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', + ], + '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' => 'StartSyncExecution', + 'description' => '* Only flows of the express execution mode are supported.'."\n", + ], + 'DescribeMapRun' => [ + 'summary' => '查询 MapRun 详情', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227531', + 'abilityTreeNodes' => [ + 'FEATUREfnfR0JC2A', + ], + ], + 'parameters' => [ + [ + 'name' => 'RequestId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'c39142f1345b196d678333c41f113200', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Succeeded', + ], + 'StoppedTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-10-24T14:11:28+08:00', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3A44E113-9962-5B0B-AB92-14060EFE3164', + ], + 'StartedTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-10-24T14:11:26+08:00', + ], + 'Concurrency' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ToleratedFailedCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'ToleratedFailedPercentage' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '20', + ], + 'ExecutionName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'my_exec_name', + ], + 'MapRunName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'c39142f1345b196d678333c41f113000', + ], + 'ItemCounts' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Pending' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Running' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Succeed' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Failed' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Aborted' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Total' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '500', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + '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"}]', + ], + 'UpdateMapRun' => [ + 'summary' => '更新 MapRun 配置', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227533', + 'abilityTreeNodes' => [ + 'FEATUREfnfR0JC2A', + ], + ], + 'parameters' => [ + [ + 'name' => 'RequestId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'c39142f1345b196d678333c41f113100', + ], + ], + [ + 'name' => 'Concurrency', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ToleratedFailedCount', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'ToleratedFailedPercentage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '20', + ], + ], + ], + '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', + ], + 'FlowName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'my_flow_name', + ], + 'ExecutionName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'my_exec_name', + ], + 'MapRunName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'c39142f1345b196d678333c41f113000', + ], + 'Concurrency' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ToleratedFailedCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'ToleratedFailedPercentage' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '20', + ], + ], + ], + ], + ], + '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', + ], + '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"}]', + ], + 'ReportTaskFailed' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '98865', + 'abilityTreeNodes' => [ + 'FEATUREfnf8CPMA5', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TaskToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token of the task whose execution you want to report. The task token is passed to the called service, such as Message Service (MNS) or Function Compute. For MNS, the value of this parameter can be obtained from a message. For Function Compute, the value of this parameter can be obtained from an event. For more information, see [Service integration modes](~~2592915~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'emptyString', + ], + ], + [ + 'name' => 'Error', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The error code for the failed task. The error code must be 1 to 128 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'nill', + ], + ], + [ + 'name' => 'Cause', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The cause of the failure. The value must be 1 to 4,096 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'emptyString', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'EventId' => [ + 'description' => 'The ID of the event.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + '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.', + ], + ], + 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.', + ], + ], + 409 => [ + [ + 'errorCode' => 'TaskInvalidState', + 'errorMessage' => 'Task is in an invalid state, 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.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalServerError', + 'errorMessage' => 'An internal error has occurred. Please retry.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EventId\\": 1,\\n \\"RequestId\\": \\"testRequestId\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'ReportTaskFailed', + 'summary' => 'Reports a failed task.', + 'description' => '## [](#)Usage notes'."\n" + ."\n" + .'In the previous service (Serverless Workflow), the task step that ReportTaskFailed is used to call back `pattern: waitForCallback` indicates that the current task fails to be executed.'."\n" + ."\n" + .'In the new service (CloudFlow), the task step that ReportTaskFailed is used to call back `TaskMode: WaitForCustomCallback` indicates that the current task fails to be executed.'."\n", + ], + 'ReportTaskSucceeded' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '98866', + 'abilityTreeNodes' => [ + 'FEATUREfnf8CPMA5', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TaskToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token of the task whose execution you want to report. The task token is passed to the called service, such as Message Service (MNS) or Function Compute. For MNS, the value of this parameter can be obtained from a message. For Function Compute, the value of this parameter can be obtained from an event. For more information, see [Service integration modes](~~2592915~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'emptyString', + ], + ], + [ + 'name' => 'Output', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The output information of the task whose execution success you want to report.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{"key":"value"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'EventId' => [ + 'description' => 'The ID of the event.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + '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.', + ], + ], + 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.', + ], + ], + 409 => [ + [ + 'errorCode' => 'TaskInvalidState', + 'errorMessage' => 'Task is in an invalid state, 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.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalServerError', + 'errorMessage' => 'An internal error has occurred. Please retry.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EventId\\": 1,\\n \\"RequestId\\": \\"testRequestId\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'ReportTaskSucceeded', + 'summary' => 'Reports a successful task.', + 'description' => '## [](#)Usage notes'."\n" + ."\n" + .'In the previous service (Serverless Workflow), the task step that ReportTaskSucceeded is used to call back pattern: waitForCallback indicates that the current task is successfully executed.'."\n" + ."\n" + .'In the new service (CloudFlow), the task step that ReportTaskSucceeded is used to call back TaskMode: WaitForCustomCallback indicates that the current task is successfully executed.'."\n", + ], + 'CreateSchedule' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '98855', + 'abilityTreeNodes' => [ + 'FEATUREfnf06LH4G', + ], + ], + 'parameters' => [ + [ + 'name' => 'FlowName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the workflow that is associated with the time-based schedule.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'flow', + ], + ], + [ + 'name' => 'ScheduleName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the time-based schedule. The name must meet the following conventions:'."\n" + ."\n" + .'* The name can contain letters, digits, underscores (\\_), and hyphens (-).'."\n" + .'* The name must start with a letter or an underscore (\\_).'."\n" + .'* It is case-sensitive.'."\n" + .'* The name must be 1 to 128 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testScheduleName', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The description of the time-based schedule.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test description', + ], + ], + [ + 'name' => 'Payload', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The trigger message of the time-based schedule. Specify the value in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"key": "value"}', + ], + ], + [ + 'name' => 'CronExpression', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The CRON expression.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '0 * * * * *', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Specifies whether to enable the time-based schedule. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'testRequestId', + ], + 'Description' => [ + 'description' => 'The description of the time-based schedule.'."\n", + 'type' => 'string', + 'example' => 'test description', + ], + 'ScheduleId' => [ + 'description' => 'The ID of the time-based schedule.'."\n", + 'type' => 'string', + 'example' => 'testScheduleId', + ], + 'Payload' => [ + 'description' => 'The trigger message of the time-based schedule.'."\n", + 'type' => 'string', + 'example' => '{"key": "value"}', + ], + 'ScheduleName' => [ + 'description' => 'The name of the time-based schedule.'."\n", + 'type' => 'string', + 'example' => 'testScheduleName', + ], + 'CreatedTime' => [ + 'description' => 'The time when the time-based schedule was created.'."\n", + 'type' => 'string', + 'example' => '2020-01-01T01:01:01.001Z', + ], + 'LastModifiedTime' => [ + 'description' => 'The time when the time-based schedule was last modified.'."\n", + 'type' => 'string', + 'example' => '2020-01-01T01:01:01.001Z', + ], + 'CronExpression' => [ + 'description' => 'The CRON expression.'."\n", + 'type' => 'string', + 'example' => '0 * * * * *', + ], + 'Enable' => [ + 'description' => 'Indicates whether the time-based schedule is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessDenied', + 'errorMessage' => 'The resources doesn\'t belong to you.', + ], + ], + [ + [ + 'errorCode' => 'FlowNotExists', + 'errorMessage' => 'Flow %s does not exist.', + ], + ], + 409 => [ + [ + 'errorCode' => 'ConcurrentUpdateError', + 'errorMessage' => 'Update conflict, please retry.', + ], + [ + 'errorCode' => 'ScheduleAlreadyExists', + 'errorMessage' => 'The schedule %s already exists in flow %s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalServerError', + 'errorMessage' => 'An internal error has occurred. Please retry.', + ], + ], + ], + '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' => 'CreateSchedule', + 'summary' => 'Creates a time-based schedule.', + ], + 'DeleteSchedule' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '98857', + 'abilityTreeNodes' => [ + 'FEATUREfnf06LH4G', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'FlowName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the workflow with which the scheduling task that you want to delete is associated.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testFlowName', + ], + ], + [ + 'name' => 'ScheduleName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the scheduling task that you want to delete.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testScheduleName', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + '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' => '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' => 'FlowNotExists', + 'errorMessage' => 'Flow %s does not exist.', + ], + [ + 'errorCode' => 'ScheduleNotExists', + 'errorMessage' => 'The schedule %s for 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.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalServerError', + 'errorMessage' => 'An internal error has occurred. Please retry.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"testRequestId\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'DeleteSchedule', + 'summary' => 'Deletes a time-based scheduling task.', + ], + 'UpdateSchedule' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '98870', + 'abilityTreeNodes' => [ + 'FEATUREfnf06LH4G', + ], + ], + 'parameters' => [ + [ + 'name' => 'FlowName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the flow that is associated with the time-based schedule. The name must be unique within the region and cannot be modified after the time-based schedule is created. The name must meet the following conventions:'."\n" + ."\n" + .'* The name can contain letters, digits, underscores (\\_), and hyphens (-).'."\n" + .'* The name must start with a letter or an underscore (\\_).'."\n" + .'* The name is case-sensitive.'."\n" + .'* The name must be 1 to 128 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testFlowName', + ], + ], + [ + 'name' => 'ScheduleName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the time-based schedule. The name must meet the following conventions:'."\n" + ."\n" + .'* The name can contain letters, digits, underscores (\\_), and hyphens (-).'."\n" + .'* The name must start with a letter or an underscore (\\_).'."\n" + .'* The name is case-sensitive.'."\n" + .'* The name must be 1 to 128 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testScheduleName', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The description of the time-based schedule.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test description', + ], + ], + [ + 'name' => 'Payload', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The trigger message of the time-based schedule. It must be in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"key": "value"}', + ], + ], + [ + 'name' => 'CronExpression', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The CRON expression.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0 * * * * *', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Specifies whether to enable the time-based schedule. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The schema of response.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'testRequestId', + ], + 'Description' => [ + 'description' => 'The description of the time-based schedule.'."\n", + 'type' => 'string', + 'example' => 'test description', + ], + 'ScheduleId' => [ + 'description' => 'The ID of the time-based schedule.'."\n", + 'type' => 'string', + 'example' => 'testScheduleId', + ], + 'Payload' => [ + 'description' => 'The trigger message of the time-based schedule.'."\n", + 'type' => 'string', + 'example' => '{"key": "value"}', + ], + 'ScheduleName' => [ + 'description' => 'The name of the time-based schedule.'."\n", + 'type' => 'string', + 'example' => 'testScheduleName', + ], + 'CreatedTime' => [ + 'description' => 'The time when the time-based schedule was created.'."\n", + 'type' => 'string', + 'example' => '2020-01-01T01:01:01.001Z', + ], + 'LastModifiedTime' => [ + 'description' => 'The time when the time-based schedule was last updated.'."\n", + 'type' => 'string', + 'example' => '2020-01-01T01:01:01.001Z', + ], + 'CronExpression' => [ + 'description' => 'The CRON expression.'."\n", + 'type' => 'string', + 'example' => '0 * * * * *', + ], + 'Enable' => [ + 'description' => 'Indicates whether the time-based schedule is enabled. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessDenied', + 'errorMessage' => 'The resources doesn\'t belong to you.', + ], + ], + [ + [ + 'errorCode' => 'FlowNotExists', + 'errorMessage' => 'Flow %s does not exist.', + ], + [ + 'errorCode' => 'ScheduleNotExists', + 'errorMessage' => 'The schedule %s for 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.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalServerError', + 'errorMessage' => 'An internal error has occurred. Please retry.', + ], + ], + ], + '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' => 'UpdateSchedule', + 'summary' => 'Updates a time-based schedule.', + ], + 'DescribeSchedule' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '98860', + 'abilityTreeNodes' => [ + 'FEATUREfnf06LH4G', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'FlowName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the flow that is associated with the time-based schedule. The name must be unique within the region and cannot be modified after the time-based schedule is created. The name must meet the following conventions:'."\n" + ."\n" + .'* The name can contain letters, digits, underscores (\\_), and hyphens (-).'."\n" + .'* The name must start with a letter or an underscore (\\_).'."\n" + .'* The name is case-sensitive.'."\n" + .'* The name must be 1 to 128 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testFlowName', + ], + ], + [ + 'name' => 'ScheduleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the time-based schedule. The name must meet the following conventions:'."\n" + ."\n" + .'* The name can contain letters, digits, underscores (\\_), and hyphens (-).'."\n" + .'* The name must start with a letter or an underscore (\\_).'."\n" + .'* The name is case-sensitive.'."\n" + .'* The name must be 1 to 128 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testScheduleName', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of response.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'testRequestId', + ], + 'Description' => [ + 'description' => 'The description of the time-based schedule.'."\n", + 'type' => 'string', + 'example' => 'test description', + ], + 'ScheduleId' => [ + 'description' => 'The ID of the time-based schedule.'."\n", + 'type' => 'string', + 'example' => 'testScheduleId', + ], + 'Payload' => [ + 'description' => 'The trigger message of the time-based schedule.'."\n", + 'type' => 'string', + 'example' => '{"key": "value"}', + ], + 'ScheduleName' => [ + 'description' => 'The name of the time-based schedule.'."\n", + 'type' => 'string', + 'example' => 'testScheduleName', + ], + 'CreatedTime' => [ + 'description' => 'The time when the time-based schedule was created.'."\n", + 'type' => 'string', + 'example' => '2020-01-01T01:01:01.001Z', + ], + 'LastModifiedTime' => [ + 'description' => 'The time when the time-based schedule was last modified.'."\n", + 'type' => 'string', + 'example' => '2020-01-01T01:01:01.001Z', + ], + 'CronExpression' => [ + 'description' => 'The CRON expression.'."\n", + 'type' => 'string', + 'example' => '0 * * * * *', + ], + 'Enable' => [ + 'description' => 'Indicates whether the time-based schedule is enabled. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + '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.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessDenied', + 'errorMessage' => 'The resources doesn\'t belong to you.', + ], + ], + [ + [ + 'errorCode' => 'FlowNotExists', + 'errorMessage' => 'Flow %s does not exist.', + ], + [ + 'errorCode' => 'ScheduleNotExists', + 'errorMessage' => 'The schedule %s for flow %s does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalServerError', + 'errorMessage' => 'An internal error has occurred. Please retry.', + ], + ], + ], + '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' => 'DescribeSchedule', + 'summary' => 'Queries the detailed information about a time-based schedule.', + ], + 'ListSchedules' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '98864', + 'abilityTreeNodes' => [ + 'FEATUREfnf06LH4G', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'FlowName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the flow that is associated with the time-based schedules. The name is unique within the region and cannot be modified after the flow is created. The name must meet the following conventions:'."\n" + ."\n" + .'* The name can contain letters, digits, underscores (\\_), and hyphens (-).'."\n" + .'* The name must start with a letter or an underscore (\\_).'."\n" + .'* The name is case-sensitive.'."\n" + .'* The name must be 1 to 128 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testFlowName', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'For the first query, you do not need to specify this parameter. The system uses the value of the **FlowName** parameter as the value of the **NextToken** parameter. When the query ends, no value is returned for this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testNextToken', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of schedules that you want to query. Valid values: 1 to 1000.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'maximum' => '1000', + 'minimum' => '1', + 'example' => '1', + 'default' => '60', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The schema of response.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The token for the next query.'."\n", + 'type' => 'string', + 'example' => 'testNextToken', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'testRequestId', + ], + 'Schedules' => [ + 'description' => 'The time-based schedules that are queried.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => 'The description of the time-based schedule.'."\n", + 'type' => 'string', + 'example' => 'test description', + ], + 'ScheduleId' => [ + 'description' => 'The ID of the time-based schedule.'."\n", + 'type' => 'string', + 'example' => 'testScheduleId', + ], + 'Payload' => [ + 'description' => 'The trigger message of the time-based schedule.'."\n", + 'type' => 'string', + 'example' => '{"key": "value"}', + ], + 'ScheduleName' => [ + 'description' => 'The name of the time-based schedule.'."\n", + 'type' => 'string', + 'example' => 'testScheduleName', + ], + 'CreatedTime' => [ + 'description' => 'The time when the time-based schedule was created.'."\n", + 'type' => 'string', + 'example' => '2020-01-01T01:01:01.001Z', + ], + 'LastModifiedTime' => [ + 'description' => 'The time when the time-based schedule was last modified.'."\n", + 'type' => 'string', + 'example' => '2020-01-01T01:01:01.001Z', + ], + 'CronExpression' => [ + 'description' => 'The cron expression of the scheduled task.'."\n", + 'type' => 'string', + 'example' => '0 * * * * *', + ], + 'Enable' => [ + 'description' => 'Indicates whether the time-based schedule is enabled. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + '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.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessDenied', + 'errorMessage' => 'The resources doesn\'t belong to you.', + ], + ], + [ + [ + 'errorCode' => 'FlowNotExists', + 'errorMessage' => 'Flow %s does not exist.', + ], + ], + 412 => [ + [ + 'errorCode' => 'PreconditionFailed', + 'errorMessage' => 'The resource to be modified has been changed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalServerError', + 'errorMessage' => 'An internal error has occurred. Please retry.', + ], + ], + ], + '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' => 'ListSchedules', + 'summary' => 'Queries time-based schedules in a flow.', + ], + ], + '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', + ], + ], +]; |