diff options
| author | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
|---|---|---|
| committer | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
| commit | 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch) | |
| tree | 5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/composer/2018-12-12/api-docs.php | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/en_us/composer/2018-12-12/api-docs.php')
| -rw-r--r-- | data/en_us/composer/2018-12-12/api-docs.php | 2645 |
1 files changed, 1109 insertions, 1536 deletions
diff --git a/data/en_us/composer/2018-12-12/api-docs.php b/data/en_us/composer/2018-12-12/api-docs.php index 6a3cfba..87891b0 100644 --- a/data/en_us/composer/2018-12-12/api-docs.php +++ b/data/en_us/composer/2018-12-12/api-docs.php @@ -1,135 +1,43 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'composer', - 'version' => '2018-12-12', - ], + 'info' => ['style' => 'RPC', 'product' => 'composer', 'version' => '2018-12-12'], 'directories' => [ [ - 'id' => 74102, - 'title' => 'Tag', - 'type' => 'directory', - 'children' => [ - 'TagResources', - 'UntagResources', - 'ListTagResources', - ], - ], - [ - 'id' => 74106, - 'title' => 'Template', + 'children' => ['EnableFlow', 'GetVersion', 'InvokeFlow'], 'type' => 'directory', - 'children' => [ - 'GetTemplate', - 'ListTemplates', - ], + 'title' => 'Workflow', ], [ - 'id' => 74109, - 'title' => 'Workflow', + 'children' => ['CloneFlow', 'CreateFlow', 'DeleteFlow', 'DisableFlow', 'GetFlow', 'GetTemplate', 'GroupInvokeFlow', 'ListFlows', 'ListTagResources', 'ListTemplates', 'ListVersions', 'TagResources', 'UntagResources', 'UpdateFlow'], + 'title' => 'Others', 'type' => 'directory', - 'children' => [ - 'CreateFlow', - 'CloneFlow', - 'DeleteFlow', - 'DisableFlow', - 'EnableFlow', - 'UpdateFlow', - 'ListFlows', - 'ListVersions', - 'GetVersion', - 'GetFlow', - 'InvokeFlow', - 'GroupInvokeFlow', - ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'TagResources' => [ - 'summary' => 'Attaches tags to one or more resources.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CloneFlow' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'deprecated' => true, + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'ResourceType', + 'name' => 'FlowId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the resources. Set the value to ALIYUN::LC::FLOW.'."\n" - ."\n" - .'* ALIYUN::LC::FLOW indicates Logic Composer workflows.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ALIYUN::LC::FLOW', - ], + 'schema' => ['description' => 'The ID of the workflow that you want to clone.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'lc-uf6yrfwxpe6wkw', 'title' => ''], ], [ - 'name' => 'ResourceId', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'Specifies a maximum of 50 resource IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the resource.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'lc-uf6abcdefg', - ], - 'required' => true, - 'example' => 'lc-uf6tbvhheciyxl', - 'maxItems' => 50, - ], - ], - [ - 'name' => 'Tag', + 'name' => 'VersionId', 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'Specifies a list of tags that you want to attach to the resources.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'tagKey', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'tagValue', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 20, - ], + 'schema' => ['description' => 'The version of the workflow that you want to clone. If you do not specify this parameter, the latest version of the workflow is to be cloned.'."\n", 'type' => 'string', 'required' => false, 'example' => 've-uf6bwdtvid7o25', 'title' => ''], ], ], 'responses' => [ @@ -137,36 +45,41 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ADB97A33-50E7-48A5-963D-ACBAE36D0BEC', - ], + 'FlowId' => ['description' => 'The ID of the workflow that is generated after the cloning.'."\n", 'type' => 'string', 'example' => 'lc-uf6wvbsyvvl5sy', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'ADB97A33-50E7-48A5-963D-ACBAE36D0BEC', 'title' => ''], ], + 'description' => '', + 'title' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"ADB97A33-50E7-48A5-963D-ACBAE36D0BEC\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>ADB97A33-50E7-48A5-963D-ACBAE36D0BEC</RequestId>\\n<Success>true</Success>","errorExample":""}]', - 'title' => 'TagResources', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'UntagResources' => [ - 'summary' => 'Removes tags from one or more resources.', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidFlow.NotFound', 'errorMessage' => 'The specified workflow does not exist. Verify the availability of the workflow.', 'description' => 'The specified workflow does not exist. Make sure the workflow is available.'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FlowId\\": \\"lc-uf6wvbsyvvl5sy\\",\\n \\"RequestId\\": \\"ADB97A33-50E7-48A5-963D-ACBAE36D0BEC\\"\\n}","type":"json"}]', + 'title' => 'CloneFlow', + 'summary' => 'Clones a workflow.', + 'description' => 'This API operation will be deprecated soon. To copy a workflow, call the GetFlow operation to obtain the workflow information and then call the CreateFlow operation to create the workflow.'."\n", + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'composer:CloneFlow', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'Flow', 'arn' => 'acs:composer:{#regionId}:{#accountId}:flow/{#FlowId}'], + ], + ], + ], ], + ], + 'CreateFlow' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -174,296 +87,201 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'ResourceType', + 'name' => 'FlowName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the resources. Set the value to ALIYUN::LC::FLOW.'."\n" - ."\n" - .'* ALIYUN::LC::FLOW indicates Logic Composer workflows.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ALIYUN::LC::FLOW', - ], + 'schema' => ['description' => 'The name of the workflow.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'All', + 'name' => 'FlowDescription', 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to remove all tags from the specified resource groups or members. Valid values:'."\n" - ."\n" - .'* false (default value)'."\n" - .'* true', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The description of the workflow.'."\n", 'type' => 'string', 'required' => false, 'example' => 'This is a workflow.'."\n", 'title' => ''], ], [ - 'name' => 'ResourceId', + 'name' => 'Definition', 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'Specifies a maximum of 50 resource IDs.', - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the resource.', - 'type' => 'string', - 'required' => false, - 'example' => 'lc-uf6tbvhheciyxl', - ], - 'required' => true, - 'example' => 'lc-uf6tbvhheciyxl', - 'maxItems' => 50, - ], + 'schema' => ['description' => 'The definition of the workflow, which must be a JSON string.'."\n", 'type' => 'string', 'required' => false, 'example' => '{\\"schemaVersion\\":\\"2018-12-12\\",\\"actions\\":{},\\"version\\":\\"1.0.0\\",\\"triggers\\":{}}', 'title' => ''], ], [ - 'name' => 'TagKey', + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the template.'."\n", 'type' => 'string', 'required' => false, 'example' => 'tp-uf6tbvhheciyxl', 'title' => ''], + ], + [ + 'name' => 'FlowSource', 'in' => 'formData', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'An array consisting of the keys of the tags that you want to remove.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'A tag key.'."\n" - ."\n" - .'You can specify a maximum of 20 tag keys.'."\n" - ."\n" - .'> If you set the `All` parameter to `true`, you do not need to configure this parameter.', - 'type' => 'string', - 'required' => false, - 'example' => 'testKey', - ], + 'description' => 'The source of the workflow. Valid values:'."\n" + ."\n" + .'* Default: Create the workflow in the console.'."\n" + .'* CloudConfig: Create the workflow by using Cloud Config.'."\n" + .'* Solution: Create the workflow by using Logic Composer.'."\n", + 'type' => 'string', 'required' => false, - 'example' => 'tagKey', - 'maxItems' => 20, + 'enumValueTitles' => ['CloudConfig' => '从配置审计创建', 'Default' => '默认来源', 'Solution' => '从逻辑编排解决方案中心创建'], + 'example' => 'Default', + 'title' => '', ], ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-aekzmrjn4nsszna', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ADB97A33-50E7-48A5-963D-ACBAE36D0BEC', - ], + 'FlowId' => ['description' => 'The ID of the created workflow.'."\n", 'type' => 'string', 'example' => 'lc-utf6abcdefg', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'D264C934-2DA8-44B4-B034-C659A63AC659', 'title' => ''], ], + 'description' => '', + 'title' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"ADB97A33-50E7-48A5-963D-ACBAE36D0BEC\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>ADB97A33-50E7-48A5-963D-ACBAE36D0BEC</RequestId>\\n<Success>true</Success>","errorExample":""}]', - 'title' => 'UntagResources', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FlowId\\": \\"lc-utf6abcdefg\\",\\n \\"RequestId\\": \\"D264C934-2DA8-44B4-B034-C659A63AC659\\"\\n}","type":"json"}]', + 'title' => 'CreateFlow', + 'summary' => 'Creates a workflow.', + 'description' => 'After you create a workflow, the system automatically creates a version for the workflow. You can call the GetVersion operation to obtain the version information.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListTagResources' => [ - 'summary' => 'Queries a list of resources of a specified tag.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2022-11-21T06:29:08.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'composer:CreateFlow', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'Flow', 'arn' => 'acs:composer:{#regionId}:{#accountId}:flow/*'], + ], + ], + ], ], + ], + 'DeleteFlow' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'ResourceType', + 'name' => 'FlowId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'ALIYUN::LC::FLOW' => '', - ], - 'example' => 'ALIYUN::LC::FLOW', - ], + 'schema' => ['description' => 'The ID of the workflow that you want to delete.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'lc-uf6wvbsyvvl5sy', 'title' => ''], ], - [ - 'name' => 'NextToken', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values: **true**: The operation was successful. **false**: The operation failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'ADB97A33-50E7-48A5-963D-ACBAE36D0BEC', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + 'title' => '', ], ], - [ - 'name' => 'MaxResults', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"ADB97A33-50E7-48A5-963D-ACBAE36D0BEC\\"\\n}","type":"json"}]', + 'title' => 'DeleteFlow', + 'summary' => 'Deletes a workflow.', + 'description' => 'If you delete a workflow, all version information about the workflow and execution records of the workflow are automatically deleted.'."\n", + 'changeSet' => [ + ['createdAt' => '2022-11-21T06:29:08.000Z', 'description' => 'Error codes changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'composer:DeleteFlow', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'Flow', 'arn' => 'acs:composer:{#regionId}:{#accountId}:flow/{#FlowId}'], + ], ], ], + ], + ], + 'DisableFlow' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ResourceId', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'lc-0xiisfk685vhfk', - ], - 'required' => false, - 'maxItems' => 50, - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'Tag', + 'name' => 'FlowId', 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'testkey', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'testvalue', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 20, - ], + 'schema' => ['description' => 'The ID of the workflow that you want to disable.'."\n", 'docRequired' => true, 'example' => 'lc-uf6pvud38xl0ia', 'required' => true, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'C9025B15-16CC-53FB-B7B1-7295AA010EBD', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'TagResources' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ResourceType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ALIYUN::LC::FLOW', - ], - 'TagValue' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'testvalue', - ], - 'ResourceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'lc-0xiisfk685vhfk', - ], - 'TagKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'testkey', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'example' => 'ADB97A33-50E7-48A5-963D-ACBAE36D0BEC', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful.'."\n" + ."\n" + .'* **true**: The operation was successful.'."\n" + .'* **false**: The operation failed.'."\n", 'example' => 'true', 'type' => 'boolean', 'title' => ''], + 'FlowStatus' => ['description' => 'The status of the workflow.'."\n" + ."\n" + .'* **Enabled**: The workflow is enabled.'."\n" + .'* **Disabled**: The workflow is disabled.'."\n", 'example' => 'Disabled', 'type' => 'string', 'title' => ''], ], + 'type' => 'object', + 'description' => '', + 'title' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"C9025B15-16CC-53FB-B7B1-7295AA010EBD\\",\\n \\"TotalCount\\": 2,\\n \\"TagResources\\": [\\n {\\n \\"ResourceType\\": \\"ALIYUN::LC::FLOW\\",\\n \\"TagValue\\": \\"testvalue\\",\\n \\"ResourceId\\": \\"lc-0xiisfk685vhfk\\",\\n \\"TagKey\\": \\"testkey\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListTagResourcesResponse>\\n <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>\\n <RequestId>C9025B15-16CC-53FB-B7B1-7295AA010EBD</RequestId>\\n <TotalCount>2</TotalCount>\\n <TagResources>\\n <ResourceType>ALIYUN::LC::FLOW</ResourceType>\\n <TagValue>testvalue</TagValue>\\n <ResourceId>lc-0xiisfk685vhfk</ResourceId>\\n <TagKey>testkey</TagKey>\\n </TagResources>\\n</ListTagResourcesResponse>","errorExample":""}]', - 'title' => 'ListTagResources', - ], - 'GetTemplate' => [ - 'summary' => 'Queries the details of an orchestration template.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidFlow.NotFound', 'errorMessage' => 'The specified workflow does not exist. Verify the availability of the workflow.', 'description' => 'The specified workflow does not exist. Make sure the workflow is available.'], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ADB97A33-50E7-48A5-963D-ACBAE36D0BEC\\",\\n \\"Success\\": true,\\n \\"FlowStatus\\": \\"Disabled\\"\\n}","type":"json"}]', + 'summary' => 'Disables a workflow. A disabled workflow is not running.', + 'title' => 'DisableFlow', + 'changeSet' => [], + ], + 'EnableFlow' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'TemplateId', + 'name' => 'FlowId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'tp-uf6tbvhheciyxl', - ], + 'schema' => ['description' => 'The ID of the workflow to be enabled', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'tp-uf6pvud38xl0ia'], ], ], 'responses' => [ @@ -471,107 +289,47 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'UpdateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2020-08-19T03:31:32.415Z', - ], - 'TemplateOverview' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[]', - ], - 'TemplateConnector' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'config,oss', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2020-08-19T03:31:32.415Z', - ], - 'TemplateSummaryEn' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'This is a test template', - ], - 'TemplateName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'TemplateVersion' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'TemplateCreator' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'TemplateLocale' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'zh', - ], - 'RegionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'TemplateDescription' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'TemplateTag' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test,owner', - ], - 'Definition' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{"actions": {},"schemaVersion":"2018-12-12","version": "1.0.0"}', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BCF7212F-9478-569A-B57C-8C1B5A560C2F', - ], - 'TemplateSummary' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'TemplateId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'tp-uf6tbvhheciyxl', - ], + 'RequestId' => ['description' => 'The request ID', 'type' => 'string', 'title' => '', 'example' => 'ADB97A33-50E7-48A5-963D-ACBAE36D0BEC'], + 'Success' => ['description' => 'The result of the current operation.'."\n" + ."\n" + .'- **true**: The modification is successful'."\n" + .'- **false**: The modification failed', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'FlowStatus' => ['description' => 'The current state of the workflow.'."\n" + ."\n" + .'- **Enabled**: Enabled'."\n" + .'- **Disabled**: Disabled', 'type' => 'string', 'title' => '', 'example' => 'Enabled'], ], + 'description' => '', + 'title' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"UpdateTime\\": \\"2020-08-19T03:31:32.415Z\\",\\n \\"TemplateOverview\\": \\"[]\\",\\n \\"TemplateConnector\\": \\"config,oss\\",\\n \\"CreateTime\\": \\"2020-08-19T03:31:32.415Z\\",\\n \\"TemplateSummaryEn\\": \\"This is a test template\\",\\n \\"TemplateName\\": \\"测试模板\\",\\n \\"TemplateVersion\\": 0,\\n \\"TemplateCreator\\": \\"逻辑编排\\",\\n \\"TemplateLocale\\": \\"zh\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"TemplateDescription\\": \\"该模板仅用于测试用途\\",\\n \\"TemplateTag\\": \\"test,owner\\",\\n \\"Definition\\": \\"{\\\\\\"actions\\\\\\": {},\\\\\\"schemaVersion\\\\\\":\\\\\\"2018-12-12\\\\\\",\\\\\\"version\\\\\\": \\\\\\"1.0.0\\\\\\"}\\",\\n \\"RequestId\\": \\"BCF7212F-9478-569A-B57C-8C1B5A560C2F\\",\\n \\"TemplateSummary\\": \\"这是一个测试模板\\",\\n \\"TemplateId\\": \\"tp-uf6tbvhheciyxl\\"\\n}","type":"json"}]', - 'title' => 'GetTemplate', - ], - 'ListTemplates' => [ - 'summary' => 'Queries a list of templates visible to the current user.', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidFlow.NotFound', 'errorMessage' => 'The specified workflow does not exist. Verify the availability of the workflow.', 'description' => 'The specified workflow does not exist. Make sure the workflow is available.'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'EnableFlow', + 'summary' => 'Enables a workflow.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'composer:EnableFlow', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'Flow', 'arn' => 'acs:composer:{#regionId}:{#accountId}:flow/{#FlowId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ADB97A33-50E7-48A5-963D-ACBAE36D0BEC\\",\\n \\"Success\\": true,\\n \\"FlowStatus\\": \\"Enabled\\"\\n}","type":"json"}]', + ], + 'GetFlow' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -579,63 +337,12 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'Tag', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'Lang', + 'name' => 'FlowId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The ID of the workflow.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'lc-uf6pvud38xl0ia', 'title' => ''], ], ], 'responses' => [ @@ -643,193 +350,68 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ADB97A33-50E7-48A5-963D-ACBAE36D0BEC', - ], - 'Templates' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'UpdateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2020-08-19T03:31:32.415Z', - ], - 'TemplateOverview' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[]', - ], - 'TemplateConnector' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'oss,rds', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2020-08-19T03:31:32.415Z', - ], - 'TemplateSummaryEn' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'This is a test template', - ], - 'TemplateName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'TemplateVersion' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'TemplateLocale' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'zh', - ], - 'TemplateCreator' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'TemplateDescription' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'TemplateTag' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'finance', - ], - 'TemplateSummary' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'TemplateId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'tp-uf6tbvhheciyxl', - ], - ], - ], - ], + 'UpdateTime' => ['description' => 'The time when the workflow was last updated.'."\n", 'type' => 'string', 'format' => 'iso8601', 'example' => '2019-07-19T05:43:16.783Z', 'title' => ''], + 'FlowSource' => ['description' => 'The source of the workflow.'."\n", 'type' => 'string', 'example' => 'CloudConfig', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the workflow was created.'."\n", 'type' => 'string', 'format' => 'iso8601', 'example' => '2019-07-19T05:43:16.783Z', 'title' => ''], + 'FlowEditMode' => ['description' => 'The edit mode of the workflow.'."\n", 'type' => 'string', 'example' => 'Locked', 'title' => ''], + 'FlowDescription' => ['description' => 'The description of the workflow.'."\n", 'type' => 'string', 'example' => 'This is a workflow.'."\n", 'title' => ''], + 'CurrentVersionId' => ['description' => 'The version ID of the workflow.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'FlowName' => ['description' => 'The name of the workflow.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'FlowId' => ['description' => 'The ID of the workflow.'."\n", 'type' => 'string', 'example' => 'lc-uf6pvud38xl0ia', 'title' => ''], + 'RegionId' => ['description' => 'The ID of the region where the workflow resides.'."\n", 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], + 'Definition' => ['description' => 'The definition of the workflow.'."\n", 'type' => 'string', 'example' => '{\\"schemaVersion\\":\\"2018-12-12\\",\\"actions\\":{},\\"version\\":\\"1.0.0\\",\\"triggers\\":{}}', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'ADB97A33-50E7-48A5-963D-ACBAE36D0BEC', 'title' => ''], + 'FlowStatus' => ['description' => 'The status of the workflow. Valid values:'."\n" + ."\n" + .'* **Enabled**: The workflow is enabled.'."\n" + .'* **Disabled**: The workflow is disabled.'."\n", 'type' => 'string', 'example' => 'Enabled', 'title' => ''], + 'TemplateId' => ['description' => 'The template ID.'."\n", 'type' => 'string', 'example' => 'tp-uf6tbvhheciyxl', 'title' => ''], + 'ResourceGroupId' => ['title' => '资源组ID', 'description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-acfmzyxxxxxxx'], ], + 'description' => '', + 'title' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 10,\\n \\"RequestId\\": \\"ADB97A33-50E7-48A5-963D-ACBAE36D0BEC\\",\\n \\"Templates\\": [\\n {\\n \\"UpdateTime\\": \\"2020-08-19T03:31:32.415Z\\",\\n \\"TemplateOverview\\": \\"[]\\",\\n \\"TemplateConnector\\": \\"oss,rds\\",\\n \\"CreateTime\\": \\"2020-08-19T03:31:32.415Z\\",\\n \\"TemplateSummaryEn\\": \\"This is a test template\\",\\n \\"TemplateName\\": \\"测试模板\\",\\n \\"TemplateVersion\\": 0,\\n \\"TemplateLocale\\": \\"zh\\",\\n \\"TemplateCreator\\": \\"逻辑编排\\",\\n \\"TemplateDescription\\": \\"这是一个测试用的模板\\",\\n \\"TemplateTag\\": \\"finance\\",\\n \\"TemplateSummary\\": \\"测试模板的简介\\",\\n \\"TemplateId\\": \\"tp-uf6tbvhheciyxl\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListTemplates', - ], - 'CreateFlow' => [ - 'summary' => 'Creates a workflow.', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidFlow.NotFound', 'errorMessage' => 'The specified workflow does not exist. Verify the availability of the workflow.', 'description' => 'The specified workflow does not exist. Make sure the workflow is available.'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"UpdateTime\\": \\"2019-07-19T05:43:16.783Z\\",\\n \\"FlowSource\\": \\"CloudConfig\\",\\n \\"CreateTime\\": \\"2019-07-19T05:43:16.783Z\\",\\n \\"FlowEditMode\\": \\"Locked\\",\\n \\"FlowDescription\\": \\"This is a workflow.\\\\n\\",\\n \\"CurrentVersionId\\": \\"1\\",\\n \\"FlowName\\": \\"test\\",\\n \\"FlowId\\": \\"lc-uf6pvud38xl0ia\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"Definition\\": \\"{\\\\\\\\\\\\\\"schemaVersion\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2018-12-12\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"actions\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"version\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1.0.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"triggers\\\\\\\\\\\\\\":{}}\\",\\n \\"RequestId\\": \\"ADB97A33-50E7-48A5-963D-ACBAE36D0BEC\\",\\n \\"FlowStatus\\": \\"Enabled\\",\\n \\"TemplateId\\": \\"tp-uf6tbvhheciyxl\\",\\n \\"ResourceGroupId\\": \\"rg-acfmzyxxxxxxx\\"\\n}","type":"json"}]', + 'title' => 'GetFlow', + 'summary' => 'Queries information about a workflow.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'composer:GetFlow', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'Flow', 'arn' => 'acs:composer:{#regionId}:{#accountId}:flow/{#FlowId}'], + ], + ], + ], ], + ], + 'GetTemplate' => [ + 'summary' => 'Retrieves the details of an orchestration template.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'FlowName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the workflow.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test', - ], - ], - [ - 'name' => 'FlowDescription', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the workflow.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'This is a workflow.'."\n", - ], - ], - [ - 'name' => 'Definition', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The definition of the workflow, which must be a JSON string.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{\\"schemaVersion\\":\\"2018-12-12\\",\\"actions\\":{},\\"version\\":\\"1.0.0\\",\\"triggers\\":{}}', - ], - ], - [ 'name' => 'TemplateId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the template.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'tp-uf6tbvhheciyxl', - ], - ], - [ - 'name' => 'FlowSource', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The source of the workflow. Valid values:'."\n" - ."\n" - .'* Default: Create the workflow in the console.'."\n" - .'* CloudConfig: Create the workflow by using Cloud Config.'."\n" - .'* Solution: Create the workflow by using Logic Composer.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'CloudConfig' => '', - 'Default' => '', - 'Solution' => '', - ], - 'example' => 'Default', - ], - ], - [ - 'name' => 'ResourceGroupId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the resource group.', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aekzmrjn4nsszna', - ], + 'schema' => ['description' => 'The template ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'tp-uf6tbvhheciyxl', 'title' => ''], ], ], 'responses' => [ @@ -837,68 +419,70 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'FlowId' => [ - 'description' => 'The ID of the created workflow.'."\n", - 'type' => 'string', - 'example' => 'lc-utf6abcdefg', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'D264C934-2DA8-44B4-B034-C659A63AC659', - ], + 'UpdateTime' => ['description' => 'The time when the template was last updated.', 'type' => 'string', 'example' => '2020-08-19T03:31:32.415Z', 'title' => ''], + 'TemplateOverview' => ['description' => 'The overview of the template. This is a JSON string.', 'type' => 'string', 'example' => '[]', 'title' => ''], + 'TemplateConnector' => ['description' => 'A list of connectors used in the template, separated by commas.', 'type' => 'string', 'example' => 'config,oss', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the template was created.', 'type' => 'string', 'example' => '2020-08-19T03:31:32.415Z', 'title' => ''], + 'TemplateSummaryEn' => ['description' => 'The summary in English.', 'type' => 'string', 'example' => 'This is a test template', 'title' => ''], + 'TemplateName' => ['description' => 'The title of the template.', 'type' => 'string', 'example' => '测试模板', 'title' => ''], + 'TemplateVersion' => ['description' => 'The version of the template. The value is a number that increments from 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'TemplateCreator' => ['description' => 'The publisher of the template.', 'type' => 'string', 'example' => '逻辑编排', 'title' => ''], + 'TemplateLocale' => ['description' => 'The language of the template. Currently, Chinese (zh) and English (en) are supported.', 'type' => 'string', 'example' => 'zh', 'title' => ''], + 'RegionId' => ['description' => 'The region where the template is located.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], + 'TemplateDescription' => ['description' => 'The description of the template.', 'type' => 'string', 'example' => '该模板仅用于测试用途', 'title' => ''], + 'TemplateTag' => ['description' => 'The tag of the template.', 'type' => 'string', 'example' => 'test,owner', 'title' => ''], + 'Definition' => ['description' => 'The definition of the template.', 'type' => 'string', 'example' => '{"actions": {},"schemaVersion":"2018-12-12","version": "1.0.0"}', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier of the current request.', 'type' => 'string', 'example' => 'BCF7212F-9478-569A-B57C-8C1B5A560C2F', 'title' => ''], + 'TemplateSummary' => ['description' => 'A brief introduction to the template.', 'type' => 'string', 'example' => '这是一个测试模板', 'title' => ''], + 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => 'tp-uf6tbvhheciyxl', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"UpdateTime\\": \\"2020-08-19T03:31:32.415Z\\",\\n \\"TemplateOverview\\": \\"[]\\",\\n \\"TemplateConnector\\": \\"config,oss\\",\\n \\"CreateTime\\": \\"2020-08-19T03:31:32.415Z\\",\\n \\"TemplateSummaryEn\\": \\"This is a test template\\",\\n \\"TemplateName\\": \\"测试模板\\",\\n \\"TemplateVersion\\": 0,\\n \\"TemplateCreator\\": \\"逻辑编排\\",\\n \\"TemplateLocale\\": \\"zh\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"TemplateDescription\\": \\"该模板仅用于测试用途\\",\\n \\"TemplateTag\\": \\"test,owner\\",\\n \\"Definition\\": \\"{\\\\\\"actions\\\\\\": {},\\\\\\"schemaVersion\\\\\\":\\\\\\"2018-12-12\\\\\\",\\\\\\"version\\\\\\": \\\\\\"1.0.0\\\\\\"}\\",\\n \\"RequestId\\": \\"BCF7212F-9478-569A-B57C-8C1B5A560C2F\\",\\n \\"TemplateSummary\\": \\"这是一个测试模板\\",\\n \\"TemplateId\\": \\"tp-uf6tbvhheciyxl\\"\\n}","type":"json"}]', + 'title' => 'GetTemplate', + 'changeSet' => [ + ['createdAt' => '2022-11-21T06:29:08.000Z', 'description' => 'Error codes changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'composer:GetTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FlowId\\": \\"lc-utf6abcdefg\\",\\n \\"RequestId\\": \\"D264C934-2DA8-44B4-B034-C659A63AC659\\"\\n}","type":"json"}]', - 'title' => 'CreateFlow', - 'description' => 'After you create a workflow, the system automatically creates a version for the workflow. You can call the GetVersion operation to obtain the version information.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'CloneFlow' => [ - 'summary' => 'Clones a workflow.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetVersion' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'FlowId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workflow that you want to clone.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'lc-uf6yrfwxpe6wkw', - ], + 'schema' => ['description' => 'The workflow ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'lc-uf6axpwfcw4ubx'], ], [ 'name' => 'VersionId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The version of the workflow that you want to clone. If you do not specify this parameter, the latest version of the workflow is to be cloned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 've-uf6bwdtvid7o25', - ], + 'schema' => ['description' => 'The version ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 've-uf6bwdtvid7o25'], ], ], 'responses' => [ @@ -906,63 +490,84 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'FlowId' => [ - 'description' => 'The ID of the workflow that is generated after the cloning.'."\n", - 'type' => 'string', - 'example' => 'lc-uf6wvbsyvvl5sy', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ADB97A33-50E7-48A5-963D-ACBAE36D0BEC', - ], + 'Definition' => ['description' => 'The workflow definition corresponding to the current version', 'type' => 'string', 'title' => '', 'example' => '{\\"schemaVersion\\":\\"2018-12-12\\",\\"actions\\":{},\\"version\\":\\"1.0.0\\",\\"triggers\\":{}}'], + 'UpdateTime' => ['description' => 'The last update time of the version', 'type' => 'string', 'title' => '', 'example' => '2018-12-12T07:36:22.992Z'], + 'RequestId' => ['description' => 'The request ID', 'type' => 'string', 'title' => '', 'example' => 'ADB97A33-50E7-48A5-963D-ACBAE36D0BEC'], + 'VersionStatus' => ['description' => 'The version status. **Enabled** indicates that the version is enabled.', 'type' => 'string', 'title' => '', 'example' => 'Enabled'], + 'CreateTime' => ['description' => 'The creation time of the version', 'type' => 'string', 'title' => '', 'example' => '2018-12-12T07:36:22.992Z'], + 'VersionId' => ['description' => 'The version ID', 'type' => 'string', 'title' => '', 'example' => 've-uf6bwdtvid7o25'], + 'VersionName' => ['description' => 'The version name', 'type' => 'string', 'title' => '', 'example' => '5.3.6'], + 'VersionDescription' => ['description' => 'The version description', 'type' => 'string', 'title' => '', 'example' => '这是版本描述'], + 'FlowId' => ['description' => 'The workflow ID to which the version belongs', 'type' => 'string', 'title' => '', 'example' => 'lc-uf6wvbsyvvl5sy'], + 'RegionId' => ['description' => 'The region to which the current workflow belongs', 'type' => 'string', 'title' => '', 'example' => 'cn-shanghai'], ], + 'description' => '', + 'title' => '', ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidFlow.NotFound', - 'errorMessage' => 'The specified workflow does not exist. Verify the availability of the workflow.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetVersion', + 'summary' => 'Queries information about a specific version of a workflow.', + 'changeSet' => [ + ['createdAt' => '2022-11-21T06:29:07.000Z', 'description' => 'Error codes changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'composer:GetVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'Flow', 'arn' => 'acs:composer:{#regionId}:{#accountId}:flow/{#FlowId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FlowId\\": \\"lc-uf6wvbsyvvl5sy\\",\\n \\"RequestId\\": \\"ADB97A33-50E7-48A5-963D-ACBAE36D0BEC\\"\\n}","type":"json"}]', - 'title' => 'CloneFlow', - 'description' => 'This API operation will be deprecated soon. To copy a workflow, call the GetFlow operation to obtain the workflow information and then call the CreateFlow operation to create the workflow.'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Definition\\": \\"{\\\\\\\\\\\\\\"schemaVersion\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2018-12-12\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"actions\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"version\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1.0.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"triggers\\\\\\\\\\\\\\":{}}\\",\\n \\"UpdateTime\\": \\"2018-12-12T07:36:22.992Z\\",\\n \\"RequestId\\": \\"ADB97A33-50E7-48A5-963D-ACBAE36D0BEC\\",\\n \\"VersionStatus\\": \\"Enabled\\",\\n \\"CreateTime\\": \\"2018-12-12T07:36:22.992Z\\",\\n \\"VersionId\\": \\"ve-uf6bwdtvid7o25\\",\\n \\"VersionName\\": \\"5.3.6\\",\\n \\"VersionDescription\\": \\"这是版本描述\\",\\n \\"FlowId\\": \\"lc-uf6wvbsyvvl5sy\\",\\n \\"RegionId\\": \\"cn-shanghai\\"\\n}","type":"json"}]', ], - 'DeleteFlow' => [ - 'summary' => 'Deletes a workflow.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GroupInvokeFlow' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'FlowId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workflow that you want to delete.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'lc-uf6wvbsyvvl5sy', - ], + 'schema' => ['description' => 'The ID of the workflow that you want to execute.'."\n", 'type' => 'string', 'required' => true, 'example' => 'lc-uf6axpwfcw4ubx', 'title' => ''], + ], + [ + 'name' => 'GroupKey', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the group. The name must be unique among the groups.'."\n", 'type' => 'string', 'required' => true, 'example' => '1632117849243', 'title' => ''], + ], + [ + 'name' => 'Data', + 'in' => 'formData', + 'schema' => ['description' => 'The information required by the group execution. Set this parameter to a JSON array of strings in the following format:`{"Items": []}`. Each string provides the information required by one time of execution. The string must use the format of the Data parameter in the InvokeFlow operation.'."\n", 'type' => 'string', 'required' => true, 'example' => '{\\"Items\\":[{\\"resourceId\\":\\"i-bp1383wskmaa65duviwh\\",\\"regionId\\":\\"cn-hangzhou\\",\\"resourceType\\":\\"ACS::ECS::Instance\\"}],\\"Source\\":\\"CloudConfig\\"}', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => true, 'example' => 'abcdefghijklmn', 'title' => ''], + ], + [ + 'name' => 'TotalCount', + 'in' => 'formData', + 'schema' => ['description' => 'The number of times of execution. The value must be the same as the number of strings in the value of the Data parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => ['description' => 'The tag that is attached to each time of execution. The value is a JSON array. The number of tags in the array is the same as the value of the TotalCount parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{\\"key1\\":\\"value1\\",\\"key2\\":\\"value2\\"}]', 'title' => ''], ], ], 'responses' => [ @@ -970,127 +575,158 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the operation was successful. Valid values: **true**: The operation was successful. **false**: The operation failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ADB97A33-50E7-48A5-963D-ACBAE36D0BEC', - ], + 'Status' => ['description' => 'The status of the group. Valid values:'."\n" + ."\n" + .'* New: The group is created and waiting to be executed.'."\n" + .'* Started: The group is being executed.'."\n" + .'* Canceled: The group was canceled.'."\n" + .'* Failed: The execution failed.'."\n" + .'* Completed: All the times of execution in the group are complete.'."\n" + .'* Unknown: The group status is uncertain. In this case, a system error may occur.'."\n" + .'* TimedOut: The execution timed out.'."\n" + .'* Paused: The execution was suspended.'."\n", 'type' => 'string', 'example' => 'Completed', 'title' => ''], + 'GroupInvocationId' => ['description' => 'The unique identifier of the execution.'."\n", 'type' => 'string', 'example' => '7bdbdb58-f028-4155-915e-f21e1f8fc48a', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '4F06F96E-D1F8-54ED-9611-4F621AD899B5', 'title' => ''], + 'CurrentCount' => ['description' => 'The number of times of execution that are pending.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful.'."\n" + ."\n" + .'* **true**: The workflow execution is triggered.'."\n" + .'* **false**: The workflow execution failed to be triggered.'."\n" + ."\n" + .'> : You can call the **GetInvocationLog** operation to check whether the workflow execution is successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"Completed\\",\\n \\"GroupInvocationId\\": \\"7bdbdb58-f028-4155-915e-f21e1f8fc48a\\",\\n \\"RequestId\\": \\"4F06F96E-D1F8-54ED-9611-4F621AD899B5\\",\\n \\"CurrentCount\\": 10,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'GroupInvokeFlow', + 'summary' => 'Triggers a workflow to be executed multiple times.', + 'description' => '* You can call this operation to trigger a workflow to be executed more than 100 times per second. If the desired execution frequency does not exceed 100 times per second, we recommend that you call the InvokeFlow operation.'."\n" + .'* However, you may need to call the GroupInvokeFlow operation multiple times. For example, assume that you want a workflow to be executed 1,000 times per second and the 1,000 times of execution are divided into ten groups. You need to call the operation ten times for the ten groups and specify a group key for each group.'."\n" + .'* Each call corresponds to a group execution. Logic Composer automatically determines when a group execution starts. You must set the Data parameter to a JSON array of strings to specify the information required by the execution. Each string provides the information required by one time of execution. The string must use the format of the Data parameter in the InvokeFlow operation.'."\n", + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'composer:GroupInvokeFlow', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'Flow', 'arn' => 'acs:composer:{#regionId}:{#accountId}:flow/{#FlowId}'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"ADB97A33-50E7-48A5-963D-ACBAE36D0BEC\\"\\n}","type":"json"}]', - 'title' => 'DeleteFlow', - 'description' => 'If you delete a workflow, all version information about the workflow and execution records of the workflow are automatically deleted.'."\n", ], - 'DisableFlow' => [ - 'summary' => 'Disables a workflow. A disabled workflow is not running.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'InvokeFlow' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'FlowId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workflow that you want to disable.'."\n", - 'docRequired' => true, - 'example' => 'lc-uf6pvud38xl0ia', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The workflow ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'lc-uf65sg10vjws7o'], + ], + [ + 'name' => 'Parameters', + 'in' => 'formData', + 'schema' => ['description' => 'The parameters required by the template. The value must be a JSON string.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => '{"ParamA": "test"}'], + ], + [ + 'name' => 'Data', + 'in' => 'formData', + 'schema' => ['description' => 'The input parameters required by the trigger of the workflow. The value must be a JSON string.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => '{"body": {"test": true}}'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'Used for idempotence to avoid duplicate runs.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'abcdefghijklmn'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'example' => 'ADB97A33-50E7-48A5-963D-ACBAE36D0BEC', - 'type' => 'string', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful.'."\n" - ."\n" - .'* **true**: The operation was successful.'."\n" - .'* **false**: The operation failed.'."\n", - 'example' => 'true', - 'type' => 'boolean', - ], - 'FlowStatus' => [ - 'description' => 'The status of the workflow.'."\n" - ."\n" - .'* **Enabled**: The workflow is enabled.'."\n" - .'* **Disabled**: The workflow is disabled.'."\n", - 'example' => 'Disabled', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The ID of this request', 'type' => 'string', 'title' => '', 'example' => '5CE7EAE6-XXXX-XXXX-A1A3-D3C2AE624000'], + 'Success' => ['description' => 'Indicates whether the operation was successful.'."\n" + ."\n" + .'- **true**: The workflow has been triggered'."\n" + .'- **false**: The trigger failed', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'InvocationId' => ['description' => 'The unique ID of the operation.', 'type' => 'string', 'title' => '', 'example' => '6b387696-d160-4ed7-xxxx-070ac29dce4d'], ], - 'type' => 'object', + 'description' => '', + 'title' => '', ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidFlow.NotFound', - 'errorMessage' => 'The specified workflow does not exist. Verify the availability of the workflow.', + 'title' => 'InvokeFlow', + 'summary' => 'Runs a workflow.', + 'changeSet' => [ + ['createdAt' => '2022-11-21T06:29:07.000Z', 'description' => 'Error codes changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'composer:InvokeFlow', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'Flow', 'arn' => 'acs:composer:{#regionId}:{#accountId}:flow/{#FlowId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ADB97A33-50E7-48A5-963D-ACBAE36D0BEC\\",\\n \\"Success\\": true,\\n \\"FlowStatus\\": \\"Disabled\\"\\n}","type":"json"}]', - 'title' => 'DisableFlow', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CE7EAE6-XXXX-XXXX-A1A3-D3C2AE624000\\",\\n \\"Success\\": true,\\n \\"InvocationId\\": \\"6b387696-d160-4ed7-xxxx-070ac29dce4d\\"\\n}","type":"json"}]', ], - 'EnableFlow' => [ - 'summary' => 'Enables a workflow.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListFlows' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'FlowId', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'tp-uf6pvud38xl0ia', - ], + 'schema' => ['description' => 'Specifies the number of workflows to return on each page. A page can contain a maximum of 100 workflows. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number of the current page. Minimum value: 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'FlowName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the workflow.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'Filter', + 'in' => 'formData', + 'schema' => ['description' => 'The filter condition, which is in the JSON format of {"key":"value"}. Example: {"key1":"value1"}'."\n", 'type' => 'string', 'required' => false, 'example' => '{\\"tags\\":[{\\"key\\":\\"acs:lc:Solution:AliyunSSO\\",\\"value\\":\\"test\\"}]}'], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => ['title' => '资源组ID', 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmzy6dzs6qtqa'], ], ], 'responses' => [ @@ -1098,96 +734,111 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ADB97A33-50E7-48A5-963D-ACBAE36D0BEC', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'FlowStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Enabled', + 'TotalCount' => ['description' => 'The total number of workflows in the current region.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'A4865221-E0BC-5AF6-BDD3-749F5A2371CC'], + 'Flows' => [ + 'description' => 'A list of workflows.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Workflow details.'."\n", + 'type' => 'object', + 'properties' => [ + 'UpdateTime' => ['description' => 'The time when the workflow was last updated.'."\n", 'type' => 'string', 'format' => 'iso8601', 'example' => '2019-07-19T05:43:16.783Z'], + 'FlowSource' => ['description' => 'The source of the workflow.'."\n", 'type' => 'string', 'example' => 'Solution'], + 'FlowStatus' => ['description' => 'The status of the workflow. Valid values:'."\n" + ."\n" + .'* **Enabled**: The workflow is enabled.'."\n" + .'* **Disabled**: The workflow is disabled.'."\n", 'type' => 'string', 'example' => 'Enabled'], + 'CreateTime' => ['description' => 'The time when the workflow was created.'."\n", 'type' => 'string', 'format' => 'iso8601', 'example' => '2019-07-19T05:43:16.783Z'], + 'FlowEditMode' => ['description' => 'The edit mode of the workflow.'."\n", 'type' => 'string', 'example' => 'Normal'], + 'VersionId' => ['description' => 'The latest version of the workflow.'."\n", 'type' => 'string', 'example' => '1'], + 'FlowDescription' => ['description' => 'The description of the workflow.'."\n", 'type' => 'string', 'example' => 'test flow'], + 'FlowName' => ['description' => 'The name of the workflow.'."\n", 'type' => 'string', 'example' => 'test'], + 'TemplateId' => ['description' => 'The template ID. You can call the ListTemplates operation to obtain the template ID.'."\n", 'type' => 'string', 'example' => 'tp-uf6lzhzywy28bs'], + 'FlowId' => ['description' => 'The ID of the workflow.'."\n", 'type' => 'string', 'example' => 'lc-uf6axpwfcw4ubx'], + 'RegionId' => ['description' => 'The region to which the workflow belongs.'."\n", 'type' => 'string', 'example' => 'cn-shanghai'], + 'ResourceGroupId' => ['title' => '资源组ID', 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'example' => 'rg-acfmzyxxxxxxx'], + ], + ], ], ], ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidFlow.NotFound', - 'errorMessage' => 'The specified workflow does not exist. Verify the availability of the workflow.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ADB97A33-50E7-48A5-963D-ACBAE36D0BEC\\",\\n \\"Success\\": true,\\n \\"FlowStatus\\": \\"Enabled\\"\\n}","type":"json"}]', - 'title' => 'EnableFlow', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"A4865221-E0BC-5AF6-BDD3-749F5A2371CC\\",\\n \\"Flows\\": [\\n {\\n \\"UpdateTime\\": \\"2019-07-19T05:43:16.783Z\\",\\n \\"FlowSource\\": \\"Solution\\",\\n \\"FlowStatus\\": \\"Enabled\\",\\n \\"CreateTime\\": \\"2019-07-19T05:43:16.783Z\\",\\n \\"FlowEditMode\\": \\"Normal\\",\\n \\"VersionId\\": \\"1\\",\\n \\"FlowDescription\\": \\"test flow\\",\\n \\"FlowName\\": \\"test\\",\\n \\"TemplateId\\": \\"tp-uf6lzhzywy28bs\\",\\n \\"FlowId\\": \\"lc-uf6axpwfcw4ubx\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"ResourceGroupId\\": \\"rg-acfmzyxxxxxxx\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListFlows', + 'summary' => 'Queries all workflows in the current region.', ], - 'UpdateFlow' => [ - 'summary' => 'Updates information about a workflow.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListTagResources' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'FlowId', + 'name' => 'ResourceType', 'in' => 'formData', 'schema' => [ - 'description' => 'The ID of the workflow whose information you want to update.'."\n", + 'description' => 'The resource type definition. Valid values:'."\n" + ."\n" + .'- ALIYUN::LC::FLOW: Logic Composer workflow', 'type' => 'string', 'required' => true, 'docRequired' => true, - 'example' => 'lc-uf6axpwfcw4ubx', + 'enumValueTitles' => ['ALIYUN::LC::FLOW' => '逻辑编排工作流'], + 'title' => '', + 'example' => 'ALIYUN::LC::FLOW', ], ], [ - 'name' => 'FlowName', + 'name' => 'NextToken', 'in' => 'formData', - 'schema' => [ - 'description' => 'The new name that you want to specify for the workflow.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The token that is used to start the next query', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'], ], [ - 'name' => 'FlowDescription', + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => ['description' => 'The maximum number of entries that is returned on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '20'], + ], + [ + 'name' => 'ResourceId', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The new description that you want to specify for the workflow.'."\n", - 'type' => 'string', + 'description' => 'The resource IDs.', + 'type' => 'array', + 'items' => ['description' => 'The resource ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'lc-0xiisfk685vhfk'], 'required' => false, - 'example' => 'This is the description of the workflow.'."\n", + 'maxItems' => 50, + 'title' => '', ], ], [ - 'name' => 'Definition', + 'name' => 'Tag', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The new definition that you want to specify for the workflow.'."\n", - 'type' => 'string', + 'description' => 'The tags to add to the instance. The maximum number of tags is 20.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag content.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'testkey'], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'testvalue'], + ], + 'required' => false, + 'title' => '', + ], 'required' => false, - 'example' => '{\\"schemaVersion\\":\\"2018-12-12\\",\\"actions\\":{},\\"version\\":\\"1.0.0\\",\\"triggers\\":{}}', + 'maxItems' => 20, + 'title' => '', ], ], ], @@ -1196,78 +847,57 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'CurrentVersionId' => [ - 'description' => 'The version ID of the workflow after the update.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => 've-uf6bwdtvid7o25', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ADB97A33-50E7-48A5-963D-ACBAE36D0BEC', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful. Valid values:'."\n" - ."\n" - .'* **true**: The operation was successful.'."\n" - .'* **false**: The operation failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'NextToken' => ['description' => 'The token that is used to start the next query.', 'type' => 'string', 'title' => '', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'C9025B15-16CC-53FB-B7B1-7295AA010EBD'], + 'TotalCount' => ['description' => 'The total number of resources.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2'], + 'TagResources' => [ + 'description' => 'The relationships between the resources and the tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'Resource information', + 'type' => 'object', + 'properties' => [ + 'ResourceType' => ['description' => 'The resource type definition. Valid values:'."\n" + ."\n" + .'- ALIYUN::LC::FLOW: Logic Composer workflow', 'type' => 'string', 'title' => '', 'example' => 'ALIYUN::LC::FLOW'], + 'TagValue' => ['description' => 'The tag value.', 'type' => 'string', 'title' => '', 'example' => 'testvalue'], + 'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'title' => '', 'example' => 'lc-0xiisfk685vhfk'], + 'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'title' => '', 'example' => 'testkey'], + ], + 'title' => '', + ], + 'title' => '', ], ], + 'description' => '', + 'title' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDefinition.Format', - 'errorMessage' => 'The specified workflow definition is incorrectly formatted. It must be valid JSON content.', - ], - [ - 'errorCode' => 'InvalidParameter.Definition', - 'errorMessage' => 'The specified definition is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Description.Length', - 'errorMessage' => 'The specified description cannot be more than 255 characters in length.', - ], - [ - 'errorCode' => 'InvalidParameter.Name', - 'errorMessage' => 'The specified name is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Name.Length', - 'errorMessage' => 'The specified name cannot be more than 100 characters in length.', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation. %s.', - ], - ], - [ - [ - 'errorCode' => 'InvalidFlow.NotFound', - 'errorMessage' => 'The specified workflow does not exist. Verify the availability of the workflow.', + 'title' => 'ListTagResources', + 'summary' => 'Retrieves a list of resources with specified tags.', + 'changeSet' => [ + ['createdAt' => '2022-11-21T06:29:07.000Z', 'description' => 'Error codes changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'composer:ListTagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentVersionId\\": 10,\\n \\"RequestId\\": \\"ADB97A33-50E7-48A5-963D-ACBAE36D0BEC\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateFlow', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"C9025B15-16CC-53FB-B7B1-7295AA010EBD\\",\\n \\"TotalCount\\": 2,\\n \\"TagResources\\": [\\n {\\n \\"ResourceType\\": \\"ALIYUN::LC::FLOW\\",\\n \\"TagValue\\": \\"testvalue\\",\\n \\"ResourceId\\": \\"lc-0xiisfk685vhfk\\",\\n \\"TagKey\\": \\"testkey\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'ListFlows' => [ - 'summary' => 'Queries all workflows in the current region.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListTemplates' => [ + 'summary' => 'Lists the templates visible to the current user.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1275,62 +905,36 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies the number of workflows to return on each page. A page can contain a maximum of 100 workflows. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The page number. The value starts from 1. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number of the current page. Minimum value: 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The number of entries to return on each page. The maximum value is 100 and the default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'FlowName', + 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the workflow.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The keyword used to search for templates. This parameter does not take effect if the Tag parameter is specified.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'Filter', + 'name' => 'Tag', 'in' => 'formData', - 'schema' => [ - 'description' => 'The filter condition, which is in the JSON format of {"key":"value"}. Example: {"key1":"value1"}'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{\\"tags\\":[{\\"key\\":\\"acs:lc:Solution:AliyunSSO\\",\\"value\\":\\"test\\"}]}', - ], + 'schema' => ['description' => 'The tag used to filter templates.', 'type' => 'string', 'required' => false, 'example' => '财务管理', 'title' => ''], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'Lang', 'in' => 'formData', - 'schema' => [ - 'title' => '资源组ID', - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmzy6dzs6qtqa', - ], + 'schema' => ['description' => 'The language of the template. Valid values:'."\n" + ."\n" + .'- **zh**: Chinese'."\n" + ."\n" + .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ @@ -1338,152 +942,87 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of workflows in the current region.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'A4865221-E0BC-5AF6-BDD3-749F5A2371CC', - ], - 'Flows' => [ - 'description' => 'A list of workflows.'."\n", + 'TotalCount' => ['description' => 'The total number of templates.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'ADB97A33-50E7-48A5-963D-ACBAE36D0BEC', 'title' => ''], + 'Templates' => [ + 'description' => 'The list of templates.', 'type' => 'array', 'items' => [ - 'description' => 'Workflow details.'."\n", + 'description' => 'The information about the template.', 'type' => 'object', 'properties' => [ - 'UpdateTime' => [ - 'description' => 'The time when the workflow was last updated.'."\n", - 'type' => 'string', - 'format' => 'iso8601', - 'example' => '2019-07-19T05:43:16.783Z', - ], - 'FlowSource' => [ - 'description' => 'The source of the workflow.'."\n", - 'type' => 'string', - 'example' => 'Solution', - ], - 'FlowStatus' => [ - 'description' => 'The status of the workflow. Valid values:'."\n" - ."\n" - .'* **Enabled**: The workflow is enabled.'."\n" - .'* **Disabled**: The workflow is disabled.'."\n", - 'type' => 'string', - 'example' => 'Enabled', - ], - 'CreateTime' => [ - 'description' => 'The time when the workflow was created.'."\n", - 'type' => 'string', - 'format' => 'iso8601', - 'example' => '2019-07-19T05:43:16.783Z', - ], - 'FlowEditMode' => [ - 'description' => 'The edit mode of the workflow.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'VersionId' => [ - 'description' => 'The latest version of the workflow.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'FlowDescription' => [ - 'description' => 'The description of the workflow.'."\n", - 'type' => 'string', - 'example' => 'test flow', - ], - 'FlowName' => [ - 'description' => 'The name of the workflow.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'TemplateId' => [ - 'description' => 'The template ID. You can call the ListTemplates operation to obtain the template ID.'."\n", - 'type' => 'string', - 'example' => 'tp-uf6lzhzywy28bs', - ], - 'FlowId' => [ - 'description' => 'The ID of the workflow.'."\n", - 'type' => 'string', - 'example' => 'lc-uf6axpwfcw4ubx', - ], - 'RegionId' => [ - 'description' => 'The region to which the workflow belongs.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'ResourceGroupId' => [ - 'title' => '资源组ID', - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'example' => 'rg-acfmzyxxxxxxx', - ], + 'UpdateTime' => ['description' => 'The time when the template was last updated.', 'type' => 'string', 'example' => '2020-08-19T03:31:32.415Z', 'title' => ''], + 'TemplateOverview' => ['description' => 'An overview of the template, which is a JSON string.', 'type' => 'string', 'example' => '[]', 'title' => ''], + 'TemplateConnector' => ['description' => 'A list of connectors that are used in the template. Multiple connectors are separated by commas (,).', 'type' => 'string', 'example' => 'oss,rds', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the template was created.', 'type' => 'string', 'example' => '2020-08-19T03:31:32.415Z', 'title' => ''], + 'TemplateSummaryEn' => ['description' => 'The English summary of the template.', 'type' => 'string', 'example' => 'This is a test template', 'title' => ''], + 'TemplateName' => ['description' => 'The name of the template.', 'type' => 'string', 'example' => '测试模板', 'title' => ''], + 'TemplateVersion' => ['description' => 'The version of the template. The value is a number that increments from 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'TemplateLocale' => ['description' => 'The language of the template. Chinese (zh) and English (en) are supported.', 'type' => 'string', 'example' => 'zh', 'title' => ''], + 'TemplateCreator' => ['description' => 'The publisher of the template.', 'type' => 'string', 'example' => '逻辑编排', 'title' => ''], + 'TemplateDescription' => ['description' => 'The description of the template.', 'type' => 'string', 'example' => '这是一个测试用的模板', 'title' => ''], + 'TemplateTag' => ['description' => 'The tag of the template.', 'type' => 'string', 'example' => 'finance', 'title' => ''], + 'TemplateSummary' => ['description' => 'A brief introduction to the template.', 'type' => 'string', 'example' => '测试模板的简介', 'title' => ''], + 'TemplateId' => ['description' => 'The ID of the template.', 'type' => 'string', 'example' => 'tp-uf6tbvhheciyxl', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 10,\\n \\"RequestId\\": \\"ADB97A33-50E7-48A5-963D-ACBAE36D0BEC\\",\\n \\"Templates\\": [\\n {\\n \\"UpdateTime\\": \\"2020-08-19T03:31:32.415Z\\",\\n \\"TemplateOverview\\": \\"[]\\",\\n \\"TemplateConnector\\": \\"oss,rds\\",\\n \\"CreateTime\\": \\"2020-08-19T03:31:32.415Z\\",\\n \\"TemplateSummaryEn\\": \\"This is a test template\\",\\n \\"TemplateName\\": \\"测试模板\\",\\n \\"TemplateVersion\\": 0,\\n \\"TemplateLocale\\": \\"zh\\",\\n \\"TemplateCreator\\": \\"逻辑编排\\",\\n \\"TemplateDescription\\": \\"这是一个测试用的模板\\",\\n \\"TemplateTag\\": \\"finance\\",\\n \\"TemplateSummary\\": \\"测试模板的简介\\",\\n \\"TemplateId\\": \\"tp-uf6tbvhheciyxl\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListTemplates', + 'changeSet' => [ + ['createdAt' => '2022-11-21T06:29:07.000Z', 'description' => 'Error codes changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'composer:ListTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"A4865221-E0BC-5AF6-BDD3-749F5A2371CC\\",\\n \\"Flows\\": [\\n {\\n \\"UpdateTime\\": \\"2019-07-19T05:43:16.783Z\\",\\n \\"FlowSource\\": \\"Solution\\",\\n \\"FlowStatus\\": \\"Enabled\\",\\n \\"CreateTime\\": \\"2019-07-19T05:43:16.783Z\\",\\n \\"FlowEditMode\\": \\"Normal\\",\\n \\"VersionId\\": \\"1\\",\\n \\"FlowDescription\\": \\"test flow\\",\\n \\"FlowName\\": \\"test\\",\\n \\"TemplateId\\": \\"tp-uf6lzhzywy28bs\\",\\n \\"FlowId\\": \\"lc-uf6axpwfcw4ubx\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"ResourceGroupId\\": \\"rg-acfmzyxxxxxxx\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListFlows', ], 'ListVersions' => [ - 'summary' => 'Queries all versions of a workflow.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'FlowId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workflow whose versions you want to query.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'lc-uf6axpwfcw4ubx', - ], + 'schema' => ['description' => 'The ID of the workflow whose versions you want to query.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'lc-uf6axpwfcw4ubx', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number of the page to return. The value must be an integer that is greater than 0. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number of the page to return. The value must be an integer that is greater than 0. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of versions to return on each page. One page contains a maximum of 100 versions. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of versions to return on each page. One page contains a maximum of 100 versions. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -1491,17 +1030,8 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of versions of the workflow.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ADB97A33-50E7-48A5-963D-ACBAE36D0BEC', - ], + 'TotalCount' => ['description' => 'The total number of versions of the workflow.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'ADB97A33-50E7-48A5-963D-ACBAE36D0BEC', 'title' => ''], 'Versions' => [ 'description' => 'A list of the versions.'."\n", 'type' => 'array', @@ -1509,91 +1039,82 @@ 'description' => 'The details of the version.'."\n", 'type' => 'object', 'properties' => [ - 'UpdateTime' => [ - 'description' => 'The time when the version was last updated.'."\n", - 'type' => 'string', - 'example' => '2018-12-12T07:36:22.992Z', - ], - 'VersionStatus' => [ - 'description' => 'The status of the version. **Enabled** indicates that the version is enabled.'."\n", - 'type' => 'string', - 'example' => 'Enabled', - ], - 'CreateTime' => [ - 'description' => 'The time when the version was created.'."\n", - 'type' => 'string', - 'example' => '2018-12-12T07:36:22.992Z', - ], - 'VersionId' => [ - 'description' => 'The ID of the version.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'VersionNumber' => [ - 'description' => 'The number of the version. Increment from 1.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'FlowId' => [ - 'description' => 'The ID of the workflow to which the version belongs.'."\n", - 'type' => 'string', - 'example' => 'lc-uf6axpwfcw4ubx', - ], - 'VersionName' => [ - 'description' => 'The name of the version.'."\n", - 'type' => 'string', - 'example' => '1', - ], + 'UpdateTime' => ['description' => 'The time when the version was last updated.'."\n", 'type' => 'string', 'example' => '2018-12-12T07:36:22.992Z', 'title' => ''], + 'VersionStatus' => ['description' => 'The status of the version. **Enabled** indicates that the version is enabled.'."\n", 'type' => 'string', 'example' => 'Enabled', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the version was created.'."\n", 'type' => 'string', 'example' => '2018-12-12T07:36:22.992Z', 'title' => ''], + 'VersionId' => ['description' => 'The ID of the version.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'VersionNumber' => ['description' => 'The number of the version. Increment from 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'FlowId' => ['description' => 'The ID of the workflow to which the version belongs.'."\n", 'type' => 'string', 'example' => 'lc-uf6axpwfcw4ubx', 'title' => ''], + 'VersionName' => ['description' => 'The name of the version.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], ], + 'title' => '', ], + 'title' => '', ], ], + 'description' => '', + 'title' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"ADB97A33-50E7-48A5-963D-ACBAE36D0BEC\\",\\n \\"Versions\\": [\\n {\\n \\"UpdateTime\\": \\"2018-12-12T07:36:22.992Z\\",\\n \\"VersionStatus\\": \\"Enabled\\",\\n \\"CreateTime\\": \\"2018-12-12T07:36:22.992Z\\",\\n \\"VersionId\\": \\"ve-uf6bwdtvid7o25\\",\\n \\"VersionNumber\\": 1,\\n \\"FlowId\\": \\"lc-uf6axpwfcw4ubx\\",\\n \\"VersionName\\": \\"1\\"\\n }\\n ]\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"ADB97A33-50E7-48A5-963D-ACBAE36D0BEC\\",\\n \\"Versions\\": [\\n {\\n \\"UpdateTime\\": \\"2018-12-12T07:36:22.992Z\\",\\n \\"VersionStatus\\": \\"Enabled\\",\\n \\"CreateTime\\": \\"2018-12-12T07:36:22.992Z\\",\\n \\"VersionId\\": \\"1\\",\\n \\"VersionNumber\\": 4,\\n \\"FlowId\\": \\"lc-uf6axpwfcw4ubx\\",\\n \\"VersionName\\": \\"1\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'ListVersions', + 'summary' => 'Queries all versions of a workflow.', + 'changeSet' => [], ], - 'GetVersion' => [ - 'summary' => 'Queries the information about a specific version of a workflow.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'TagResources' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'FlowId', + 'name' => 'ResourceType', 'in' => 'formData', + 'schema' => ['description' => 'The type of the resources. Set the value to ALIYUN::LC::FLOW.'."\n" + ."\n" + .'* ALIYUN::LC::FLOW indicates Logic Composer workflows.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ALIYUN::LC::FLOW', 'title' => ''], + ], + [ + 'name' => 'ResourceId', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'Specifies a maximum of 50 resource IDs.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of the resource.'."\n", 'type' => 'string', 'required' => false, 'example' => 'lc-uf6abcdefg', 'title' => ''], 'required' => true, - 'example' => 'lc-uf6axpwfcw4ubx', + 'example' => 'lc-uf6tbvhheciyxl', + 'maxItems' => 50, + 'title' => '', ], ], [ - 'name' => 'VersionId', + 'name' => 'Tag', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'Specifies a list of tags that you want to attach to the resources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the tag.'."\n", 'type' => 'string', 'required' => true, 'example' => 'tagKey', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.'."\n", 'type' => 'string', 'required' => true, 'example' => 'tagValue', 'title' => ''], + ], + 'required' => false, + 'title' => '', + ], 'required' => true, - 'example' => '', + 'maxItems' => 20, + 'title' => '', ], ], ], @@ -1602,96 +1123,92 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Definition' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{\\"schemaVersion\\":\\"2018-12-12\\",\\"actions\\":{},\\"version\\":\\"1.0.0\\",\\"triggers\\":{}}', - ], - 'UpdateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-12-12T07:36:22.992Z', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ADB97A33-50E7-48A5-963D-ACBAE36D0BEC', - ], - 'VersionStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Enabled', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-12-12T07:36:22.992Z', - ], - 'VersionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'VersionName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5.3.6', - ], - 'VersionDescription' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'FlowId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'lc-uf6wvbsyvvl5sy', - ], - 'RegionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-shanghai', - ], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'ADB97A33-50E7-48A5-963D-ACBAE36D0BEC', 'title' => ''], ], + 'description' => '', + 'title' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"ADB97A33-50E7-48A5-963D-ACBAE36D0BEC\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>ADB97A33-50E7-48A5-963D-ACBAE36D0BEC</RequestId>\\n<Success>true</Success>","errorExample":""}]', + 'title' => 'TagResources', + 'summary' => 'Attaches tags to one or more resources.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'composer:TagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Definition\\": \\"{\\\\\\\\\\\\\\"schemaVersion\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2018-12-12\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"actions\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"version\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1.0.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"triggers\\\\\\\\\\\\\\":{}}\\",\\n \\"UpdateTime\\": \\"2018-12-12T07:36:22.992Z\\",\\n \\"RequestId\\": \\"ADB97A33-50E7-48A5-963D-ACBAE36D0BEC\\",\\n \\"VersionStatus\\": \\"Enabled\\",\\n \\"CreateTime\\": \\"2018-12-12T07:36:22.992Z\\",\\n \\"VersionId\\": \\"ve-uf6bwdtvid7o25\\",\\n \\"VersionName\\": \\"5.3.6\\",\\n \\"VersionDescription\\": \\"这是版本描述\\",\\n \\"FlowId\\": \\"lc-uf6wvbsyvvl5sy\\",\\n \\"RegionId\\": \\"cn-shanghai\\"\\n}","type":"json"}]', - 'title' => 'GetVersion', ], - 'GetFlow' => [ - 'summary' => 'Queries information about a workflow.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UntagResources' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'FlowId', + 'name' => 'ResourceType', + 'in' => 'formData', + 'schema' => ['description' => 'The type of the resources. Set the value to ALIYUN::LC::FLOW.'."\n" + ."\n" + .'* ALIYUN::LC::FLOW indicates Logic Composer workflows.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ALIYUN::LC::FLOW', 'title' => ''], + ], + [ + 'name' => 'All', 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to remove all tags from the specified resource groups or members. Valid values:'."\n" + ."\n" + .'* false (default value)'."\n" + .'* true', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'ResourceId', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the workflow.'."\n", - 'type' => 'string', + 'description' => 'Specifies a maximum of 50 resource IDs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the resource.', 'type' => 'string', 'required' => false, 'example' => 'lc-uf6tbvhheciyxl', 'title' => ''], 'required' => true, - 'docRequired' => true, - 'example' => 'lc-uf6pvud38xl0ia', + 'example' => 'lc-uf6tbvhheciyxl', + 'maxItems' => 50, + 'title' => '', + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'An array consisting of the keys of the tags that you want to remove.'."\n", + 'type' => 'array', + 'items' => ['description' => 'A tag key.'."\n" + ."\n" + .'You can specify a maximum of 20 tag keys.'."\n" + ."\n" + .'> If you set the `All` parameter to `true`, you do not need to configure this parameter.', 'type' => 'string', 'required' => false, 'example' => 'testKey', 'title' => ''], + 'required' => false, + 'example' => 'tagKey', + 'maxItems' => 20, + 'title' => '', ], ], ], @@ -1700,160 +1217,66 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'UpdateTime' => [ - 'description' => 'The time when the workflow was last updated.'."\n", - 'type' => 'string', - 'format' => 'iso8601', - 'example' => '2019-07-19T05:43:16.783Z', - ], - 'FlowSource' => [ - 'description' => 'The source of the workflow.'."\n", - 'type' => 'string', - 'example' => 'CloudConfig', - ], - 'CreateTime' => [ - 'description' => 'The time when the workflow was created.'."\n", - 'type' => 'string', - 'format' => 'iso8601', - 'example' => '2019-07-19T05:43:16.783Z', - ], - 'FlowEditMode' => [ - 'description' => 'The edit mode of the workflow.'."\n", - 'type' => 'string', - 'example' => 'Locked', - ], - 'FlowDescription' => [ - 'description' => 'The description of the workflow.'."\n", - 'type' => 'string', - 'example' => 'This is a workflow.'."\n", - ], - 'CurrentVersionId' => [ - 'description' => 'The version ID of the workflow.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'FlowName' => [ - 'description' => 'The name of the workflow.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'FlowId' => [ - 'description' => 'The ID of the workflow.'."\n", - 'type' => 'string', - 'example' => 'lc-uf6pvud38xl0ia', - ], - 'RegionId' => [ - 'description' => 'The ID of the region where the workflow resides.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'Definition' => [ - 'description' => 'The definition of the workflow.'."\n", - 'type' => 'string', - 'example' => '{\\"schemaVersion\\":\\"2018-12-12\\",\\"actions\\":{},\\"version\\":\\"1.0.0\\",\\"triggers\\":{}}', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ADB97A33-50E7-48A5-963D-ACBAE36D0BEC', - ], - 'FlowStatus' => [ - 'description' => 'The status of the workflow. Valid values:'."\n" - ."\n" - .'* **Enabled**: The workflow is enabled.'."\n" - .'* **Disabled**: The workflow is disabled.'."\n", - 'type' => 'string', - 'example' => 'Enabled', - ], - 'TemplateId' => [ - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => 'tp-uf6tbvhheciyxl', - ], - 'ResourceGroupId' => [ - 'title' => '资源组ID', - 'description' => 'The resource group ID.', - 'type' => 'string', - 'example' => 'rg-acfmzyxxxxxxx', - ], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'ADB97A33-50E7-48A5-963D-ACBAE36D0BEC', 'title' => ''], ], + 'description' => '', + 'title' => '', ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidFlow.NotFound', - 'errorMessage' => 'The specified workflow does not exist. Verify the availability of the workflow.', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"ADB97A33-50E7-48A5-963D-ACBAE36D0BEC\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>ADB97A33-50E7-48A5-963D-ACBAE36D0BEC</RequestId>\\n<Success>true</Success>","errorExample":""}]', + 'title' => 'UntagResources', + 'summary' => 'Removes tags from one or more resources.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'composer:UntagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"UpdateTime\\": \\"2019-07-19T05:43:16.783Z\\",\\n \\"FlowSource\\": \\"CloudConfig\\",\\n \\"CreateTime\\": \\"2019-07-19T05:43:16.783Z\\",\\n \\"FlowEditMode\\": \\"Locked\\",\\n \\"FlowDescription\\": \\"这是一个工作流\\",\\n \\"CurrentVersionId\\": \\"ve-uf6bwdtvid7o25\\",\\n \\"FlowName\\": \\"test\\",\\n \\"FlowId\\": \\"lc-uf6pvud38xl0ia\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"Definition\\": \\"{\\\\\\\\\\\\\\"schemaVersion\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2018-12-12\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"actions\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"version\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1.0.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"triggers\\\\\\\\\\\\\\":{}}\\",\\n \\"RequestId\\": \\"ADB97A33-50E7-48A5-963D-ACBAE36D0BEC\\",\\n \\"FlowStatus\\": \\"Enabled\\",\\n \\"TemplateId\\": \\"tp-uf6tbvhheciyxl\\",\\n \\"ResourceGroupId\\": \\"rg-acfmzyxxxxxxx\\"\\n}","type":"json"}]', - 'title' => 'GetFlow', ], - 'InvokeFlow' => [ - 'summary' => 'Runs a workflow.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateFlow' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'FlowId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '', - ], + 'schema' => ['description' => 'The ID of the workflow whose information you want to update.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'lc-uf6axpwfcw4ubx', 'title' => ''], ], [ - 'name' => 'Parameters', + 'name' => 'FlowName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '{"ParamA": "test"}', - ], + 'schema' => ['description' => 'The new name that you want to specify for the workflow.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'Data', + 'name' => 'FlowDescription', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '{"body": {"test": true}}', - ], + 'schema' => ['description' => 'The new description that you want to specify for the workflow.'."\n", 'type' => 'string', 'required' => false, 'example' => 'This is the description of the workflow.'."\n", 'title' => ''], ], [ - 'name' => 'ClientToken', + 'name' => 'Definition', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'abcdefghijklmn', - ], + 'schema' => ['description' => 'The new definition that you want to specify for the workflow.'."\n", 'type' => 'string', 'required' => false, 'example' => '{\\"schemaVersion\\":\\"2018-12-12\\",\\"actions\\":{},\\"version\\":\\"1.0.0\\",\\"triggers\\":{}}', 'title' => ''], ], ], 'responses' => [ @@ -1861,183 +1284,333 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5CE7EAE6-XXXX-XXXX-A1A3-D3C2AE624000', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'InvocationId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6b387696-d160-4ed7-xxxx-070ac29dce4d', - ], + 'CurrentVersionId' => ['description' => 'The version ID of the workflow after the update.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => 've-uf6bwdtvid7o25', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'ADB97A33-50E7-48A5-963D-ACBAE36D0BEC', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'* **true**: The operation was successful.'."\n" + .'* **false**: The operation failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidDefinition.Format', 'errorMessage' => 'The specified workflow definition is incorrectly formatted. It must be valid JSON content.', 'description' => 'The content of the workflow is invalid. The content must be in the JSON format.'], + ['errorCode' => 'InvalidParameter.Definition', 'errorMessage' => 'The specified definition is invalid.', 'description' => 'The specified definition is invalid.'], + ['errorCode' => 'InvalidParameter.Description.Length', 'errorMessage' => 'The specified description cannot be more than 255 characters in length.', 'description' => 'The specified description cannot be more than 255 characters in length.'], + ['errorCode' => 'InvalidParameter.Name', 'errorMessage' => 'The specified name is invalid.', 'description' => 'The specified name is invalid.'], + ['errorCode' => 'InvalidParameter.Name.Length', 'errorMessage' => 'The specified name cannot be more than 100 characters in length.', 'description' => 'The specified name cannot be more than 100 characters in length.'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation. %s.', 'description' => 'You are not authorized to perform this operation.'], + ], + [ + ['errorCode' => 'InvalidFlow.NotFound', 'errorMessage' => 'The specified workflow does not exist. Verify the availability of the workflow.', 'description' => 'The specified workflow does not exist. Make sure the workflow is available.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentVersionId\\": 0,\\n \\"RequestId\\": \\"ADB97A33-50E7-48A5-963D-ACBAE36D0BEC\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateFlow', + 'summary' => 'Updates information about a workflow.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'composer:UpdateFlow', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'Flow', 'arn' => 'acs:composer:{#regionId}:{#accountId}:flow/{#FlowId}'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CE7EAE6-XXXX-XXXX-A1A3-D3C2AE624000\\",\\n \\"Success\\": true,\\n \\"InvocationId\\": \\"6b387696-d160-4ed7-xxxx-070ac29dce4d\\"\\n}","type":"json"}]', - 'title' => 'InvokeFlow', ], - 'GroupInvokeFlow' => [ - 'summary' => 'Triggers a workflow to be executed multiple times.', - 'methods' => [ - 'post', - 'get', + ], + 'endpoints' => [ + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'composer.ap-southeast-1.aliyuncs.com', 'endpoint' => 'composer.ap-southeast-1.aliyuncs.com', 'vpc' => 'composer-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'composer.cn-hangzhou.aliyuncs.com', 'endpoint' => 'composer.cn-hangzhou.aliyuncs.com', 'vpc' => 'composer-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'composer.cn-shanghai.aliyuncs.com', 'endpoint' => 'composer.cn-shanghai.aliyuncs.com', 'vpc' => 'composer-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'composer.us-east-1.aliyuncs.com', 'endpoint' => 'composer.us-east-1.aliyuncs.com', 'vpc' => 'composer-vpc.us-east-1.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'DeployError', 'message' => 'An error occurred while publishing the workflow.', 'http_code' => 500, 'description' => 'An error occurred while publishing the workflow.'], + ['code' => 'FlowNameIsExist', 'message' => 'The specified name already exists.', 'http_code' => 400, 'description' => 'The name already exists.'], + ['code' => 'FlowNotExist', 'message' => 'The specified workflow does not exist.', 'http_code' => 404, 'description' => 'The specified workflow does not exist.'], + ['code' => 'InvalidDefinition.Format', 'message' => 'The specified workflow definition is incorrectly formatted. It must be valid JSON content.', 'http_code' => 400, 'description' => 'The content of the workflow is invalid. The content must be in the JSON format.'], + ['code' => 'InvalidFlow.NotFound', 'message' => 'The specified workflow does not exist. Verify the availability of the workflow.', 'http_code' => 404, 'description' => 'The specified workflow does not exist. Make sure the workflow is available.'], + ['code' => 'InvalidParameter.Definition', 'message' => 'The specified definition is invalid.', 'http_code' => 400, 'description' => 'The specified definition is invalid.'], + ['code' => 'InvalidParameter.Description.Length', 'message' => 'The specified description cannot be more than 255 characters in length.', 'http_code' => 400, 'description' => 'The specified description cannot be more than 255 characters in length.'], + ['code' => 'InvalidParameter.Name', 'message' => 'The specified name is invalid.', 'http_code' => 400, 'description' => 'The specified name is invalid.'], + ['code' => 'InvalidParameter.Name.Length', 'message' => 'The specified name cannot be more than 100 characters in length.', 'http_code' => 400, 'description' => 'The specified name cannot be more than 100 characters in length.'], + ['code' => 'InvocationFailed', 'message' => 'An error occurred while running the workflow. Check the error log entry in the console.', 'http_code' => 502, 'description' => 'The workflow fails to be executed. To view error logs, go to the Logic Composer console.'], + ['code' => 'MissingParameter.%s', 'message' => 'You must specify the %s parameter.', 'http_code' => 400, 'description' => 'You must specify the parameter.'], + ['code' => 'NoPermission', 'message' => 'You are not authorized to perform this operation. %s.', 'http_code' => 403, 'description' => 'You are not authorized to perform this operation.'], + ['code' => 'TemplateNotExist', 'message' => 'The specified template does not exist.', 'http_code' => 404, 'description' => 'The specified template does not exist.'], + ['code' => 'VersionNotExist', 'message' => 'The specified version does not exist.', 'http_code' => 404, 'description' => 'The specified version does not exist.'], + ], + 'changeSet' => [], + 'ram' => [ + 'productCode' => 'LC', + 'productName' => 'Logic Composer', + 'ramCodes' => ['composer'], + 'ramLevel' => 'RESOURCE', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'CloneFlow', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'composer:CloneFlow', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'Flow', 'arn' => 'acs:composer:{#regionId}:{#accountId}:flow/{#FlowId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'GetVersion', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'composer:GetVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'Flow', 'arn' => 'acs:composer:{#regionId}:{#accountId}:flow/{#FlowId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListFlows', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'composer:ListFlows', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'Flow', 'arn' => 'acs:composer:{#regionId}:{#accountId}:flow/*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'FlowId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workflow that you want to execute.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'lc-uf6axpwfcw4ubx', + [ + 'apiName' => 'InvokeFlow', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'composer:InvokeFlow', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'Flow', 'arn' => 'acs:composer:{#regionId}:{#accountId}:flow/{#FlowId}'], ], ], - [ - 'name' => 'GroupKey', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the group. The name must be unique among the groups.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1632117849243', + ], + [ + 'apiName' => 'ListTemplates', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'composer:ListTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Data', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The information required by the group execution. Set this parameter to a JSON array of strings in the following format:`{"Items": []}`. Each string provides the information required by one time of execution. The string must use the format of the Data parameter in the InvokeFlow operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{\\"Items\\":[{\\"resourceId\\":\\"i-bp1383wskmaa65duviwh\\",\\"regionId\\":\\"cn-hangzhou\\",\\"resourceType\\":\\"ACS::ECS::Instance\\"}],\\"Source\\":\\"CloudConfig\\"}', + ], + [ + 'apiName' => 'CreateFlow', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'composer:CreateFlow', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'Flow', 'arn' => 'acs:composer:{#regionId}:{#accountId}:flow/*'], ], ], - [ - 'name' => 'ClientToken', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'abcdefghijklmn', + ], + [ + 'apiName' => 'UpdateFlow', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'composer:UpdateFlow', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'Flow', 'arn' => 'acs:composer:{#regionId}:{#accountId}:flow/{#FlowId}'], ], ], - [ - 'name' => 'TotalCount', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of times of execution. The value must be the same as the number of strings in the value of the Data parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '1000', - 'minimum' => '1', - 'example' => '1', + ], + [ + 'apiName' => 'GetTemplate', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'composer:GetTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Tags', - 'in' => 'query', - 'schema' => [ - 'description' => 'The tag that is attached to each time of execution. The value is a JSON array. The number of tags in the array is the same as the value of the TotalCount parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{\\"key1\\":\\"value1\\",\\"key2\\":\\"value2\\"}]', + ], + [ + 'apiName' => 'EnableFlow', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'composer:EnableFlow', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'Flow', 'arn' => 'acs:composer:{#regionId}:{#accountId}:flow/{#FlowId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the group. Valid values:'."\n" - ."\n" - .'* New: The group is created and waiting to be executed.'."\n" - .'* Started: The group is being executed.'."\n" - .'* Canceled: The group was canceled.'."\n" - .'* Failed: The execution failed.'."\n" - .'* Completed: All the times of execution in the group are complete.'."\n" - .'* Unknown: The group status is uncertain. In this case, a system error may occur.'."\n" - .'* TimedOut: The execution timed out.'."\n" - .'* Paused: The execution was suspended.'."\n", - 'type' => 'string', - 'example' => 'Completed', - ], - 'GroupInvocationId' => [ - 'description' => 'The unique identifier of the execution.'."\n", - 'type' => 'string', - 'example' => '7bdbdb58-f028-4155-915e-f21e1f8fc48a', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '4F06F96E-D1F8-54ED-9611-4F621AD899B5', - ], - 'CurrentCount' => [ - 'description' => 'The number of times of execution that are pending.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful.'."\n" - ."\n" - .'* **true**: The workflow execution is triggered.'."\n" - .'* **false**: The workflow execution failed to be triggered.'."\n" - ."\n" - .'> : You can call the **GetInvocationLog** operation to check whether the workflow execution is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], + [ + 'apiName' => 'TagResources', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'composer:TagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetFlow', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'composer:GetFlow', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'Flow', 'arn' => 'acs:composer:{#regionId}:{#accountId}:flow/{#FlowId}'], + ], + ], + ], + [ + 'apiName' => 'ListVersions', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'composer:ListVersions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListTagResources', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'composer:ListTagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UntagResources', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'composer:UntagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteFlow', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'composer:DeleteFlow', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'Flow', 'arn' => 'acs:composer:{#regionId}:{#accountId}:flow/{#FlowId}'], + ], + ], + ], + [ + 'apiName' => 'DisableFlow', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'composer:DisableFlow', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'Flow', 'arn' => 'acs:composer:{#regionId}:{#accountId}:flow/{#FlowId}'], + ], + ], + ], + [ + 'apiName' => 'InvokeDefinition', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'composer:InvokeDefinition', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ChangeResourceGroup', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'composer:ChangeResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GroupInvokeFlow', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'composer:GroupInvokeFlow', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LC', 'resourceType' => 'Flow', 'arn' => 'acs:composer:{#regionId}:{#accountId}:flow/{#FlowId}'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"Completed\\",\\n \\"GroupInvocationId\\": \\"7bdbdb58-f028-4155-915e-f21e1f8fc48a\\",\\n \\"RequestId\\": \\"4F06F96E-D1F8-54ED-9611-4F621AD899B5\\",\\n \\"CurrentCount\\": 10,\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'GroupInvokeFlow', - 'description' => '* You can call this operation to trigger a workflow to be executed more than 100 times per second. If the desired execution frequency does not exceed 100 times per second, we recommend that you call the InvokeFlow operation.'."\n" - .'* However, you may need to call the GroupInvokeFlow operation multiple times. For example, assume that you want a workflow to be executed 1,000 times per second and the 1,000 times of execution are divided into ten groups. You need to call the operation ten times for the ten groups and specify a group key for each group.'."\n" - .'* Each call corresponds to a group execution. Logic Composer automatically determines when a group execution starts. You must set the Data parameter to a JSON array of strings to specify the information required by the execution. Each string provides the information required by one time of execution. The string must use the format of the Data parameter in the InvokeFlow operation.'."\n", - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'composer.cn-hangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'composer.cn-shanghai.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'composer.ap-southeast-1.aliyuncs.com', ], - [ - 'regionId' => 'us-east-1', - 'endpoint' => 'composer.us-east-1.aliyuncs.com', + 'resourceTypes' => [ + ['validationType' => 'always', 'resourceType' => 'Flow', 'arn' => 'acs:composer:{#regionId}:{#accountId}:flow/{#FlowId}'], + ['validationType' => 'always', 'resourceType' => 'Flow', 'arn' => 'acs:composer:{#regionId}:{#accountId}:flow/*'], ], ], ]; |