diff options
Diffstat (limited to 'data/en_us/bpstudio/2021-09-31/api-docs.php')
| -rw-r--r-- | data/en_us/bpstudio/2021-09-31/api-docs.php | 5919 |
1 files changed, 5919 insertions, 0 deletions
diff --git a/data/en_us/bpstudio/2021-09-31/api-docs.php b/data/en_us/bpstudio/2021-09-31/api-docs.php new file mode 100644 index 0000000..604f39f --- /dev/null +++ b/data/en_us/bpstudio/2021-09-31/api-docs.php @@ -0,0 +1,5919 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'BPStudio', + 'version' => '2021-09-31', + ], + 'directories' => [ + [ + 'id' => 356458, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetToken', + ], + ], + [ + 'id' => 356460, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetTemplate', + 'ListTemplate', + 'ValuateTemplate', + 'GetLinkageAttributesTemplate', + ], + ], + [ + 'id' => 356465, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetApplicationVariables', + 'ReConfigApplication', + 'GetApplicationVariables4Fail', + 'CreateApplication', + 'DeleteApplication', + 'GetApplication', + 'ListApplication', + 'DeployApplication', + 'ReleaseApplication', + 'ValidateApplication', + 'ValuateApplication', + 'GetResource4ModifyRecord', + 'GetResult4QueryInstancePrice4Modify', + 'ModifyApplicationSpec', + 'QueryInstancePrice4Modify', + 'QueryInstanceSpec4Modify', + ], + ], + [ + 'id' => 356482, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ExecuteOperationSync', + 'ExecuteOperationASync', + 'GetExecuteOperationResult', + 'ListServices', + 'ListOperations', + 'GetOperationParams', + ], + ], + [ + 'id' => 356489, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ChangeResourceGroup', + ], + ], + [ + 'id' => 356491, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'AppFailOver', + 'GetPotentialFailZones', + 'GetFoTaskStatus', + 'AppFailBack', + 'ListFoCreatedApps', + 'InitAppFailOver', + ], + ], + [ + 'id' => 356498, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListTagResources', + 'ExecuteTask', + 'CreateTask', + 'GetTask', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'GetToken' => [ + 'summary' => 'Obtains a temporary token that is used to read the architecture diagram. The validity period of the token is 30 minutes.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '91666', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioCGSK4A', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源组ID', + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekzhfgmw4e6fwq', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', + ], + 'Data' => [ + 'description' => 'The information about the token.'."\n", + 'type' => 'object', + 'properties' => [ + 'SecurityToken' => [ + 'title' => 'oss访问token', + 'description' => 'The token that is used to access the Object Storage Service (OSS) bucket that stores the architecture image.'."\n", + 'type' => 'string', + 'example' => 'ABCD', + ], + 'Endpoint' => [ + 'title' => 'oss的endpoint', + 'description' => 'The OSS endpoint.'."\n", + 'type' => 'string', + 'example' => 'https://oss-cn-beijing.aliyuncs.com', + ], + 'AccessKeySecret' => [ + 'title' => 'oss访问access key secret id', + 'description' => 'The AccessKey secret used to access OSS.'."\n", + 'type' => 'string', + 'example' => '9NG*****K4X', + ], + 'AccessKeyId' => [ + 'title' => 'oss访问access key id', + 'description' => 'The AccessKey ID that is used to access OSS.'."\n", + 'type' => 'string', + 'example' => 'STS.NTm*****8tu', + ], + 'Bucket' => [ + 'title' => 'oss文件保存bucket位置', + 'description' => 'The OSS bucket that is used to store the architecture image.'."\n", + 'type' => 'string', + 'example' => 'bucket-1', + ], + 'SnapshotBucket' => [ + 'title' => 'oss快照保存bucket位置', + 'description' => 'The OSS bucket that is used to save data snapshots.'."\n", + 'type' => 'string', + 'example' => 'bucket-2', + ], + ], + ], + 'Code' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'string', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'Success', + 'errorMessage' => 'The transaction is successful.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServiceError', + 'errorMessage' => 'A server error occurred. Please try again later.', + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'BPStudio::2021-09-31::GetApplication', + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Data\\": {\\n \\"SecurityToken\\": \\"ABCD\\",\\n \\"Endpoint\\": \\"https://oss-cn-beijing.aliyuncs.com\\",\\n \\"AccessKeySecret\\": \\"9NG*****K4X\\",\\n \\"AccessKeyId\\": \\"STS.NTm*****8tu\\",\\n \\"Bucket\\": \\"bucket-1\\",\\n \\"SnapshotBucket\\": \\"bucket-2\\"\\n },\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<GetTokenResponse>\\n <Message>Success</Message>\\n <RequestId>A07FFDF2-78FA-1B48-9E38-88E833A93187</RequestId>\\n <Data>\\n <SecurityToken>ABCD</SecurityToken>\\n <Endpoint>https://oss-cn-beijing.aliyuncs.com</Endpoint>\\n <AccessKeySecret>9NG*****K4X</AccessKeySecret>\\n <AccessKeyId>STS.NTm*****8tu</AccessKeyId>\\n <Bucket>bucket-1</Bucket>\\n <SnapshotBucket>bucket-2</SnapshotBucket>\\n </Data>\\n <Code>200</Code>\\n</GetTokenResponse>","errorExample":""}]', + 'title' => 'GetToken', + 'description' => '><danger> This API is no longer recommended, and the image related to the Application has included access authorization in the GetApplication property.></danger>', + ], + 'GetTemplate' => [ + 'summary' => 'Gets template images and information about architecture diagrams.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '91665', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioJLICAE', + 'FEATUREbpstudio3E4W4L', + ], + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Template ID', + 'type' => 'string', + 'required' => true, + 'example' => 'XFKR6WYRVS24S07R', + ], + ], + [ + 'name' => 'Region', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Template Area', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'ResourceGroup ID', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekzhfgmw4e6fwq', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The interface returns information', + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', + ], + 'Data' => [ + 'description' => 'The details of the template.'."\n", + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => 'Template Description', + 'type' => 'string', + 'example' => 'remark', + ], + 'ImageURL' => [ + 'description' => 'The path to the template schema image file', + 'type' => 'string', + 'example' => 'bp-studio-template/sr-U37UD2YQCRJ75X5V.png', + ], + 'Name' => [ + 'description' => 'The name of the template', + 'type' => 'string', + 'example' => 'cadt-template', + ], + 'TemplateId' => [ + 'description' => 'Template ID', + 'type' => 'string', + 'example' => 'XFKR6WYRVS24S07R', + ], + 'CreateTime' => [ + 'description' => 'The time when the template was created.'."\n", + 'type' => 'string', + 'example' => '2020-09-22 17:08:31', + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'example' => 'rg-aekzhfgmw4e6fwq', + ], + 'Variables' => [ + 'description' => 'The details of the template variables.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Attribute' => [ + 'title' => '变量名', + 'description' => 'The name of the variable.'."\n", + 'type' => 'string', + 'example' => 'instance_name', + ], + 'DataType' => [ + 'title' => '变量类型', + 'description' => 'The type of the variable.'."\n", + 'type' => 'string', + 'example' => 'String', + ], + 'DefaultValue' => [ + 'title' => '默认值', + 'description' => 'The default value of the variable.'."\n", + 'type' => 'string', + 'example' => 'cadt-app-01', + ], + 'Variable' => [ + 'title' => '变量值', + 'description' => 'The value of the variable.'."\n", + 'type' => 'string', + 'example' => '${name}', + ], + 'Options' => [ + 'type' => 'string', + ], + ], + ], + ], + 'DocumentUrl' => [ + 'type' => 'string', + ], + ], + ], + 'Code' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'string', + 'format' => 'int32', + 'example' => '200', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'Success', + 'errorMessage' => 'The transaction is successful.', + ], + ], + 400 => [ + [ + 'errorCode' => 'ParameterEmpty', + 'errorMessage' => 'You must specify the request parameter.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExist.ResourceGroup', + 'errorMessage' => 'The resource group does not exist.', + ], + [ + 'errorCode' => 'EntityNotExist.ResourceId', + 'errorMessage' => 'The resource does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServiceError', + 'errorMessage' => 'A server error occurred. Please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Data\\": {\\n \\"Description\\": \\"\\",\\n \\"ImageURL\\": \\"bp-studio-template/sr-U37UD2YQCRJ75X5V.png\\",\\n \\"Name\\": \\"cadt-template\\",\\n \\"TemplateId\\": \\"XFKR6WYRVS24S07R\\",\\n \\"CreateTime\\": \\"2020-09-22 17:08:31\\",\\n \\"ResourceGroupId\\": \\"rg-aekzhfgmw4e6fwq\\",\\n \\"Variables\\": [\\n {\\n \\"Attribute\\": \\"instance_name\\",\\n \\"DataType\\": \\"String\\",\\n \\"DefaultValue\\": \\"cadt-app-01\\",\\n \\"Variable\\": \\"${name}\\",\\n \\"Options\\": \\"\\"\\n }\\n ],\\n \\"DocumentUrl\\": \\"\\"\\n },\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<GetTemplateResponse>\\n <Message>Success</Message>\\n <RequestId>A07FFDF2-78FA-1B48-9E38-88E833A93187</RequestId>\\n <Data>\\n <Description>无</Description>\\n <ImageURL>bp-studio-template/sr-U37UD2YQCRJ75X5V.png</ImageURL>\\n <Name>cadt-template</Name>\\n <TopoURL>bp-studio-template/topo-0RJH9V408JV6MIT9.json</TopoURL>\\n <TemplateId>XFKR6WYRVS24S07R</TemplateId>\\n <CreateTime>2020-09-22 17:08:31</CreateTime>\\n <ResourceGroupId>rg-aekzhfgmw4e6fwq</ResourceGroupId>\\n </Data>\\n <Code>200</Code>\\n</GetTemplateResponse>","errorExample":""}]', + 'title' => 'GetTemplate', + ], + 'ListTemplate' => [ + 'summary' => 'Queries templates, including information such as the template name, architecture image URL, and URL of the serialized architecture image file.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '91668', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioRJ9IF1', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '50', + 'exclusiveMaximum' => false, + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'formData', + 'schema' => [ + 'title' => '排序字段', + 'description' => 'The criterion by which the returned templates are sorted. Valid values:'."\n" + ."\n" + .'* 1: The templates are sorted by the time when they are updated.'."\n" + .'* 2: The templates are sorted by the time when they are created.'."\n" + .'* 3: The templates are sorted by the system.'."\n" + .'* 4: The templates are sorted by the number of times that they are used.'."\n" + .'* If you specify an integer other than 1, 2, 3, and 4 or do not specify any value, the templates are sorted by the system.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '5', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'formData', + 'schema' => [ + 'title' => '搜索关键字', + 'description' => 'The keyword that is used to search for templates.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cadt', + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'title' => '类型', + 'description' => 'The type of the templates to be returned. Valid values: public and private'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'public'."\n", + ], + ], + [ + 'name' => 'TagList', + 'in' => 'formData', + 'schema' => [ + 'title' => '模板的标签', + 'description' => 'The tag that you want to use to query templates.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '1'."\n", + 'deprecated' => true, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyjt3c5om3hi', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'type' => 'string', + ], + 'Value' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'NextToken' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', + ], + 'Data' => [ + 'description' => 'The details about templates.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ImageURL' => [ + 'title' => '模板的图片链接', + 'description' => 'The URL of the architecture image.'."\n", + 'type' => 'string', + 'example' => 'bp-studio-template/sr-U37UD2YQCRJ75X5V.png', + ], + 'TagId' => [ + 'title' => '模板的标签的ID', + 'description' => 'The ID of the tag that is added to the template.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'deprecated' => true, + ], + 'TagName' => [ + 'title' => '模板标签的名称', + 'description' => 'The name of the tag that is added to the template.'."\n", + 'type' => 'string', + 'example' => 'Official template'."\n", + 'deprecated' => true, + ], + 'Name' => [ + 'title' => '模板的名称', + 'description' => 'The name of the template.'."\n", + 'type' => 'string', + 'example' => 'cadt-name', + ], + 'TemplateId' => [ + 'title' => '模板的ID', + 'description' => 'The ID of the template.'."\n", + 'type' => 'string', + 'example' => 'CJQ6H0XUEQ20IYJQ', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => 'The time when the template was created.'."\n", + 'type' => 'string', + 'example' => '2021-03-18 16:41:31', + ], + 'ResourceGroupId' => [ + 'title' => '资源组ID', + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'example' => 'rg-acfmyjt3c5om3hi', + ], + 'Tag' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'type' => 'string', + ], + 'Value' => [ + 'type' => 'string', + ], + ], + ], + ], + 'Description' => [ + 'type' => 'string', + ], + 'DocumentUrl' => [ + 'type' => 'string', + ], + ], + ], + ], + 'Code' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'string', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'Success', + 'errorMessage' => 'The transaction is successful.', + ], + ], + 400 => [ + [ + 'errorCode' => 'ParameterEmpty', + 'errorMessage' => 'You must specify the request parameter.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExist.ResourceId', + 'errorMessage' => 'The resource does not exist.', + ], + [ + 'errorCode' => 'EntityNotExist.ResourceGroup', + 'errorMessage' => 'The resource group does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServiceError', + 'errorMessage' => 'A server error occurred. Please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 100,\\n \\"Message\\": \\"Success\\",\\n \\"NextToken\\": 1,\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Data\\": [\\n {\\n \\"ImageURL\\": \\"bp-studio-template/sr-U37UD2YQCRJ75X5V.png\\",\\n \\"TagId\\": 1,\\n \\"TagName\\": \\"TagName\\",\\n \\"Name\\": \\"cadt-name\\",\\n \\"TemplateId\\": \\"CJQ6H0XUEQ20IYJQ\\",\\n \\"CreateTime\\": \\"2021-03-18 16:41:31\\",\\n \\"ResourceGroupId\\": \\"rg-acfmyjt3c5om3hi\\",\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"tag1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"Description\\": \\"\\",\\n \\"DocumentUrl\\": \\"\\"\\n }\\n ],\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<ListTemplateResponse>\\n <TotalCount>100</TotalCount>\\n <Message>Success</Message>\\n <NextToken>1</NextToken>\\n <RequestId>A07FFDF2-78FA-1B48-9E38-88E833A93187</RequestId>\\n <Data>\\n <ImageURL>bp-studio-template/sr-U37UD2YQCRJ75X5V.png</ImageURL>\\n <TagId>1</TagId>\\n <TagName>官方模板</TagName>\\n <Name>cadt-name</Name>\\n <TopoURL>bp-studio-template/topo-0RJH9V408JV6MIT9.json</TopoURL>\\n <TemplateId>CJQ6H0XUEQ20IYJQ</TemplateId>\\n <CreateTime>2021-03-18 16:41:31</CreateTime>\\n <ResourceGroupId>rg-acfmyjt3c5om3hi</ResourceGroupId>\\n </Data>\\n <Code>200</Code>\\n</ListTemplateResponse>","errorExample":""}]', + 'title' => 'ListTemplate', + ], + 'ValuateTemplate' => [ + 'summary' => 'Queries the price of a template.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '181941', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioJLQBYK', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => [ + 'title' => '模板ID', + 'description' => 'The template ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '0KSHPM6SJU03TNZP', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '幂等标记', + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1600765710019', + ], + ], + [ + 'name' => 'AreaId', + 'in' => 'formData', + 'schema' => [ + 'title' => '区域ID', + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Instances', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '待替换实例列表', + 'description' => 'The instances to be replaced.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NodeType' => [ + 'title' => '实例类型', + 'description' => 'The instance type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + 'NodeName' => [ + 'title' => '图上实例名', + 'description' => 'The name of the application instance that is displayed on the diagram.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + 'Id' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1q56trhtaq40vlq5oj', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '应用所属资源组ID', + 'description' => 'The ID of the resource group to which the application belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyjt3c5om3fi', + ], + ], + [ + 'name' => 'Variables', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The parameter values that are contained in the template. If the template contains no parameter values, the default values are used.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'any', + 'example' => '${var1}', + 'description' => 'The supported variable.'."\n", + ], + 'enumValueTitles' => [], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The error message returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '847C9D0A-BABD-589C-8A9C-6464409EDED9', + ], + 'Data' => [ + 'description' => 'The result of the inquiry.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourceList' => [ + 'description' => 'The result set of the inquiry.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NodeType' => [ + 'description' => 'The resource type.'."\n", + 'type' => 'string', + 'example' => 'ecs', + ], + 'Error' => [ + 'description' => 'The error message that is returned.'."\n", + 'type' => 'string', + 'example' => 'InvalidSaleComponentFault : The request not refer to the correct order sale component.', + ], + 'TradePrice' => [ + 'description' => 'The price at which the transaction is made.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '10.0', + ], + 'DiscountAmount' => [ + 'description' => 'The discount amount.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '73', + ], + 'OriginalPrice' => [ + 'description' => 'The original price.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '83.0', + ], + 'PromotionName' => [ + 'description' => 'The discount information.'."\n", + 'type' => 'string', + 'example' => 'The discount information.', + ], + 'PriceUnit' => [ + 'description' => 'The pricing unit.'."\n", + 'type' => 'string', + 'example' => 'USD', + ], + 'PriceList' => [ + 'description' => 'The information about the price.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NodeType' => [ + 'description' => 'The resource type.'."\n", + 'type' => 'string', + 'example' => 'eip', + ], + 'ResourceId' => [ + 'description' => 'The resource ID.'."\n", + 'type' => 'string', + 'example' => '1687225092', + ], + 'Error' => [ + 'description' => 'The error message that is returned.'."\n", + 'type' => 'string', + 'example' => 'ServiceUnavailable : The request has failed due to a temporary failure of the server.\\r\\nRequestId : 4AA302DB-3286-5589-8637-FF6D8507B7A9.', + ], + 'TradePrice' => [ + 'description' => 'The price at which the transaction is made.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.01', + ], + 'DiscountAmount' => [ + 'description' => 'The discount amount.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '82.99', + ], + 'OriginalPrice' => [ + 'description' => 'The original price.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '83.0', + ], + 'PromotionName' => [ + 'description' => 'The discount information.'."\n", + 'type' => 'string', + 'example' => 'The discount information.', + ], + 'PriceUnit' => [ + 'description' => 'The pricing unit.'."\n", + 'type' => 'string', + 'example' => 'USD', + ], + 'Type' => [ + 'description' => 'Indicates whether the instance is newly created. Valid values:\\'."\n" + .'1: The instance is newly created.\\'."\n" + .'2: The instance already exists.\\'."\n" + .'0: The price of the instance is not included.'."\n", + 'type' => 'string', + 'example' => '"1"', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'Code' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'Success', + 'errorMessage' => 'The transaction is successful.', + ], + ], + 400 => [ + [ + 'errorCode' => 'ParameterEmpty', + 'errorMessage' => 'You must specify the request parameter.', + ], + [ + 'errorCode' => 'bp.java.8004', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'bp.java.appNameNotNull', + 'errorMessage' => 'Application name cannot be repeated.', + ], + [ + 'errorCode' => 'bp.java.nopower', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'bp.java.nopowerContact', + 'errorMessage' => 'You do not have permission to use this function. Please contact the main account or permission administrator to authorize the relevant permissions.', + ], + [ + 'errorCode' => 'bp.java.tempNameNotNull', + 'errorMessage' => 'Application name cannot be repeated.', + ], + [ + 'errorCode' => 'bp.java.userNotExist', + 'errorMessage' => 'The user does not exist. The current user does not authenticate AliCloud with his real name.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExist.ResourceGroup', + 'errorMessage' => 'The resource group does not exist.', + ], + [ + 'errorCode' => 'EntityNotExist.ResourceId', + 'errorMessage' => 'The resource does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'bp.java.notDelete', + 'errorMessage' => 'This template has been shared with other users and cannot be deleted.', + ], + [ + 'errorCode' => 'bp.java.serviceError', + 'errorMessage' => 'The server is abnormal. Please try again later.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"847C9D0A-BABD-589C-8A9C-6464409EDED9\\",\\n \\"Data\\": {\\n \\"ResourceList\\": [\\n {\\n \\"NodeType\\": \\"ecs\\",\\n \\"Error\\": \\"InvalidSaleComponentFault : The request not refer to the correct order sale component.\\",\\n \\"TradePrice\\": 10,\\n \\"DiscountAmount\\": 73,\\n \\"OriginalPrice\\": 83,\\n \\"PromotionName\\": \\"\\",\\n \\"PriceUnit\\": \\"CNY / USD\\",\\n \\"PriceList\\": [\\n {\\n \\"NodeType\\": \\"eip\\",\\n \\"ResourceId\\": \\"1687225092\\",\\n \\"Error\\": \\"ServiceUnavailable : The request has failed due to a temporary failure of the server.\\\\\\\\r\\\\\\\\nRequestId : 4AA302DB-3286-5589-8637-FF6D8507B7A9.\\",\\n \\"TradePrice\\": 0.01,\\n \\"DiscountAmount\\": 82.99,\\n \\"OriginalPrice\\": 83,\\n \\"PromotionName\\": \\"\\",\\n \\"PriceUnit\\": \\"CNY / USD\\\\n\\",\\n \\"Type\\": \\"\\\\\\"1\\\\\\"\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + 'title' => 'ValuateTemplate', + ], + 'GetLinkageAttributesTemplate' => [ + 'summary' => '获取模板变参可选值', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '181941', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioRJ9IF1', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => [ + 'title' => '模板ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'XFKR6WYRVS24S07R', + ], + ], + [ + 'name' => 'AreaId', + 'in' => 'formData', + 'schema' => [ + 'title' => '区域ID', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Instances', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '待替换实例列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NodeName' => [ + 'title' => '图上实例名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc', + ], + 'NodeType' => [ + 'title' => '实例类型', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc', + ], + 'Id' => [ + 'title' => '实例ID', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-**1q56**taq40*****', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Variables', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '', + 'example' => '{"${instance_type}":"ecs.c6.3xlarge"}', + ], + ], + ], + [ + 'name' => 'TargetVariable', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '${instance_type}', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '50', + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'OptionalValues' => [ + 'description' => '', + 'type' => 'string', + 'example' => '['."\n" + .' {'."\n" + .' "label": "ecs.c6.2xlarge (8c 16g)",'."\n" + .' "value": "ecs.c6.2xlarge"'."\n" + .' },'."\n" + .' {'."\n" + .' "label": "ecs.c6.3xlarge (12c 24g)",'."\n" + .' "value": "ecs.c6.3xlarge"'."\n" + .' }'."\n" + .']', + ], + 'ErrorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '400', + ], + 'ErrorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SyntaxError', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19', + ], + 'NextToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2', + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{'."\n" + .' "PolicyType": "",'."\n" + .' "AuthPrincipalOwnerId": "",'."\n" + .' "EncodedDiagnosticMessage": "",'."\n" + .' "AuthPrincipalType": "",'."\n" + .' "AuthPrincipalDisplayName": "",'."\n" + .' "NoPermissionType": "",'."\n" + .' "AuthAction": ""'."\n" + .' }', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'Success', + 'errorMessage' => 'The transaction is successful.', + ], + ], + 400 => [ + [ + 'errorCode' => 'ParameterEmpty', + 'errorMessage' => 'You must specify the request parameter.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermissions', + 'errorMessage' => 'No permissions.', + ], + ], + [ + [ + 'errorCode' => 'EntityNotExist.ResourceGroup', + 'errorMessage' => 'The resource group does not exist.', + ], + [ + 'errorCode' => 'EntityNotExist.ResourceId', + 'errorMessage' => 'The resource does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Data\\": {\\n \\"OptionalValues\\": \\"[\\\\n {\\\\n \\\\\\"label\\\\\\": \\\\\\"ecs.c6.2xlarge (8c 16g)\\\\\\",\\\\n \\\\\\"value\\\\\\": \\\\\\"ecs.c6.2xlarge\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"label\\\\\\": \\\\\\"ecs.c6.3xlarge (12c 24g)\\\\\\",\\\\n \\\\\\"value\\\\\\": \\\\\\"ecs.c6.3xlarge\\\\\\"\\\\n }\\\\n]\\",\\n \\"ErrorCode\\": \\"400\\",\\n \\"ErrorMessage\\": \\"SyntaxError\\",\\n \\"TotalCount\\": 19,\\n \\"NextToken\\": \\"2\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"\\\\\\"\\\\n }\\"\\n}","type":"json"}]', + ], + 'GetApplicationVariables' => [ + 'summary' => 'Queries the values specified for template variables when an application was created.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '240229', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioCGSK4A', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Q2P4O9YSOKCQ35L9', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '7036DDBE-0ABA-52D7-A39D-75E511970F07', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ob5epf79uv****', + ], + 'VariableList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Variable' => [ + 'description' => '', + 'type' => 'string', + 'example' => '${instance_type}', + ], + 'Value' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ecs.c6.4xlarge', + ], + ], + ], + ], + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7036DDBE-0ABA-52D7-A39D-75E511970F07\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"ob5epf79uv****\\",\\n \\"VariableList\\": [\\n {\\n \\"Variable\\": \\"${instance_type}\\",\\n \\"Value\\": \\"ecs.c6.4xlarge\\"\\n }\\n ]\\n }\\n ],\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + 'title' => 'GetApplicationVariables', + ], + 'ReConfigApplication' => [ + 'summary' => 'You can call an API operation to obtain the list of template variables that you need to reconfigure. If you call the ReConfigApplication operation to reconfigure the variables, the application enters the Modifying state and the properties of the resource nodes that failed to be deployed are reconfigured based on the specified variable values. For example, you can call the ReConfigApplication operation to modify the instance type of a resource node that failed to be deployed. After you call the ReConfigApplication operation, you can redeploy the application.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238269', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioCGSK4A', + ], + 'autoTest' => true, + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'example' => 'Q2P4O9YSOKCT35L9', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'Variables', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'example' => '{"${instance_type}":"ecs.c6.3xlarge"}', + 'required' => false, + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of Response', + 'properties' => [ + 'RequestId' => [ + 'description' => 'Id of the request', + 'example' => '9656C816-1E9A-58D2-86D5-710678D61AF1', + 'title' => 'Id of the request', + 'type' => 'string', + ], + 'Message' => [ + 'description' => '', + 'example' => 'Success', + 'type' => 'string', + ], + 'Code' => [ + 'description' => '', + 'example' => '200', + 'format' => 'int32', + 'type' => 'string', + ], + ], + 'title' => 'Schema of Response', + 'type' => 'object', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9656C816-1E9A-58D2-86D5-710678D61AF1\\",\\n \\"Message\\": \\"Success\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + 'title' => 'ReConfigApplication', + ], + 'GetApplicationVariables4Fail' => [ + 'summary' => 'Queries a list of variables that you need to reconfigure.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238274', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioCGSK4A', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Q2P4O9YSOKCT35L9', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'BFB7F5C8-FE7A-06CA-9F87-ABBF6B848F0C', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-shenzhen', + ], + 'Attribute' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'instance_name', + ], + 'Variable' => [ + 'description' => '', + 'type' => 'string', + 'example' => '${name}', + ], + 'PlaceHolder' => [ + 'description' => '', + 'type' => 'string', + 'example' => '${name}', + ], + 'Value' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cadt-app-01', + ], + 'DefaultValue' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cadt-app-01', + ], + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BFB7F5C8-FE7A-06CA-9F87-ABBF6B848F0C\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": [\\n {\\n \\"Region\\": \\"cn-shenzhen\\",\\n \\"Attribute\\": \\"instance_name\\",\\n \\"Variable\\": \\"${name}\\",\\n \\"PlaceHolder\\": \\"${name}\\",\\n \\"Value\\": \\"cadt-app-01\\",\\n \\"DefaultValue\\": \\"cadt-app-01\\"\\n }\\n ],\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + 'title' => 'GetApplicationVariables4Fail', + ], + 'CreateApplication' => [ + 'summary' => 'Creates an application based on an official template or private template in Cloud Architect Design Tool (CADT). Before you call this operation, make sure that you understand the billing methods and prices of Alibaba Cloud services to be used in the application.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '91661', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioCGSK4A', + ], + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => [ + 'title' => '模板ID', + 'description' => 'The ID of the template.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '0KSHPM6SJU03TNZP', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '客户端 Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。', + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '1600765710019', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '新建应用名', + 'description' => 'The name of the application.'."\n" + ."\n" + .'* The application name must be unique. You can call the [ListApplication](https://www.alibabacloud.com/help/en/bp-studio/latest/api-bpstudio-2021-09-31-listapplication) operation to query the existing applications.'."\n" + .'* The application name must be 2 to 128 characters in length. The name must start with a letter and cannot start with `http:// or https://`. The name can contain letters, digits, underscores (\\_), and hyphens (-).', + 'type' => 'string', + 'required' => true, + 'example' => 'cadt-application', + ], + ], + [ + 'name' => 'AreaId', + 'in' => 'formData', + 'schema' => [ + 'title' => '区域ID', + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '应用所属资源组ID', + 'description' => 'The ID of the resource group to which the application you want to create belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyjt3c5om3hi', + ], + ], + [ + 'name' => 'CreateAsync', + 'in' => 'formData', + 'schema' => [ + 'type' => 'boolean', + ], + ], + [ + 'name' => 'Instances', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '待替换实例列表', + 'description' => 'The instances in which you want to create the application. You can create applications in an existing virtual private cloud (VPC).'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NodeType' => [ + 'title' => '实例类型', + 'description' => 'The type of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc', + ], + 'NodeName' => [ + 'title' => '图上实例名', + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc', + ], + 'Id' => [ + 'title' => '实例ID', + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1q56trhtaq40vlq5ojm', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Configuration', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The parameters that are used to configure the application you want to create. For example, enableMonitor specifies whether to automatically create a CloudMonitor task for the application, and enableReport specifies whether to generate reports.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => 'The supported configuration parameter.'."\n", + 'example' => 'enableReport', + ], + 'example' => '{"enableMonitor":"0", "enableReport":"1"}', + ], + ], + [ + 'name' => 'Variables', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The parameter values that are contained in the template. If the template contains no parameter values, the default values are used.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'any', + 'description' => 'The supported variable.'."\n", + 'example' => '${var1}', + ], + 'example' => '{"variable1":"1"}', + ], + ], + [ + 'name' => 'ProcessVariables', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', + ], + 'Data' => [ + 'title' => '应用ID', + 'description' => 'The ID of the application.'."\n", + 'type' => 'string', + 'example' => '002XWH7MXB8MJRU0', + ], + 'Code' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'string', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'Success', + 'errorMessage' => 'The transaction is successful.', + ], + ], + 400 => [ + [ + 'errorCode' => 'ParameterEmpty', + 'errorMessage' => 'You must specify the request parameter.', + ], + [ + 'errorCode' => 'bp.java.8004', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'bp.java.appNameNotNull', + 'errorMessage' => 'Application name cannot be repeated.', + ], + [ + 'errorCode' => 'bp.java.nopower', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'bp.java.nopowerContact', + 'errorMessage' => 'You do not have permission to use this function. Please contact the main account or permission administrator to authorize the relevant permissions.', + ], + [ + 'errorCode' => 'bp.java.tempNameNotNull', + 'errorMessage' => 'Application name cannot be repeated.', + ], + [ + 'errorCode' => 'bp.java.userNotExist', + 'errorMessage' => 'The user does not exist. The current user does not authenticate AliCloud with his real name.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExist.ResourceGroup', + 'errorMessage' => 'The resource group does not exist.', + ], + [ + 'errorCode' => 'EntityNotExist.ResourceId', + 'errorMessage' => 'The resource does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'bp.java.notDelete', + 'errorMessage' => 'This template has been shared with other users and cannot be deleted.', + ], + [ + 'errorCode' => 'bp.java.serviceError', + 'errorMessage' => 'The server is abnormal. Please try again later.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Data\\": \\"002XWH7MXB8MJRU0\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + 'title' => 'CreateApplication', + ], + 'DeleteApplication' => [ + 'summary' => 'Deletes an application.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '91663', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioCGSK4A', + ], + ], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '002XWH7MXB8MJRU0', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyjt3c5om3hi', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', + ], + 'Code' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'string', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterEmpty', + 'errorMessage' => 'The request parameter cannot be empty.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExist.ResourceGroup', + 'errorMessage' => 'The resource group does not exist.', + ], + [ + 'errorCode' => 'EntityNotExist.ResourceId', + 'errorMessage' => 'The resource does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServiceError', + 'errorMessage' => 'A server error occurred. Please try again later.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + 'title' => 'DeleteApplication', + 'description' => 'Before you call this operation to delete an application, make sure that the application is in the `Destroyed_Success` state. Otherwise, the application fails to be deleted.`` You can call the [GetApplication](https://www.alibabacloud.com/help/en/bp-studio/latest/api-bpstudio-2021-09-31-getapplication) operation to query the status of an application.', + ], + 'GetApplication' => [ + 'summary' => 'The URL of the application topology image.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '91657', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioCGSK4A', + ], + ], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'VVK605ZH00OA4MRT', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the resource group.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyjt3c5om3hi', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '请求失败原因', + 'description' => 'Reason for the request failure', + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'Request ID', + 'type' => 'string', + 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', + ], + 'Data' => [ + 'description' => 'The details of the application.'."\n", + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'title' => '应用描述', + 'description' => 'Application description', + 'type' => 'string', + 'example' => 'remark', + ], + 'ImageURL' => [ + 'title' => '数据库中图片地址', + 'description' => 'The URL of the image in the database.'."\n", + 'type' => 'string', + 'example' => 'The details of the application.'."\n", + ], + 'ApplicationId' => [ + 'title' => '应用ID', + 'description' => 'App ID', + 'type' => 'string', + 'example' => 'VVK605ZH00OA4MRT', + ], + 'Name' => [ + 'title' => '应用名', + 'description' => 'App name', + 'type' => 'string', + 'example' => '1411182597819805/sr-8DWU4RUS49NIDII0.png', + ], + 'TemplateId' => [ + 'title' => '应用关联模板ID', + 'description' => 'The ID of the template associated with the application', + 'type' => 'string', + 'example' => 'FYS9VZ535U20V7HT', + ], + 'CreateTime' => [ + 'title' => '应用创建时间', + 'description' => 'The time when the app was created', + 'type' => 'string', + 'example' => '2021-08-09 14:37:16', + ], + 'ResourceGroupId' => [ + 'title' => '应用所属资源组ID', + 'description' => 'The ID of the resource group to which the app belongs', + 'type' => 'string', + 'example' => 'rg-aekzhfgmw4e6fwq', + ], + 'PriceList' => [ + 'title' => '计费结果列表', + 'description' => 'The billing results.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourceCode' => [ + 'title' => '产品code', + 'description' => 'Product code', + 'type' => 'string', + 'example' => 'ecs', + ], + 'InstanceName' => [ + 'title' => '实例名', + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'example' => 'ecs', + ], + 'OriginalPrice' => [ + 'title' => '原价', + 'description' => 'The original price of the instance.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '3.570', + ], + 'OnePrice' => [ + 'title' => '单价', + 'description' => 'The unit price of the instance.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0.01', + ], + 'Period' => [ + 'description' => 'The service duration.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'Count' => [ + 'title' => '数量', + 'description' => 'The quantity.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PriceUnit' => [ + 'title' => '单位', + 'description' => 'Unit: USD per hour'."\n", + 'type' => 'string', + 'example' => 'The service duration.'."\n", + ], + 'Price' => [ + 'title' => '总价', + 'description' => 'The total price.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0.01', + ], + 'ChargeType' => [ + 'title' => '支付类型', + 'description' => 'The billing method.'."\n", + 'type' => 'string', + 'example' => 'PayAsYouGo', + ], + 'Region' => [ + 'title' => '区域', + 'description' => 'The region in which the instance resides.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Specification' => [ + 'title' => '规格', + 'description' => 'The instance type. This parameter indicates the information about the instance type. For example, 192.168.0.0/16 may be returned for a Virtual Private Cloud (VPC) instance, ecs.g5.large may be returned for an Elastic Compute Service (ECS) instance, and slb.s1.small may be returned for a Server Load Balancer (SLB) instance. If the resource does not have a specific type, an empty value is returned.'."\n", + 'type' => 'string', + 'example' => 'The billing method.'."\n", + ], + 'Lifecycle' => [ + 'title' => '资源标记', + 'description' => 'Resource Fill Labels.', + 'type' => 'string', + 'example' => 'Create', + ], + 'Remark' => [ + 'description' => 'The error message that is returned when a price query fails.'."\n", + 'type' => 'string', + 'example' => 'ecs.e3.large', + ], + 'type' => [ + 'description' => 'The creation mode. Valid values:\\'."\n" + .'1: creates a new instance.\\'."\n" + .'2: imports an instance.'."\n", + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + 'Checklist' => [ + 'title' => '校验结果列表', + 'description' => 'The resource tag.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourceCode' => [ + 'title' => '产品code', + 'description' => 'The service code.'."\n", + 'type' => 'string', + 'example' => 'vpc', + ], + 'ResourceName' => [ + 'title' => '实例名', + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'example' => 'vpc', + ], + 'Region' => [ + 'title' => '区域', + 'description' => 'The region in which the instance resides.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Result' => [ + 'title' => '校验结果', + 'description' => 'The verification result.'."\n", + 'type' => 'string', + 'example' => 'Finish', + ], + 'Remark' => [ + 'title' => '失败原因', + 'description' => 'The message returned for verification.'."\n", + 'type' => 'string', + 'example' => 'The ID of the region.'."\n", + ], + 'Specification' => [ + 'title' => '规格', + 'description' => 'The resource specifications.'."\n", + 'type' => 'string', + 'example' => '192.168.0.0/16', + ], + 'Lifecycle' => [ + 'title' => '资源标记', + 'description' => 'The resource tag.'."\n", + 'type' => 'string', + 'example' => 'Create', + ], + ], + ], + ], + 'Status' => [ + 'title' => '应用状态', + 'description' => 'Verification passed'."\n", + 'type' => 'string', + 'example' => 'Deployed_Success', + ], + 'ResourceList' => [ + 'title' => '资源列表', + 'description' => 'The resource specification.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '资源部署结果', + 'description' => 'The resource deployment result.'."\n", + 'type' => 'string', + 'example' => 'Finish', + ], + 'ResourceCode' => [ + 'title' => '产品code', + 'description' => 'The service code.'."\n", + 'type' => 'string', + 'example' => 'ecs', + ], + 'ResourceName' => [ + 'title' => '实例名称', + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'example' => 'ecs', + ], + 'ResourceId' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'i-2zehnzxqixu1pywsfbx1', + ], + 'ChargeType' => [ + 'title' => '支付类型', + 'description' => 'The billing method.'."\n", + 'type' => 'string', + 'example' => 'PayAsYouGo', + ], + 'ResourceType' => [ + 'title' => '资源类型', + 'description' => 'The type of the resource.'."\n", + 'type' => 'string', + 'example' => 'ecs', + ], + 'Remark' => [ + 'title' => '部署结果', + 'description' => 'The deployment result.'."\n", + 'type' => 'string', + 'example' => '{"hostName":"iZ2zehnzxqixu1pywsfbx1Z","memory":32768.0,"creationTime":"2021-09-28T11:23:46Z","instanceName":"ecs","internetMaxBandwidthOut":0.0,"description":"","clusterId":"","private_ip":"192.168.0.247","instanceId":"i-2zehnzxqixu1pywsfbx1","requestId":"F1C64344-3723-51A0-855B-5F08B5634323","zoneId":"cn-beijing-b","ioOptimized":"optimized","id":"i-2zehnzxqixu1pywsfbx1","instanceNetworkType":"vpc","instanceChargeType":"PostPaid","imageId":"centos_8_4_x64_20G_alibase_20210824.vhd","serialNumber":"cee246c4-38f3-4bf3-950b-c17e88ff6527","vlanId":"","instanceType":"ecs.e3.large","cpu":4.0,"creditSpecification":"","internetMaxBandwidthIn":-1.0,"expiredTime":"2099-12-31T15:59Z","internetChargeType":"PayByTraffic","regionId":"cn-beijing","refId":"79224644_0","stoppedMode":"Not-applicable","status":"Running"}', + ], + 'Lifecycle' => [ + 'title' => '资源标记', + 'description' => 'The resource tag.'."\n", + 'type' => 'string', + 'example' => 'Create', + ], + 'NodeLabel' => [ + 'type' => 'string', + ], + ], + ], + ], + 'Error' => [ + 'title' => '失败原因', + 'description' => 'The resource type.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'DeployPercent' => [ + 'title' => '部署进度', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + ], + 'ComplianceList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Rules' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ruleId' => [ + 'type' => 'string', + ], + 'ruleDetail' => [ + 'type' => 'string', + ], + ], + ], + ], + 'ResourceName' => [ + 'type' => 'string', + ], + 'ResourceCode' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'Code' => [ + 'description' => 'The response code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'bp.java.8004', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'bp.java.nopower', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'bp.java.nopowerContact', + 'errorMessage' => 'You do not have permission to use this function. Please contact the main account or permission administrator to authorize the relevant permissions.', + ], + [ + 'errorCode' => 'bp.java.userNotExist', + 'errorMessage' => 'The user does not exist. The current user does not authenticate AliCloud with his real name.', + ], + [ + 'errorCode' => 'ParameterEmpty', + 'errorMessage' => 'The request parameter cannot be empty.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExist.ResourceGroup', + 'errorMessage' => 'The resource group does not exist.', + ], + [ + 'errorCode' => 'EntityNotExist.ResourceId', + 'errorMessage' => 'The resource does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServiceError', + 'errorMessage' => 'A server error occurred. Please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Data\\": {\\n \\"Description\\": \\"remark\\",\\n \\"ImageURL\\": \\"https://cadt-studio-publish.oss-cn-hangzhou.aliyuncs.com/xxxxxxxxxxxxxxxxxxx/sr-8DWU4RUS49NIDII0.png\\",\\n \\"ApplicationId\\": \\"VVK605ZH00OA4MRT\\",\\n \\"Name\\": \\"CADT\\",\\n \\"TemplateId\\": \\"FYS9VZ535U20V7HT\\",\\n \\"CreateTime\\": \\"2021-08-09 14:37:16\\",\\n \\"ResourceGroupId\\": \\"rg-aekzhfgmw4e6fwq\\",\\n \\"PriceList\\": [\\n {\\n \\"ResourceCode\\": \\"ecs\\",\\n \\"InstanceName\\": \\"ecs\\",\\n \\"OriginalPrice\\": 3.57,\\n \\"OnePrice\\": 0.01,\\n \\"Period\\": 1,\\n \\"Count\\": 1,\\n \\"PriceUnit\\": \\"200/hour\\",\\n \\"Price\\": 0.01,\\n \\"ChargeType\\": \\"PayAsYouGo\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Specification\\": \\"\\\\\\"slb.s1.small\\\\\\"\\\\n \\\\\\"192.168.0.0/24\\\\\\"\\\\n\\\\\\"ecs.c6.large\\\\\\"\\\\n\\\\\\"normal\\\\\\"\\\\n \\\\\\"\\\\\\"\\",\\n \\"Lifecycle\\": \\"Create\\",\\n \\"Remark\\": \\"ecs Sold Out\\",\\n \\"type\\": \\"1\\"\\n }\\n ],\\n \\"Checklist\\": [\\n {\\n \\"ResourceCode\\": \\"vpc\\",\\n \\"ResourceName\\": \\"vpc\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Result\\": \\"Finish\\",\\n \\"Remark\\": \\"Verification passed\\",\\n \\"Specification\\": \\"192.168.0.0/16\\",\\n \\"Lifecycle\\": \\"Create\\"\\n }\\n ],\\n \\"Status\\": \\"Deployed_Success\\",\\n \\"ResourceList\\": [\\n {\\n \\"Status\\": \\"Finish\\",\\n \\"ResourceCode\\": \\"ecs\\",\\n \\"ResourceName\\": \\"ecs\\",\\n \\"ResourceId\\": \\"i-2zehnzxqixu1pywsfbx1\\",\\n \\"ChargeType\\": \\"PayAsYouGo\\",\\n \\"ResourceType\\": \\"ecs\\",\\n \\"Remark\\": \\"{\\\\\\"hostName\\\\\\":\\\\\\"iZ2zehnzxqixu1pywsfbx1Z\\\\\\",\\\\\\"memory\\\\\\":32768.0,\\\\\\"creationTime\\\\\\":\\\\\\"2021-09-28T11:23:46Z\\\\\\",\\\\\\"instanceName\\\\\\":\\\\\\"ecs\\\\\\",\\\\\\"internetMaxBandwidthOut\\\\\\":0.0,\\\\\\"description\\\\\\":\\\\\\"\\\\\\",\\\\\\"clusterId\\\\\\":\\\\\\"\\\\\\",\\\\\\"private_ip\\\\\\":\\\\\\"192.168.0.247\\\\\\",\\\\\\"instanceId\\\\\\":\\\\\\"i-2zehnzxqixu1pywsfbx1\\\\\\",\\\\\\"requestId\\\\\\":\\\\\\"F1C64344-3723-51A0-855B-5F08B5634323\\\\\\",\\\\\\"zoneId\\\\\\":\\\\\\"cn-beijing-b\\\\\\",\\\\\\"ioOptimized\\\\\\":\\\\\\"optimized\\\\\\",\\\\\\"id\\\\\\":\\\\\\"i-2zehnzxqixu1pywsfbx1\\\\\\",\\\\\\"instanceNetworkType\\\\\\":\\\\\\"vpc\\\\\\",\\\\\\"instanceChargeType\\\\\\":\\\\\\"PostPaid\\\\\\",\\\\\\"imageId\\\\\\":\\\\\\"centos_8_4_x64_20G_alibase_20210824.vhd\\\\\\",\\\\\\"serialNumber\\\\\\":\\\\\\"cee246c4-38f3-4bf3-950b-c17e88ff6527\\\\\\",\\\\\\"vlanId\\\\\\":\\\\\\"\\\\\\",\\\\\\"instanceType\\\\\\":\\\\\\"ecs.e3.large\\\\\\",\\\\\\"cpu\\\\\\":4.0,\\\\\\"creditSpecification\\\\\\":\\\\\\"\\\\\\",\\\\\\"internetMaxBandwidthIn\\\\\\":-1.0,\\\\\\"expiredTime\\\\\\":\\\\\\"2099-12-31T15:59Z\\\\\\",\\\\\\"internetChargeType\\\\\\":\\\\\\"PayByTraffic\\\\\\",\\\\\\"regionId\\\\\\":\\\\\\"cn-beijing\\\\\\",\\\\\\"refId\\\\\\":\\\\\\"79224644_0\\\\\\",\\\\\\"stoppedMode\\\\\\":\\\\\\"Not-applicable\\\\\\",\\\\\\"status\\\\\\":\\\\\\"Running\\\\\\"}\\",\\n \\"Lifecycle\\": \\"Create\\",\\n \\"NodeLabel\\": \\"\\"\\n }\\n ],\\n \\"Error\\": \\"Success\\",\\n \\"DeployPercent\\": 0.8,\\n \\"ComplianceList\\": [\\n {\\n \\"Rules\\": [\\n {\\n \\"ruleId\\": \\"ecs-instances-in-vpc\\",\\n \\"ruleDetail\\": \\"\\"\\n }\\n ],\\n \\"ResourceName\\": \\"ecs\\",\\n \\"ResourceCode\\": \\"ecs\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<GetApplicationResponse>\\n <Message>Success</Message>\\n <RequestId>A07FFDF2-78FA-1B48-9E38-88E833A93187</RequestId>\\n <Data>\\n <Description>remark</Description>\\n <ImageURL>https://cadt-studio-publish.oss-cn-hangzhou.aliyuncs.com/xxxxxxxxxxxxxxxxxxx/sr-8DWU4RUS49NIDII0.png</ImageURL>\\n <ApplicationId>VVK605ZH00OA4MRT</ApplicationId>\\n <Name>CADT应用</Name>\\n <TemplateId>FYS9VZ535U20V7HT</TemplateId>\\n <CreateTime>2021-08-09 14:37:16</CreateTime>\\n <ResourceGroupId>rg-aekzhfgmw4e6fwq</ResourceGroupId>\\n <PriceList>\\n <ResourceCode>ecs</ResourceCode>\\n <InstanceName>ecs</InstanceName>\\n <OriginalPrice>3.57</OriginalPrice>\\n <OnePrice>0.01</OnePrice>\\n <Period>1</Period>\\n <Count>1</Count>\\n <PriceUnit>金额/时</PriceUnit>\\n <Price>0.01</Price>\\n <ChargeType>PayAsYouGo</ChargeType>\\n <Region>cn-hangzhou</Region>\\n <Specification>\\"slb.s1.small\\"\\n \\"192.168.0.0/24\\"\\n\\"ecs.c6.large\\"\\n\\"normal\\"\\n \\"\\"</Specification>\\n <Lifecycle>Create</Lifecycle>\\n <Remark>ecs售罄</Remark>\\n <type>1</type>\\n </PriceList>\\n <Checklist>\\n <ResourceCode>vpc</ResourceCode>\\n <ResourceName>vpc</ResourceName>\\n <Region>cn-hangzhou</Region>\\n <Result>Finish</Result>\\n <Remark>校验通过</Remark>\\n <Specification>192.168.0.0/16</Specification>\\n <Lifecycle>Create</Lifecycle>\\n </Checklist>\\n <Status>Deployed_Success</Status>\\n <ResourceList>\\n <Status>Finish</Status>\\n <ResourceCode>ecs</ResourceCode>\\n <ResourceName>ecs</ResourceName>\\n <ResourceId>i-2zehnzxqixu1pywsfbx1</ResourceId>\\n <ChargeType>PayAsYouGo</ChargeType>\\n <ResourceType>ecs</ResourceType>\\n <Remark>{\\"hostName\\":\\"iZ2zehnzxqixu1pywsfbx1Z\\",\\"memory\\":32768.0,\\"creationTime\\":\\"2021-09-28T11:23:46Z\\",\\"instanceName\\":\\"ecs\\",\\"internetMaxBandwidthOut\\":0.0,\\"description\\":\\"\\",\\"clusterId\\":\\"\\",\\"private_ip\\":\\"192.168.0.247\\",\\"instanceId\\":\\"i-2zehnzxqixu1pywsfbx1\\",\\"requestId\\":\\"F1C64344-3723-51A0-855B-5F08B5634323\\",\\"zoneId\\":\\"cn-beijing-b\\",\\"ioOptimized\\":\\"optimized\\",\\"id\\":\\"i-2zehnzxqixu1pywsfbx1\\",\\"instanceNetworkType\\":\\"vpc\\",\\"instanceChargeType\\":\\"PostPaid\\",\\"imageId\\":\\"centos_8_4_x64_20G_alibase_20210824.vhd\\",\\"serialNumber\\":\\"cee246c4-38f3-4bf3-950b-c17e88ff6527\\",\\"vlanId\\":\\"\\",\\"instanceType\\":\\"ecs.e3.large\\",\\"cpu\\":4.0,\\"creditSpecification\\":\\"\\",\\"internetMaxBandwidthIn\\":-1.0,\\"expiredTime\\":\\"2099-12-31T15:59Z\\",\\"internetChargeType\\":\\"PayByTraffic\\",\\"regionId\\":\\"cn-beijing\\",\\"refId\\":\\"79224644_0\\",\\"stoppedMode\\":\\"Not-applicable\\",\\"status\\":\\"Running\\"}</Remark>\\n <Lifecycle>Create</Lifecycle>\\n </ResourceList>\\n <Error>Success</Error>\\n </Data>\\n <Code>200</Code>\\n</GetApplicationResponse>","errorExample":""}]', + 'title' => 'GetApplication', + 'responseParamsDescription' => 'The resource deployment result.'."\n", + ], + 'ListApplication' => [ + 'summary' => 'This API provides a list of all applications under the current user. The optional keyword parameter defines the keywords contained in the application name.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '91667', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioCGSK4A', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The pagination page number of the resulting value cannot be less than the minimum value of 1 and cannot be greater than the maximum value of 10000.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The pagination size of the resulting value cannot be less than the minimum value of 1 and cannot be greater than the maximum value of 50.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Keywords in the app name', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'formData', + 'schema' => [ + 'title' => '排序字段', + 'description' => '1 update time,<br>2 creation time', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '10', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'title' => '应用的状态', + 'description' => 'The status of the applications to be returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'The following values are "success" and "release".'."\n" + .'If the input value is "success", the returned application list includes all applications in the Deployed_Success state of successful deployment.'."\n" + .'If the input value is release, the returned application list includes all applications in the release success (Destroyed_Success) and release failure (Destroyed_Failure) status.'."\n" + .'If this parameter is left blank, the returned app list includes apps in all states.'."\n" + ."\n", + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Resource Id', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-xxxxxxxxxxxx', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Template Id', + 'type' => 'string', + 'required' => false, + 'example' => '0KSXXX6SJU03TXXX', + ], + ], + [ + 'name' => 'ShowHide', + 'in' => 'formData', + 'schema' => [ + 'type' => 'boolean', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123', + ], + 'Message' => [ + 'description' => 'The interface returns information', + 'type' => 'string', + 'example' => 'Success', + ], + 'NextToken' => [ + 'description' => 'The query token returned in this call.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => 'The ID of the application.'."\n", + 'type' => 'string', + 'example' => 'BFB7F5C8-FE7A-06CA-9F87-ABBF6B848F0C', + ], + 'Data' => [ + 'description' => 'App listing information', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ImageURL' => [ + 'title' => '应用的图片链接', + 'description' => 'The URL of the application architecture image.'."\n", + 'type' => 'string', + 'example' => 'https://bp-studio-daily.oss-cn-beijing.aliyuncs.com/1411182597819805/sr-Y3KR7ZSQZR2F0YX3.png', + ], + 'Status' => [ + 'title' => '应用状态：Modified、Verifying、Verified_Failure、Verified_Success、Valuating、Valuating_Failure、Valuating_Success、Deploying、Deployed_Failure、Partially_Deployed_Success、Deployed_Success、Destroying、Destroyed_Failure、Partially_Destroyed_Success、Destroyed_Success等，详见应用状态说明', + 'description' => 'The status of the application.'."\n", + 'type' => 'string', + 'example' => 'Deployed_Success', + ], + 'ApplicationId' => [ + 'title' => '应用ID', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'example' => 'JIX9NEZUALGS46UI', + ], + 'Name' => [ + 'title' => '应用的名称', + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'example' => 'cadt-appName', + ], + 'CreateTime' => [ + 'description' => 'The time when the application was created.'."\n", + 'type' => 'string', + 'example' => '2021-09-15 08:30:00', + ], + 'ResourceGroupId' => [ + 'title' => '应用的资源组', + 'description' => 'The ID of the resource group to which the application belongs.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + ], + ], + ], + 'Code' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'string', + 'format' => 'int32', + 'example' => '200', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'Success', + 'errorMessage' => 'The transaction is successful.', + ], + ], + 400 => [ + [ + 'errorCode' => 'ParameterEmpty', + 'errorMessage' => 'You must specify the request parameter.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExist.ResourceGroup', + 'errorMessage' => 'The resource group does not exist.', + ], + [ + 'errorCode' => 'EntityNotExist.ResourceId', + 'errorMessage' => 'The resource does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServiceError', + 'errorMessage' => 'A server error occurred. Please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 123,\\n \\"Message\\": \\"Success\\",\\n \\"NextToken\\": 2,\\n \\"RequestId\\": \\"BFB7F5C8-FE7A-06CA-9F87-ABBF6B848F0C\\",\\n \\"Data\\": [\\n {\\n \\"ImageURL\\": \\"https://bp-studio-daily.oss-cn-beijing.aliyuncs.com/1411182597819805/sr-Y3KR7ZSQZR2F0YX3.png\\",\\n \\"Status\\": \\"Deployed_Success\\",\\n \\"ApplicationId\\": \\"JIX9NEZUALGS46UI\\",\\n \\"Name\\": \\"cadt-appName\\",\\n \\"CreateTime\\": \\"2021-09-15 08:30:00\\",\\n \\"ResourceGroupId\\": \\"default\\"\\n }\\n ],\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'ListApplication', + 'responseParamsDescription' => 'List of app statuses:'."\n" + ."\n" + .'Creating</br>'."\n" + .'Modified</br>'."\n" + .'Verifying checkout</br>'."\n" + .'Verified_Failure Verification failed</br>'."\n" + .'Verified_Success Verification succeeded</br>'."\n" + .'Valuating</br>'."\n" + .'Valuating_Failure Pricing failed</br>'."\n" + .'Valuating_Success Valuation successful</br>'."\n" + .'Deploying</br>'."\n" + .'Deployed_Failure Deployment failed</br>'."\n" + .'Partially_Deployed_Success Partially deployed successfully</br>'."\n" + .'Deployed_Success Deployment successful</br>'."\n" + .'Destroying is being released</br>'."\n" + .'Delayed_Destroy Delayed destruction</br>'."\n" + .'Destroyed_Failure Release failed</br>'."\n" + .'Partially_Destroyed_Success Partial release succeeded</br>'."\n" + .'Destroyed_Success Release successful</br>'."\n" + .'Revised schema adjustments</br>'."\n" + .'Verifying_In_Revision Resource Validation (Schema Tuning)</br>'."\n" + .'Verified_Failure_In_Revision Resource Validation Failed (Schema Tuning)</br>'."\n" + .'Verified_Success_In_Revision Resource Verification Succeeded (Schema Adjustment)</br>'."\n" + .'Valuating_In_Revision Request for quotation (structure adjustment)</br>'."\n" + .'Valuating_Failure_In_Revision Request for quotation failed (schema adjustment)</br>'."\n" + .'Valuating_Success_In_Revision Successful Request for Quotation (Structural Adjustment)</br>', + ], + 'DeployApplication' => [ + 'summary' => 'Deploys an application after the payment.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '91660', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioCGSK4A', + ], + ], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID', + 'description' => 'The ID of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'VVK605ZH00OA4MRT', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源组ID', + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyjt3c5om3hi', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '幂等标记', + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1600765710019', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', + ], + 'Data' => [ + 'description' => 'The data of the application.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'Code' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'string', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'Success', + 'errorMessage' => 'The transaction is successful.', + ], + ], + 400 => [ + [ + 'errorCode' => 'ParameterEmpty', + 'errorMessage' => 'You must specify the request parameter.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExist.ResourceGroup', + 'errorMessage' => 'The resource group does not exist.', + ], + [ + 'errorCode' => 'EntityNotExist.ResourceId', + 'errorMessage' => 'The resource does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServiceError', + 'errorMessage' => 'A server error occurred. Please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Data\\": 123,\\n \\"Code\\": 200\\n}","errorExample":""},{"type":"xml","example":"<DeployApplicationResponse>\\n <Message>Success</Message>\\n <RequestId>A07FFDF2-78FA-1B48-9E38-88E833A93187</RequestId>\\n <Data>123</Data>\\n <Code>200</Code>\\n</DeployApplicationResponse>","errorExample":""}]', + 'title' => 'DeployApplication', + ], + 'ReleaseApplication' => [ + 'summary' => 'Releases the resources of an application.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '91662', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioCGSK4A', + ], + ], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'formData', + 'schema' => [ + 'title' => '应用ID', + 'description' => 'The ID of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '7QSXFQW46ZNGOUDM', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the resource group.', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '幂等标记', + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1600765710019', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'The resource does not exist.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'BFB7F5C8-FE7A-06CA-9F87-ABBF6B848F0C', + ], + 'Data' => [ + 'description' => 'The return value.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Code' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'string', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'Success', + 'errorMessage' => 'The transaction is successful.', + ], + ], + 400 => [ + [ + 'errorCode' => 'ParameterEmpty', + 'errorMessage' => 'You must specify the request parameter.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExist.ResourceGroup', + 'errorMessage' => 'The resource group does not exist.', + ], + [ + 'errorCode' => 'EntityNotExist.ResourceId', + 'errorMessage' => 'The resource does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServiceError', + 'errorMessage' => 'A server error occurred. Please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"BFB7F5C8-FE7A-06CA-9F87-ABBF6B848F0C\\",\\n \\"Data\\": 1,\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<ReleaseApplicationResponse>\\n <Message>应用ID错误</Message>\\n <RequestId>BFB7F5C8-FE7A-06CA-9F87-ABBF6B848F0C</RequestId>\\n <Data>1</Data>\\n <Code>200</Code>\\n</ReleaseApplicationResponse>","errorExample":""}]', + 'title' => 'ReleaseApplication', + ], + 'ValidateApplication' => [ + 'summary' => 'Verifies the resources of an application. ValidateApplication is an asynchronous operation. You can call the GetApplication operation to query the verification result.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '91658', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioCGSK4A', + ], + ], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID', + 'description' => 'The ID of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '02S7UU41WKJL7ERR', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源组ID', + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyjt3c5om3hi', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '幂等标记', + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1600765710019', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', + ], + 'Data' => [ + 'description' => 'The data of the application.'."\n", + 'type' => 'string', + 'example' => '123', + ], + 'Code' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'string', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterEmpty', + 'errorMessage' => 'The request parameter cannot be empty.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExist.ResourceGroup', + 'errorMessage' => 'The resource group does not exist.', + ], + [ + 'errorCode' => 'EntityNotExist.ResourceId', + 'errorMessage' => 'The resource does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServiceError', + 'errorMessage' => 'A server error occurred. Please try again later.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Data\\": \\"123\\",\\n \\"Code\\": 200\\n}","type":"json"}]', + 'title' => 'ValidateApplication', + ], + 'ValuateApplication' => [ + 'summary' => 'Queries the prices of resources of an application. You can call the GetApplication operation to obtain the query results.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '91659', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioCGSK4A', + ], + ], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'formData', + 'schema' => [ + 'title' => '应用ID', + 'description' => 'The operation that you want to perform. Set the value to ValuateApplication.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '02S7UU41WKJL7ERR', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源组ID', + 'description' => 'The ID of the resource group.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyjt3c5om3hi', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '幂等标记', + 'description' => 'The ID of the resource group to which the application you want to query belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1600765710019', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'Idempotent notation', + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', + ], + 'Data' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'Code' => [ + 'description' => 'The code of the query task.'."\n", + 'type' => 'string', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'Success', + 'errorMessage' => 'The transaction is successful.', + ], + ], + 400 => [ + [ + 'errorCode' => 'ParameterEmpty', + 'errorMessage' => 'You must specify the request parameter.', + ], + ], + 404 => [ + [ + 'errorCode' => 'EntityNotExist.ResourceGroup', + 'errorMessage' => 'The resource group does not exist.', + ], + [ + 'errorCode' => 'EntityNotExist.ResourceId', + 'errorMessage' => 'The resource does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServiceError', + 'errorMessage' => 'A server error occurred. Please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Data\\": 123,\\n \\"Code\\": 200\\n}","errorExample":""},{"type":"xml","example":"<ValuateApplicationResponse>\\n <Message>Success</Message>\\n <RequestId>A07FFDF2-78FA-1B48-9E38-88E833A93187</RequestId>\\n <Data>123</Data>\\n <Code>200</Code>\\n</ValuateApplicationResponse>","errorExample":""}]', + 'title' => 'ValuateApplication', + ], + 'GetResource4ModifyRecord' => [ + 'summary' => 'Queries the configuration change records for an application.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioDXU2R7', + ], + ], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源组ID，用于资源组相关权限校验', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'BE68D71ZY5YYIU9R', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rm-uf6308dyal1*****', + ], + 'Type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rds', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'Finish' => 'Finish', + 'Fail' => 'Fail', + ], + 'example' => 'Finish', + ], + 'ModifyTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1726645341000', + ], + 'Attribute' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{\'InstanceId\': \'\', \'AttributeName\': \'drmCommand\', \'Id\': 16800, \'Desc\': \'test\'}', + ], + 'Error' => [ + 'type' => 'string', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + 'NextToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2', + ], + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{'."\n" + .' "PolicyType": "",'."\n" + .' "AuthPrincipalOwnerId": "",'."\n" + .' "EncodedDiagnosticMessage": "",'."\n" + .' "AuthPrincipalType": "",'."\n" + .' "AuthPrincipalDisplayName": "",'."\n" + .' "NoPermissionType": "",'."\n" + .' "AuthAction": ""'."\n" + .' }', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'bp.java.nopowerContact', + 'errorMessage' => 'You do not have permission to use this function. Please contact the main account or permission administrator to authorize the relevant permissions.', + ], + [ + 'errorCode' => 'bp.java.8004', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'bp.java.nopower', + 'errorMessage' => 'No permissions.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Message\\": \\"Success\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"ResourceId\\": \\"rm-uf6308dyal1*****\\",\\n \\"Type\\": \\"rds\\",\\n \\"Status\\": \\"Finish\\",\\n \\"ModifyTime\\": \\"2024-10-15 19:09:25\\",\\n \\"Attribute\\": \\"{\\\\n \\\\\\"InstanceId\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AttributeName\\\\\\": \\\\\\"drmCommand\\\\\\",\\\\n \\\\\\"Id\\\\\\": 16800,\\\\n \\\\\\"Desc\\\\\\": \\\\\\"test\\\\\\"\\\\n}\\",\\n \\"Error\\": \\"Postpaid.NotSupport : The charge type does not support for postpaid.\\\\nRequestId : A0XXXDF2-78FA-1B48-9XX8-88E833A93XXX\\"\\n }\\n ],\\n \\"TotalCount\\": \\"123\\",\\n \\"NextToken\\": \\"2\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"\\\\\\"\\\\n }\\"\\n}","type":"json"}]', + 'title' => 'GetResource4ModifyRecord', + ], + 'GetResult4QueryInstancePrice4Modify' => [ + 'summary' => 'Queries the result of a request for quotation.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioDXU2R7', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'formData', + 'schema' => [ + 'title' => '操作ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '58d5d8c5b5489150417a7cd6caa614bb', + ], + ], + [ + 'name' => 'ApplicationId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源组ID，用于资源组相关权限校验', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '02S7UU41WKJL7ERR', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'd9a3e99b-6954-4a16-ad51-954db4a528b7', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'PriceList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NodeType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc', + ], + 'TradeAmount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '1', + ], + 'DiscountAmount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '2', + ], + 'OriginalAmount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '3', + ], + 'PriceUnit' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'PromotionName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Error' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{'."\n" + .' "PolicyType": "",'."\n" + .' "AuthPrincipalOwnerId": "",'."\n" + .' "EncodedDiagnosticMessage": "",'."\n" + .' "AuthPrincipalType": "",'."\n" + .' "AuthPrincipalDisplayName": "",'."\n" + .' "NoPermissionType": "",'."\n" + .' "AuthAction": ""'."\n" + .' }', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Message\\": \\"Success\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"d9a3e99b-6954-4a16-ad51-954db4a528b7\\",\\n \\"Status\\": \\"SUCCESS\\",\\n \\"PriceList\\": [\\n {\\n \\"NodeType\\": \\"vpc\\",\\n \\"TradeAmount\\": 1,\\n \\"DiscountAmount\\": 2,\\n \\"OriginalAmount\\": 3,\\n \\"PriceUnit\\": \\"200/hour\\",\\n \\"PromotionName\\": \\"Offer Information\\",\\n \\"Error\\": \\"Get information on price failures\\"\\n }\\n ]\\n },\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"\\\\\\"\\\\n }\\"\\n}","type":"json"}]', + 'title' => 'GetResult4QueryInstancePrice4Modify', + ], + 'ModifyApplicationSpec' => [ + 'summary' => 'Modifies instance configurations for an application.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '230209', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioRJ9IF1', + ], + ], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '02S7UU41WKJL7ERR', + ], + ], + [ + 'name' => 'InstanceSpec', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-2ze8f4ah378a*****', + ], + 'Configuration' => [ + 'description' => '', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'any', + 'example' => '', + 'description' => '', + ], + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => '-1', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A3488F1D-xxxx-xxxx-xxxx-5374BA0F3562', + ], + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{'."\n" + .' "PolicyType": "",'."\n" + .' "AuthPrincipalOwnerId": "",'."\n" + .' "EncodedDiagnosticMessage": "",'."\n" + .' "AuthPrincipalType": "",'."\n" + .' "AuthPrincipalDisplayName": "",'."\n" + .' "NoPermissionType": "",'."\n" + .' "AuthAction": ""'."\n" + .' }', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'bp.java.8004', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'bp.java.nopowerContact', + 'errorMessage' => 'You do not have permission to use this function. Please contact the main account or permission administrator to authorize the relevant permissions.', + ], + [ + 'errorCode' => 'bp.java.nopower', + 'errorMessage' => 'No permissions.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": \\"-1\\",\\n \\"RequestId\\": \\"A3488F1D-xxxx-xxxx-xxxx-5374BA0F3562\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"\\\\\\"\\\\n }\\"\\n}","type":"json"}]', + 'title' => 'ModifyApplicationSpec', + ], + 'QueryInstancePrice4Modify' => [ + 'summary' => 'Queries the price for configuration change.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '230186', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioJLQBYK', + ], + ], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '002XWH7MXB8MJRU0', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'rm-uf66k9143r2ch*****', + ], + ], + [ + 'name' => 'Configuration', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '', + 'example' => '', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '9656C816-1E9A-58D2-86D5-710678D61AF1', + ], + 'Success' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Data' => [ + 'description' => 'taskId', + 'type' => 'string', + 'example' => 'price4modify/19862074****/rm-uf69xr871l***fj39/WQ9ULO4SLD**PQY5/FL1IZLW**3H78OC', + ], + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{'."\n" + .' "PolicyType": "",'."\n" + .' "AuthPrincipalOwnerId": "",'."\n" + .' "EncodedDiagnosticMessage": "",'."\n" + .' "AuthPrincipalType": "",'."\n" + .' "AuthPrincipalDisplayName": "",'."\n" + .' "NoPermissionType": "",'."\n" + .' "AuthAction": ""'."\n" + .' }', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9656C816-1E9A-58D2-86D5-710678D61AF1\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": \\"price4modify/19862074****/rm-uf69xr871l***fj39/WQ9ULO4SLD**PQY5/FL1IZLW**3H78OC\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"\\\\\\"\\\\n }\\"\\n}","type":"json"}]', + 'title' => 'QueryInstancePrice4Modify', + ], + 'QueryInstanceSpec4Modify' => [ + 'summary' => 'Queries a list of instance types that are available for specification change.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioDXU2R7', + ], + ], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'BE68D71ZY5YYIU9R', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'rm-uf66k9143r2ch*****', + ], + ], + [ + 'name' => 'MethodName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '', + 'example' => '', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'example' => '', + 'properties' => [ + 'OptionalValues' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Label' => [ + 'type' => 'string', + ], + 'Value' => [ + 'type' => 'string', + ], + 'Min' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'Max' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'Step' => [ + 'type' => 'number', + 'format' => 'double', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '847C9D0A-BABD-589C-8A9C-6464409EDED9', + ], + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{'."\n" + .' "PolicyType": "",'."\n" + .' "AuthPrincipalOwnerId": "",'."\n" + .' "EncodedDiagnosticMessage": "",'."\n" + .' "AuthPrincipalType": "",'."\n" + .' "AuthPrincipalDisplayName": "",'."\n" + .' "NoPermissionType": "",'."\n" + .' "AuthAction": ""'."\n" + .' }', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": {\\n \\"OptionalValues\\": [\\n {\\n \\"Label\\": \\"1 GB\\",\\n \\"Value\\": \\"redis.shard.small.2.ce\\",\\n \\"Min\\": 1,\\n \\"Max\\": 1,\\n \\"Step\\": 1\\n }\\n ]\\n },\\n \\"RequestId\\": \\"847C9D0A-BABD-589C-8A9C-6464409EDED9\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"\\\\\\"\\\\n }\\"\\n}","type":"json"}]', + 'title' => 'QueryInstanceSpec4Modify', + ], + 'ExecuteOperationSync' => [ + 'summary' => 'Performs an operation on a resource in an application and returns the result in a synchronous manner.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '212309', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioCGSK4A', + ], + ], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'formData', + 'schema' => [ + 'title' => '云速搭应用ID', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'BE68D71ZY5YYIU9R', + ], + ], + [ + 'name' => 'ServiceType', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源类型，如果需要修改 dds 的相关参数请填写：dds。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'dds' => 'dds', + 'ecs' => 'ecs', + ], + 'example' => 'dds', + ], + ], + [ + 'name' => 'Operation', + 'in' => 'formData', + 'schema' => [ + 'title' => '本次操作类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'modifyConnectionString' => 'modifyConnectionString', + 'rename' => 'rename', + ], + 'example' => 'rename', + ], + ], + [ + 'name' => 'Attributes', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '操作相关参数，根据不同的Operation值，输入对应的参数', + 'description' => '', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '', + 'example' => '', + ], + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源组ID，用于资源组权限校验', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyjt3c5om3hi', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '幂等标记', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1600765710019', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'Access key ID cannot be null.', + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '', + 'type' => 'string', + 'example' => 'FDC73B05-5331-57AA-BA93-4C9882792FF5', + ], + 'Data' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'example' => 'op_xxxxxxxxxxxxxxxxxx_dds_modifyInstanceType_BYSOQGWUV6PME412_ERMEZLXNN3K9N3OL', + 'properties' => [ + 'OperationId' => [ + 'title' => '操作ID', + 'type' => 'string', + ], + 'Status' => [ + 'title' => '当前操作状态', + 'type' => 'string', + ], + 'Message' => [ + 'title' => '操作相关信息', + 'type' => 'string', + ], + 'Arguments' => [ + 'title' => '操作相关输出结果', + 'type' => 'string', + ], + ], + ], + 'Code' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Access key ID cannot be null.\\",\\n \\"RequestId\\": \\"FDC73B05-5331-57AA-BA93-4C9882792FF5\\",\\n \\"Data\\": {\\n \\"OperationId\\": \\"op_xxxxxxxx\\",\\n \\"Status\\": \\"SUCCESS/FAILURE\\",\\n \\"Message\\": \\"\\\\\\"[{\\\\\\"vServerGroupId\\\\\\":\\\\\\"rsp-xxxx\\\\\\",\\\\\\"healthCheckHttpVersion\\\\\\":\\\\\\"http1.0\\\\\\",\\\\\\"status\\\\\\":\\\\\\"running\\\\\\",\\\\\\"gzip\\\\\\":\\\\\\"on\\\\\\",\\\\\\"requestId\\\\\\":\\\\\\"89xxxx\\\\\\",\\\\\\"description\\\\\\":\\\\\\"abcxxx\\\\\\",\\\\\\"bandwidth\\\\\\":-1,\\\\\\"healthCheckTimeout\\\\\\":10,\\\\\\"healthCheckType\\\\\\":\\\\\\"http\\\\\\",\\\\\\"aclStatus\\\\\\":\\\\\\"off\\\\\\",\\\\\\"unhealthyThreshold\\\\\\":3,\\\\\\"xForwardedFor_SLBID\\\\\\":\\\\\\"off\\\\\\",\\\\\\"healthCheckHttpCode\\\\\\":\\\\\\"http_3xx,http_2xx\\\\\\",\\\\\\"listenerForward\\\\\\":\\\\\\"off\\\\\\",\\\\\\"xForwardedFor\\\\\\":\\\\\\"on\\\\\\",\\\\\\"idleTimeout\\\\\\":15,\\\\\\"requestTimeout\\\\\\":60,\\\\\\"listenerPort\\\\\\":80,\\\\\\"healthCheckInterval\\\\\\":2,\\\\\\"healthCheckURI\\\\\\":\\\\\\"/\\\\\\",\\\\\\"scheduler\\\\\\":\\\\\\"rr\\\\\\",\\\\\\"healthyThreshold\\\\\\":3,\\\\\\"xForwardedFor_proto\\\\\\":\\\\\\"off\\\\\\",\\\\\\"xForwardedFor_SLBIP\\\\\\":\\\\\\"off\\\\\\",\\\\\\"stickySession\\\\\\":\\\\\\"off\\\\\\",\\\\\\"healthCheckMethod\\\\\\":\\\\\\"head\\\\\\",\\\\\\"healthCheck\\\\\\":\\\\\\"on\\\\\\",\\\\\\"rules\\\\\\":[],\\\\\\"aclIds\\\\\\":[]}]\\\\\\"\\",\\n \\"Arguments\\": \\"{\\\\n \\\\\\"tagMap\\\\\\":{\\\\n \\\\\\"cadt\\\\\\": [\\\\n \\\\\\"12xxxxxxx\\\\\\",\\\\n \\\\\\"34xxxxxxx\\\\\\"\\\\n ]\\\\n }\\\\n}\\"\\n },\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + 'title' => 'ExecuteOperationSync', + ], + 'ExecuteOperationASync' => [ + 'summary' => 'Asynchronous execution of product operation functions.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '147059', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioCGSK4A', + ], + ], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the Cloud Architect Design Tools (CADT) application.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'BG**********UQ', + ], + ], + [ + 'name' => 'ServiceType', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源类型，当前只支持cadt_app', + 'description' => 'The type of the service. If you want to perform operations on an Elastic Compute Service (ECS) instance, set ServiceType to ecs.'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'ecs' => 'ecs', + ], + 'example' => 'ACK', + ], + ], + [ + 'name' => 'Operation', + 'in' => 'formData', + 'schema' => [ + 'title' => '本次操作类型，例如：attachTag，批量打标; assignResourceGroup，批量分配资源组等', + 'description' => 'This operation type is the operation type of modifying the product, some operation types are generic, and some are used alone. The following is an example of ECS deployment:'."\n" + .'- The name of the ECS: rename'."\n" + .'- Specification of ecs: modifyInstanceType'."\n" + .'- Startup of ecs: modifyInstanceType'."\n" + .'- Stop of ecs: modifyInstanceType'."\n" + .'- Restart of ecs: modifyInstanceType'."\n" + .'- Ecs Tag: addTags'."\n" + .'- Deletion of ecs: ecsDelete'."\n" + .'- Paid type for ecs: modifyPayType', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'addTags' => 'addTags', + 'modifyInstanceType' => 'modifyInstanceType', + ], + 'example' => 'queryTopo', + ], + ], + [ + 'name' => 'Attributes', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '操作相关参数，根据不同的Operation值，输入对应的参数', + 'description' => 'The parameters related to the action. Specify the parameters based on the value of Operation. The parameters are passed in the map format. The following examples show how to specify the parameters if you want to change the specifications of an Elastic Compute Service (ECS) instance:'."\n" + ."\n" + .'* The following common parameters are required: change_type, regionId, instanceId, appId'."\n" + .'* Example values for changing the instance type of the ECS instance: { "ServiceType": "ecs", "Operation": "modifyInstanceType", "Attributes": "{"change_type":"modify_instance_type","instance_type":"ecs.hfr7.2xlarge","instanceId":"i-xxxxxxxxx","regionId":"cn-beijing","appId":"xxxxxxxxxxxxx"}" }'."\n" + .'* Example values for stopping the ECS instance: { "ServiceType": "ecs", "Operation": "modifyInstanceType", "Attributes": "{"change_type":"modify_status","status":"Stopped","instanceId":"i-xxxxxxxxx","regionId":"cn-beijing","appId":"xxxxxxxxxxxxx"}" }'."\n" + .'* Example values for starting the ECS instance: { "ServiceType": "ecs", "Operation": "modifyInstanceType", "Attributes": "{"change_type":"modify_status","status":"Running","instanceId":"i-xxxxxxxxx","regionId":"cn-beijing","appId":"xxxxxxxxxxxxx"}" }'."\n" + .'* Example values for restarting the ECS instance: { "ServiceType": "ecs", "Operation": "modifyInstanceType", "Attributes": "{"change_type":"modify_status","status":"Restart","instanceId":"i-xxxxxxxxx","regionId":"cn-beijing","appId":"xxxxxxxxxxxxx"}" }'."\n" + ."\n" + .'Example of enumerating more than one set of parameters:'."\n" + ."\n" + .'* { "ServiceType": "ecs", "Operation": "modifyInstanceType", "Attributes": "{\\\\"change_type\\\\":\\\\"modify_instance_type\\\\",\\\\"instance_type\\\\":\\\\"ecs.hfr7.2xlarge\\\\",\\\\"instanceId\\\\":\\\\"i-xxxxxxxxx\\\\",\\\\"regionId\\\\":\\\\"cn-beijing\\\\",\\\\"appId\\\\":\\\\"xxxxxxxxxxxxx\\\\"}" }'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' { "ServiceType": "ecs", "Operation": "modifyInstanceType", "Attributes": "{\\\\"change_type\\\\":\\\\"modify_instance_type\\\\",\\\\"instance_type\\\\":\\\\"ecs.hfr7.2xlarge\\\\",\\\\"instanceId\\\\":\\\\"i-xxxxxxxxx\\\\",\\\\"regionId\\\\":\\\\"cn-beijing\\\\",\\\\"appId\\\\":\\\\"xxxxxxxxxxxxx\\\\"}" }'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'any', + 'description' => 'Select a parameter type before you specify the parameter during debugging.'."\n", + 'example' => 'cn-hangzhou', + ], + 'enumValueTitles' => [ + '{ "ServiceType": "ecs", "Operation": "modifyInstanceType", "Attributes": "{\\"change_type\\":\\"modify_instance_type\\",\\"instance_type\\":\\"ecs.hfr7.2xlarge\\",\\"instanceId\\":\\"i-xxxxxxxxx\\",\\"regionId\\":\\"cn-beijing\\",\\"appId\\":\\"xxxxxxxxxxxxx\\"}" }' => '{ "ServiceType": "ecs", "Operation": "modifyInstanceType", "Attributes": "{\\"change_type\\":\\"modify_instance_type\\",\\"instance_type\\":\\"ecs.hfr7.2xlarge\\",\\"instanceId\\":\\"i-xxxxxxxxx\\",\\"regionId\\":\\"cn-beijing\\",\\"appId\\":\\"xxxxxxxxxxxxx\\"}" }', + ], + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源组ID，用于资源组权限校验', + 'description' => 'Resource group ID, which is used to verify the permissions of the resource group', + 'type' => 'string', + 'required' => false, + 'example' => 'ceshi', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '幂等标记', + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1600765710019', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '错误信息', + 'description' => 'Error message', + 'type' => 'string', + 'example' => '" "', + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'Request ID', + 'type' => 'string', + 'example' => 'SD-WEF-DSW-32ED-323DDSD-2332D', + ], + 'Data' => [ + 'title' => '异步操作任务ID', + 'description' => 'The operation ID. You can call the GetExecuteOperationResult operation to asynchronously query the result of an operation. The ID expires after one hour.'."\n", + 'type' => 'string', + 'example' => 'op_xxxxxxxxxxxxxxxxxx_ecs_modifyInstanceType_BYSOQGWUV6PME412_ERMEZLXNN3K9N3OL', + ], + 'Code' => [ + 'title' => '', + 'description' => 'Result code, 200 for success; Other representatives fail.', + 'type' => 'string', + 'format' => 'int32', + 'example' => '200', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\\\\\" \\\\\\"\\",\\n \\"RequestId\\": \\"SD-WEF-DSW-32ED-323DDSD-2332D\\",\\n \\"Data\\": \\"op_xxxxxxxxxxxxxxxxxx_ecs_modifyInstanceType_BYSOQGWUV6PME412_ERMEZLXNN3K9N3OL\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + 'title' => 'ExecuteOperationASync', + ], + 'GetExecuteOperationResult' => [ + 'summary' => 'Asynchronously queries the result of an operation that is performed on a service instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '147061', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioJLQBYK', + 'FEATUREbpstudioCGSK4A', + ], + ], + 'parameters' => [ + [ + 'name' => 'OperationId', + 'in' => 'formData', + 'schema' => [ + 'title' => '操作ID', + 'description' => 'The ID of the operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'op_xxxxxxxxxxxxxxxxxxxxxx', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源组ID，用于资源组相关权限校验', + 'description' => 'The ID of the resource group. This parameter is specified to verify the permissions on the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testResourceId', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '错误信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => '" "', + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', + ], + 'Data' => [ + 'description' => 'The detailed result of the queried operation.'."\n", + 'type' => 'object', + 'properties' => [ + 'OperationId' => [ + 'title' => '操作ID', + 'description' => 'The ID of the operation.'."\n", + 'type' => 'string', + 'example' => 'op_xxxxxxxx', + ], + 'Status' => [ + 'title' => '当前操作状态', + 'description' => 'The status of the operation.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'Message' => [ + 'title' => '操作相关信息', + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => '“ ”', + ], + 'Arguments' => [ + 'title' => '操作相关输出结果', + 'description' => 'The output of the operation.'."\n", + 'type' => 'string', + 'example' => '" "', + ], + ], + ], + 'Code' => [ + 'title' => '', + 'description' => 'The HTTP status code. A value of 200 indicates that the request is successful.'."\n", + 'type' => 'string', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\\\\\" \\\\\\"\\",\\n \\"RequestId\\": \\"A3488F1D-xxxx-xxxx-xxxx-5374BA0F3562\\",\\n \\"Data\\": {\\n \\"OperationId\\": \\"op_xxxxxxxx\\",\\n \\"Status\\": \\"INIT/RUNNING/SUCCESS/FAILURE\\\\n\\",\\n \\"Message\\": \\"\\\\\\"[{\\\\\\"vServerGroupId\\\\\\":\\\\\\"rsp-xxxx\\\\\\",\\\\\\"healthCheckHttpVersion\\\\\\":\\\\\\"http1.0\\\\\\",\\\\\\"status\\\\\\":\\\\\\"running\\\\\\",\\\\\\"gzip\\\\\\":\\\\\\"on\\\\\\",\\\\\\"requestId\\\\\\":\\\\\\"89xxxx\\\\\\",\\\\\\"description\\\\\\":\\\\\\"abcxxx\\\\\\",\\\\\\"bandwidth\\\\\\":-1,\\\\\\"healthCheckTimeout\\\\\\":10,\\\\\\"healthCheckType\\\\\\":\\\\\\"http\\\\\\",\\\\\\"aclStatus\\\\\\":\\\\\\"off\\\\\\",\\\\\\"unhealthyThreshold\\\\\\":3,\\\\\\"xForwardedFor_SLBID\\\\\\":\\\\\\"off\\\\\\",\\\\\\"healthCheckHttpCode\\\\\\":\\\\\\"http_3xx,http_2xx\\\\\\",\\\\\\"listenerForward\\\\\\":\\\\\\"off\\\\\\",\\\\\\"xForwardedFor\\\\\\":\\\\\\"on\\\\\\",\\\\\\"idleTimeout\\\\\\":15,\\\\\\"requestTimeout\\\\\\":60,\\\\\\"listenerPort\\\\\\":80,\\\\\\"healthCheckInterval\\\\\\":2,\\\\\\"healthCheckURI\\\\\\":\\\\\\"/\\\\\\",\\\\\\"scheduler\\\\\\":\\\\\\"rr\\\\\\",\\\\\\"healthyThreshold\\\\\\":3,\\\\\\"xForwardedFor_proto\\\\\\":\\\\\\"off\\\\\\",\\\\\\"xForwardedFor_SLBIP\\\\\\":\\\\\\"off\\\\\\",\\\\\\"stickySession\\\\\\":\\\\\\"off\\\\\\",\\\\\\"healthCheckMethod\\\\\\":\\\\\\"head\\\\\\",\\\\\\"healthCheck\\\\\\":\\\\\\"on\\\\\\",\\\\\\"rules\\\\\\":[],\\\\\\"aclIds\\\\\\":[]}]\\\\\\"\\",\\n \\"Arguments\\": \\"{\\\\n \\\\\\"tagMap\\\\\\":{\\\\n \\\\\\"cadt\\\\\\": [\\\\n \\\\\\"12xxxxxxx\\\\\\",\\\\n \\\\\\"34xxxxxxx\\\\\\"\\\\n ]\\\\n }\\\\n}\\"\\n },\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + 'title' => 'GetExecuteOperationResult', + ], + 'ListServices' => [ + 'summary' => '查看支持的服务列表', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '212309', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioCGSK4A', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'error', + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '', + 'type' => 'string', + 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ecs', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"error\\",\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": [\\n \\"ecs\\"\\n ]\\n}","type":"json"}]', + ], + 'ListOperations' => [ + 'summary' => '查看某服务支持的操作', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '212309', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioCGSK4A', + ], + ], + 'parameters' => [ + [ + 'name' => 'ServiceType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'NotFound', + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '', + 'type' => 'string', + 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Service' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ecs', + ], + 'Operation' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'addTags', + ], + 'DisplayName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Add Tag', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"NotFound\\",\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"Service\\": \\"ecs\\",\\n \\"Operation\\": \\"addTags\\",\\n \\"DisplayName\\": \\"Add Tag\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetOperationParams' => [ + 'summary' => '查看某操作的输入参数', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '212309', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioCGSK4A', + ], + ], + 'parameters' => [ + [ + 'name' => 'ServiceType', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'Operation', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'rename', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'getBpmOperationParams errors', + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '', + 'type' => 'string', + 'example' => 'F439A659-3B3D-50FB-A4BC-69FBF16413C8', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Service' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ecs', + ], + 'Operation' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rename', + ], + 'Attributes' => [ + 'description' => '', + 'type' => 'object', + 'example' => '{'."\n" + .' "tags": {'."\n" + .' "controlType": "KeyValue",'."\n" + .' "display": "Label",'."\n" + .' "orderBy": 0,'."\n" + .' "associatedLabel": true,'."\n" + .' "required": true'."\n" + .' }'."\n" + .' }', + ], + 'Properties' => [ + 'description' => '', + 'type' => 'object', + 'example' => '{'."\n" + .' "instanceId": "ResourceId",'."\n" + .' "regionId": "region",'."\n" + .' "appId": "appId"'."\n" + .' }', + ], + 'Outputs' => [ + 'description' => '', + 'type' => 'object', + 'example' => '{'."\n" + .' "instance_id": {'."\n" + .' "display": "ECS instance ID",'."\n" + .' "dataType": "String",'."\n" + .' "orderBy": 0,'."\n" + .' "attributeName": "instance_id",'."\n" + .' "enableVariable": "String",'."\n" + .' "required": true'."\n" + .' },'."\n" + .' "instance_name": {'."\n" + .' "display": "ECS name",'."\n" + .' "dataType": "String",'."\n" + .' "orderBy": 0,'."\n" + .' "attributeName": "instance_name",'."\n" + .' "required": true'."\n" + .' },'."\n" + .' "private_ip": {'."\n" + .' "display": "Intranet IP",'."\n" + .' "dataType": "String",'."\n" + .' "orderBy": 0,'."\n" + .' "value": "private_ip",'."\n" + .' "required": true'."\n" + .' }'."\n" + .' }', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"getBpmOperationParams errors\\",\\n \\"RequestId\\": \\"F439A659-3B3D-50FB-A4BC-69FBF16413C8\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Service\\": \\"ecs\\",\\n \\"Operation\\": \\"addTags\\",\\n \\"Attributes\\": {\\n \\"tags\\": {\\n \\"controlType\\": \\"KeyValue\\",\\n \\"display\\": \\"Label\\",\\n \\"orderBy\\": 0,\\n \\"associatedLabel\\": true,\\n \\"required\\": true\\n }\\n },\\n \\"Properties\\": {\\n \\"instanceId\\": \\"ResourceId\\",\\n \\"regionId\\": \\"region\\",\\n \\"appId\\": \\"appId\\"\\n },\\n \\"Outputs\\": {\\n \\"instance_id\\": {\\n \\"display\\": \\"ECS instance ID\\",\\n \\"dataType\\": \\"String\\",\\n \\"orderBy\\": 0,\\n \\"attributeName\\": \\"instance_id\\",\\n \\"enableVariable\\": \\"String\\",\\n \\"required\\": true\\n },\\n \\"instance_name\\": {\\n \\"display\\": \\"ECS name\\",\\n \\"dataType\\": \\"String\\",\\n \\"orderBy\\": 0,\\n \\"attributeName\\": \\"instance_name\\",\\n \\"required\\": true\\n },\\n \\"private_ip\\": {\\n \\"display\\": \\"Intranet IP\\",\\n \\"dataType\\": \\"String\\",\\n \\"orderBy\\": 0,\\n \\"value\\": \\"private_ip\\",\\n \\"required\\": true\\n }\\n }\\n }\\n}","type":"json"}]', + ], + 'ChangeResourceGroup' => [ + 'summary' => 'Changes the resource group to which an application or template belongs.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '150656', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioINUEOA', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the resource.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'P7RMVSVM9LOVYQOM', + ], + ], + [ + 'name' => 'NewResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the new resource group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rg-aek2ajbjoloa23q', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The type of the resource for which you want to change the resource group. Valid values: APPLICATION and TEMPLATE.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'APPLICATION', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A3488F1D-C444-17D0-BA4F-5374BA0F3562', + ], + 'Data' => [ + 'description' => 'No business data is returned for this parameter.'."\n", + 'type' => 'string', + 'example' => 'No business data is returned for this parameter.', + ], + 'Message' => [ + 'description' => 'The error message returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Code' => [ + 'description' => 'The HTTP status code. A value of 200 indicates that the request is successful. Other values indicate that the request failed.'."\n", + 'type' => 'string', + 'format' => 'int64', + 'example' => '200', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A3488F1D-xxxx-xxxx-xxxx-5374BA0F3562\\",\\n \\"Data\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<ChangeResourceGroupResponse>\\n <RequestId>A3488F1D-C444-17D0-BA4F-5374BA0F3562</RequestId>\\n <Data>无</Data>\\n <Message>无</Message>\\n <Code>200</Code>\\n</ChangeResourceGroupResponse>","errorExample":""}]', + 'title' => 'ChangeResourceGroup', + ], + 'AppFailOver' => [ + 'summary' => 'Switches a disaster recovery application to another supported zone.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '208078', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioJD8QWK', + ], + ], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'formData', + 'schema' => [ + 'title' => '应用ID', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'BE68D71ZY5YYIU9R', + ], + ], + [ + 'name' => 'FailZone', + 'in' => 'formData', + 'schema' => [ + 'title' => '容灾切换目标可用区', + 'description' => 'The destination zone to which you want to switch the disaster recovery application.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-g', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9656C816-1E9A-58D2-86D5-710678D61AF1', + ], + 'Message' => [ + 'title' => '报错信息', + 'description' => 'The returned message. If the request was successful, a success message is returned. If the request failed, an error message is returned.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Code' => [ + 'title' => '返回码', + 'description' => 'The response code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'title' => '容灾切换任务码TaskId', + 'description' => 'The disaster recovery switchover task ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7441', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9656C816-1E9A-58D2-86D5-710678D61AF1\\",\\n \\"Message\\": \\"The application has an incorrect state of the master/slave switching group. All groups must be in the state to be switched before switching!\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": 7441\\n}","type":"json"}]', + 'title' => 'AppFailOver', + 'description' => 'You can call this operation to switch a disaster recovery application to another supported zone.'."\n", + ], + 'GetPotentialFailZones' => [ + 'summary' => 'Queries the zones where the specified disaster recovery service can be switched.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '208010', + 'abilityTreeNodes' => [ + 'FEATUREbpstudio9F383C', + ], + ], + 'parameters' => [ + [ + 'name' => 'IsPlanId', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否为容灾集ID', + 'description' => 'Specifies whether the value of this parameter is the ID of a disaster recovery set.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ObjectId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'IsPlanId选择false传入ApplicationId（应用ID），IsPlanId选择true传入PlanId（容灾集ID）', + 'description' => 'If you set IsPlanId to false, specify the ID of a disaster recovery application. If you set IsPlanId to true, specify the ID of a disaster recovery set.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'FS3ATPTOSC4SE1GG', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '接口返回数据', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'BFB7F5C8-FE7A-06CA-9F87-ABBF6B848F0C', + ], + 'Message' => [ + 'title' => '报错信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'The specified ResourceIds are not found in our records.', + ], + 'Code' => [ + 'title' => '返回码', + 'description' => 'The response code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'title' => '当前容灾服务可切换的可用区列表', + 'description' => 'The zones where the current disaster recovery service can be switched.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '当前容灾服务可切换的可用区', + 'description' => 'The zone where the current disaster recovery service can be switched.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-f', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BFB7F5C8-FE7A-06CA-9F87-ABBF6B848F0C\\",\\n \\"Message\\": \\"The specified ResourceIds are not found in our records.\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": [\\n \\"cn-hangzhou-f\\"\\n ]\\n}","type":"json"}]', + 'title' => 'GetPotentialFailZones', + 'description' => 'You can call this operation to query the zones where the specified disaster recovery service can be switched.'."\n", + ], + 'GetFoTaskStatus' => [ + 'summary' => 'Queries the status of a disaster recovery switchover task by task ID.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '208114', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioSRFDAT', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'formData', + 'schema' => [ + 'title' => '容灾切换任务ID', + 'description' => 'The disaster recovery switchover task ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2615', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '923692F0-A15B-58B4-BAF4-2AFA4AF46240', + ], + 'Message' => [ + 'title' => '报错信息', + 'description' => 'The returned message. If the request was successful, a success message is returned. If the request failed, an error message is returned.'."\n", + 'type' => 'string', + 'example' => 'OKITHEVRQCN6ULQG', + ], + 'Code' => [ + 'title' => '返回码', + 'description' => 'The response code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'title' => '容灾切换任务Task的状态', + 'description' => 'The status of the switchover task.'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"923692F0-A15B-58B4-BAF4-2AFA4AF46240\\",\\n \\"Message\\": \\"OKITHEVRQCN6ULQG\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"Running\\"\\n}","type":"json"}]', + 'title' => 'GetFoTaskStatus', + 'description' => 'You can call this operation to query the status of a disaster recovery switchover task by task ID.'."\n", + 'responseParamsDescription' => 'Task states:'."\n" + ."\n" + .'* Creating: The task is being created.'."\n" + .'* Modified: The task is modified.'."\n" + .'* Verifying: The task is being verified.'."\n" + .'* Verified_Failure: The task failed to pass the verification.'."\n" + .'* Verified_Success: The task passed the verification.'."\n" + .'* Valuating: Fees are being calculated for the task.'."\n" + .'* Valuating_Failure: Fees failed to be calculated for the task.'."\n" + .'* Valuating_Success: Fees are calculated for the task.'."\n" + .'* Deploying: The task is being deployed.'."\n" + .'* Deployed_Failure: The task failed to be deployed.'."\n" + .'* Partially_Deployed_Success: Some resources of the task are deployed.'."\n" + .'* Deployed_Success: The task is deployed.'."\n" + .'* Destroying: The task is being released.'."\n" + .'* Delayed_Destroy: The task release is delayed.'."\n" + .'* Destroyed_Failure: The task failed to be released.'."\n" + .'* Partially_Destroyed_Success: Some resources of the task are released.'."\n" + .'* Destroyed_Success: The task is released.'."\n" + .'* Revised: The task architecture is adjusted.'."\n" + .'* Verifying_In_Revision: The task resources are being verified during architecture adjustment.'."\n" + .'* Verified_Failure_In_Revision: The task resources failed to pass the verification during architecture adjustment.'."\n" + .'* Verified_Success_In_Revision: The task resources are verified during architecture adjustment.'."\n" + .'* Valuating_In_Revision: Fees are being calculated for the task during architecture adjustment.'."\n" + .'* Valuating_Failure_In_Revision: Fees failed to be calculated for the task during architecture adjustment.'."\n" + .'* Valuating_Success_In_Revision: Fees are calculated for the task during architecture adjustment.'."\n", + ], + 'AppFailBack' => [ + 'summary' => 'Switches a disaster recovery application back to the primary zone.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '208124', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioJD8QWK', + ], + ], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'formData', + 'schema' => [ + 'title' => '应用ID', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '61ZW1DY5Y3FSAOO2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '7036DDBE-0ABA-52D7-A39D-75E511970F07', + ], + 'Message' => [ + 'title' => '报错信息', + 'description' => 'The returned message. If the request was successful, a success message is returned. If the request failed, an error message is returned.'."\n", + 'type' => 'string', + 'example' => 'OKITHEVRQCN6ULQG', + ], + 'Code' => [ + 'title' => '返回码', + 'description' => 'The response code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'title' => '容灾任务切回TaskId', + 'description' => 'The disaster recovery switchback task ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3309', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7036DDBE-0ABA-52D7-A39D-75E511970F07\\",\\n \\"Message\\": \\"OKITHEVRQCN6ULQG\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": 3309\\n}","type":"json"}]', + 'title' => 'AppFailBack', + 'description' => 'You can call this operation to switch a disaster recovery application back to the primary zone.'."\n", + ], + 'ListFoCreatedApps' => [ + 'summary' => 'Queries the information about all disaster recovery plans of the current account.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '207619', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioJLQBYK', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '接口返回数据', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '40F63F07-3AB6-53B3-8825-0580C130E3EA', + ], + 'Message' => [ + 'title' => '报错信息', + 'description' => 'The returned error message.'."\n", + 'type' => 'string', + 'example' => 'Cannot find region according to your domain.', + ], + 'Code' => [ + 'title' => '返回码', + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'title' => '返回值数据列表', + 'description' => 'The templates.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '返回值数据', + 'description' => 'The application data.'."\n", + 'type' => 'object', + 'properties' => [ + 'ApplicationId' => [ + 'title' => '应用ID', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'example' => 'JIX9NEZUALGS46UI', + ], + 'Title' => [ + 'title' => '容灾服务名称', + 'description' => 'The title.'."\n", + 'type' => 'string', + 'example' => '容灾计划1', + ], + 'ReportUrl' => [ + 'title' => '报告路径URL', + 'description' => 'The URL of the error report.'."\n", + 'type' => 'string', + 'example' => 'https://api.aliyun.com/troubleshoot?q=ServiceUnavailable&product=BPStudio&requestId=4CDA03A3-C652-1408-8ABD-7E652A7CBFB6', + ], + 'Status' => [ + 'title' => '容灾服务状态', + 'description' => 'The state of the application.'."\n", + 'type' => 'string', + 'example' => 'Deployed_Success'."\n" + .'Destroyed_Success', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40F63F07-3AB6-53B3-8825-0580C130E3EA\\",\\n \\"Message\\": \\"Cannot find region according to your domain.\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"ApplicationId\\": \\"JIX9NEZUALGS46UI\\",\\n \\"Title\\": \\"Disaster Recovery Plan\\",\\n \\"ReportUrl\\": \\"14318082782*****/drs-application-3ET9ZEVPOWRDZK0N.pdf\\",\\n \\"Status\\": \\"Deployed_Success\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListFoCreatedApps', + 'description' => 'Queries the information about all disaster recovery plans of the current account.'."\n", + 'requestParamsDescription' => 'No request parameters are required.'."\n", + 'responseParamsDescription' => 'The states of the applications.'."\n" + ."\n" + .'* Creating: The task is being created.'."\n" + .'* Modified: The task is modified.'."\n" + .'* Verifying: The task is being verified.'."\n" + .'* Verified_Failure: The task failed to pass the verification.'."\n" + .'* Verified_Success: The task passed the verification.'."\n" + .'* Valuating: Fees are being calculated for the task.'."\n" + .'* Valuating_Failure: Fees failed to be calculated for the task.'."\n" + .'* Valuating_Success: Fees are calculated for the task.'."\n" + .'* Deploying: The task is being deployed.'."\n" + .'* Deployed_Failure: The task failed to be deployed.'."\n" + .'* Partially_Deployed_Success: Some resources of the task are deployed.'."\n" + .'* Deployed_Success: The task is deployed.'."\n" + .'* Destroying: The task is being released.'."\n" + .'* Delayed_Destroy: The task release is delayed.'."\n" + .'* Destroyed_Failure: The task failed to be released.'."\n" + .'* Partially_Destroyed_Success: Some resources of the task are released.'."\n" + .'* Destroyed_Success: The task is released.'."\n" + .'* Revised: The task architecture is adjusted.'."\n" + .'* Verifying_In_Revision: The task resources are being verified during architecture adjustment.'."\n" + .'* Verified_Failure_In_Revision: The task resources failed to pass the verification during architecture adjustment.'."\n" + .'* Verified_Success_In_Revision: The task resources are verified during architecture adjustment.'."\n" + .'* Valuating_In_Revision: Fees are being calculated for the task during architecture adjustment.'."\n" + .'* Valuating_Failure_In_Revision: Fees failed to be calculated for the task during architecture adjustment.'."\n" + .'* Valuating_Success_In_Revision: Fees are calculated for the task during architecture adjustment.'."\n", + ], + 'InitAppFailOver' => [ + 'summary' => 'Prepares for application switchover and initiates a switchover task.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '208065', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioCGSK4A', + ], + ], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'formData', + 'schema' => [ + 'title' => '应用ID', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '002XWH7MXB8MJRU0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', + ], + 'Message' => [ + 'title' => '报错信息', + 'description' => 'The returned message. If the request was successful, a success message is returned. If the request failed, an error message is returned.'."\n", + 'type' => 'string', + 'example' => 'Unsupported Operation PrepareEvent->FailOverPrepareSuccess FoApp_DDLJK2WM8ETU9JAC', + ], + 'Code' => [ + 'title' => '返回码', + 'description' => 'The response code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'title' => '返回容灾切换任务ID（TaskId）', + 'description' => 'The switchover task ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7250', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Message\\": \\"Unsupported Operation PrepareEvent->FailOverPrepareSuccess FoApp_DDLJK2WM8ETU9JAC\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": 7250\\n}","type":"json"}]', + 'title' => 'InitAppFailOver', + 'description' => 'You can call this operation to prepare for application switchover and initiate a switchover task.'."\n", + ], + 'ListTagResources' => [ + 'summary' => 'Queries the tags of one or more applications or templates.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '173661', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioCGSK4A', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '幂等标记', + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '1600765710019', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'title' => '区域ID', + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '下一个查询开始Token', + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源类型', + 'description' => 'The resource type.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Application', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'title' => '资源ID,最多 50个子项', + 'description' => 'The resource IDs. You can specify a maximum number of 50 IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'This parameter specifies one or more application IDs when ResourceType is set to application. This parameter specifies one or more template IDs when ResourceType is set to template.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'A926QK1X89YF2G62', + ], + 'required' => true, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'title' => '标签列表，最多包含20个子项', + 'description' => 'The tags. A maximum of 20 tags are supported.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about a tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'description' => 'The key of the tag.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Label 1'."\n", + ], + 'Value' => [ + 'title' => '标签值', + 'description' => 'The value of the tag.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Label value 1'."\n", + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'title' => '下一个查询开始Token，NextToken为空说明没有下一个', + 'description' => 'The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results. If the NextToken parameter is empty, no next page exists.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '847C9D0A-BABD-589C-8A9C-6464409EDED9', + ], + 'Code' => [ + 'description' => 'The HTTP status code. A value of 200 indicates that the request is successful.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The error message returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'bp.java.nopowerContact', + ], + 'TagResources' => [ + 'title' => 'TagResource', + 'description' => 'The tags that are added to the resources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tags that are added to specified one or more resources.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => 'The resource type. Valid values: application and template.'."\n", + 'type' => 'string', + 'example' => 'application', + ], + 'TagValue' => [ + 'description' => 'The value of the tag.'."\n", + 'type' => 'string', + 'example' => 'Value', + ], + 'ResourceId' => [ + 'description' => 'The ID of the resource.'."\n", + 'type' => 'string', + 'example' => 'MW7T1820ACJX9BI7', + ], + 'TagKey' => [ + 'description' => 'The key of the tag.'."\n", + 'type' => 'string', + 'example' => 'Key', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'bp.java.nopowerContact', + 'errorMessage' => 'You do not have permission to use this function. Please contact the main account or permission administrator to authorize the relevant permissions.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"1\\",\\n \\"RequestId\\": \\"847C9D0A-BABD-589C-8A9C-6464409EDED9\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"bp.java.nopowerContact\\",\\n \\"TagResources\\": [\\n {\\n \\"ResourceType\\": \\"application\\",\\n \\"TagValue\\": \\"Value\\",\\n \\"ResourceId\\": \\"MW7T1820ACJX9BI7\\",\\n \\"TagKey\\": \\"Key\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListTagResources', + ], + 'ExecuteTask' => [ + 'summary' => '创建任务', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioJLICAE', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2615', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2615', + ], + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test_name', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'FINISH', + ], + 'ErrorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SyntaxError', + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'No Permission.', + ], + [ + 'errorCode' => 'NoPermissions', + 'errorMessage' => 'No permissions.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": {\\n \\"Id\\": 2615,\\n \\"Name\\": \\"test_name\\",\\n \\"Status\\": \\"FINISH\\",\\n \\"ErrorMessage\\": \\"SyntaxError\\"\\n },\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + ], + 'CreateTask' => [ + 'summary' => '创建任务', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioJLICAE', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProcessId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'P3KTG43SW7**6A17I', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'JXT3MLZJ56**65D6', + ], + ], + [ + 'name' => 'Variables', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '"${var}":"value"', + 'example' => '"${var}":"value"', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'F439A659-3B3D-50FB-A4BC-69FBF16413C8', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Data' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1994', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermissions', + 'errorMessage' => 'No permissions.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F439A659-3B3D-50FB-A4BC-69FBF16413C8\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": 1994,\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + ], + 'GetTask' => [ + 'summary' => '获取Task信息', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbpstudioJLICAE', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2615', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1333', + ], + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test_name', + ], + 'ProcessId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '64QQBC02**FA3W3G', + ], + 'AppId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'JXT**LZJ568665D6', + ], + 'InstanceIds' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{\\"app\\":\\"JJXT**LZJ568665D6\\"}', + ], + 'ErrorMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SyntaxError', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'FINISH ', + ], + 'GmtCreate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-08-21 14:07:02', + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermissions', + 'errorMessage' => 'No permissions.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": {\\n \\"Id\\": 1333,\\n \\"Name\\": \\"test_name\\",\\n \\"ProcessId\\": \\"64QQBC02**FA3W3G\\",\\n \\"AppId\\": \\"JXT**LZJ568665D6\\",\\n \\"InstanceIds\\": \\"{\\\\\\\\\\\\\\"app\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"JJXT**LZJ568665D6\\\\\\\\\\\\\\"}\\",\\n \\"ErrorMessage\\": \\"SyntaxError\\",\\n \\"Status\\": \\"FINISH \\",\\n \\"GmtCreate\\": \\"2025-08-21 14:07:02\\"\\n },\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'bpstudio.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'bpstudio.ap-southeast-1.aliyuncs.com', + ], + ], +]; |