diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/composer/2018-12-12 | |
| download | acs-metadata-full-main.tar.gz acs-metadata-full-main.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/composer/2018-12-12')
| -rw-r--r-- | data/en_us/composer/2018-12-12/api-docs.php | 2043 |
1 files changed, 2043 insertions, 0 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 new file mode 100644 index 0000000..6a3cfba --- /dev/null +++ b/data/en_us/composer/2018-12-12/api-docs.php @@ -0,0 +1,2043 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'composer', + 'version' => '2018-12-12', + ], + 'directories' => [ + [ + 'id' => 74102, + 'title' => 'Tag', + 'type' => 'directory', + 'children' => [ + 'TagResources', + 'UntagResources', + 'ListTagResources', + ], + ], + [ + 'id' => 74106, + 'title' => 'Template', + 'type' => 'directory', + 'children' => [ + 'GetTemplate', + 'ListTemplates', + ], + ], + [ + 'id' => 74109, + 'title' => 'Workflow', + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + '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', + ], + ], + [ + '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', + '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, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'ResourceId', + '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, + ], + ], + [ + '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', + ], + 'required' => false, + 'example' => 'tagKey', + 'maxItems' => 20, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListTagResources' => [ + 'summary' => 'Queries a list of resources of a specified tag.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'ALIYUN::LC::FLOW' => '', + ], + 'example' => 'ALIYUN::LC::FLOW', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'lc-0xiisfk685vhfk', + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'Tag', + '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, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'tp-uf6tbvhheciyxl', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + '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', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'create', + ], + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidFlow.NotFound', + 'errorMessage' => 'The specified workflow does not exist. Verify the availability of the workflow.', + ], + ], + ], + '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", + ], + 'DeleteFlow' => [ + 'summary' => 'Deletes a workflow.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + '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', + ], + ], + ], + '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', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'ADB97A33-50E7-48A5-963D-ACBAE36D0BEC', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + ], + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + 'type' => 'object', + ], + ], + ], + '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\\": \\"Disabled\\"\\n}","type":"json"}]', + 'title' => 'DisableFlow', + ], + 'EnableFlow' => [ + 'summary' => 'Enables a workflow.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'FlowId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'tp-uf6pvud38xl0ia', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + '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', + ], + 'UpdateFlow' => [ + 'summary' => 'Updates information about a workflow.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'FlowId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the workflow whose information you want to update.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'lc-uf6axpwfcw4ubx', + ], + ], + [ + 'name' => 'FlowName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The new name that you want to specify for the workflow.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'FlowDescription', + 'in' => 'formData', + '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", + ], + ], + [ + 'name' => 'Definition', + 'in' => 'formData', + '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\\":{}}', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentVersionId\\": 10,\\n \\"RequestId\\": \\"ADB97A33-50E7-48A5-963D-ACBAE36D0BEC\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateFlow', + ], + 'ListFlows' => [ + 'summary' => 'Queries all workflows in the current region.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + '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', + ], + ], + [ + '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' => [ + 200 => [ + '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", + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + 'Versions' => [ + 'description' => 'A list of the versions.'."\n", + 'type' => 'array', + 'items' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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"}]', + 'title' => 'ListVersions', + ], + 'GetVersion' => [ + 'summary' => 'Queries the information about a specific version of a workflow.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'FlowId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'lc-uf6axpwfcw4ubx', + ], + ], + [ + 'name' => 'VersionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'FlowId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the workflow.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'lc-uf6pvud38xl0ia', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidFlow.NotFound', + 'errorMessage' => 'The specified workflow does not exist. Verify the availability of the workflow.', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'FlowId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '{"ParamA": "test"}', + ], + ], + [ + 'name' => 'Data', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '{"body": {"test": true}}', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'abcdefghijklmn', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + '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', + ], + ], + [ + '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', + ], + ], + [ + '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\\"}', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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\\"}]', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + ], +]; |