summaryrefslogtreecommitdiff
path: root/data/en_us/bpstudio
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/bpstudio
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/bpstudio')
-rw-r--r--data/en_us/bpstudio/2020-07-10/api-docs.php331
-rw-r--r--data/en_us/bpstudio/2021-09-31/api-docs.php8655
2 files changed, 4233 insertions, 4753 deletions
diff --git a/data/en_us/bpstudio/2020-07-10/api-docs.php b/data/en_us/bpstudio/2020-07-10/api-docs.php
index e18041c..d3f968f 100644
--- a/data/en_us/bpstudio/2020-07-10/api-docs.php
+++ b/data/en_us/bpstudio/2020-07-10/api-docs.php
@@ -1,18 +1,12 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'BPStudio',
- 'version' => '2020-07-10',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'BPStudio', 'version' => '2020-07-10'],
'directories' => [
[
'id' => 0,
'title' => '其它',
'type' => 'directory',
- 'children' => [
- 'GetDeployDetail',
- ],
+ 'children' => ['GetDeployDetail'],
],
],
'components' => [
@@ -21,14 +15,8 @@
'apis' => [
'GetDeployDetail' => [
'summary' => '分页查询部署清单',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -39,93 +27,48 @@
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '104355',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioJLICAE',
- ],
+ 'abilityTreeNodes' => ['FEATUREbpstudioJLICAE'],
],
'parameters' => [
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '30GRJUY95TMYWBYJ',
- ],
+ 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '30GRJUY95TMYWBYJ'],
],
[
'name' => 'ResourceGroupId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-aekz44tg3bnpyba',
- ],
+ 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'rg-aekz44tg3bnpyba'],
],
[
'name' => 'NextToken',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
],
[
'name' => 'MaxResults',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '40',
- ],
+ 'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '40'],
],
[
'name' => 'ResourceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vsw-xxxxxxxxxxxx',
- ],
+ 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'vsw-xxxxxxxxxxxx'],
],
[
'name' => 'ResourceType',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ecs',
- ],
+ 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'ecs'],
],
[
'name' => 'ResourceName',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rgm-ecs',
- ],
+ 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'rgm-ecs'],
],
[
'name' => 'RefId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1713597738',
- ],
+ 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '1713597738'],
],
],
'responses' => [
@@ -133,16 +76,8 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E15B71B4-5D8F-5484-BC07-989E2987EE7C',
- ],
+ 'Message' => ['description' => '', 'type' => 'string', 'example' => 'Success'],
+ 'RequestId' => ['description' => '', 'type' => 'string', 'example' => 'E15B71B4-5D8F-5484-BC07-989E2987EE7C'],
'Data' => [
'description' => '',
'type' => 'array',
@@ -150,31 +85,14 @@
'description' => '',
'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Revised',
- ],
+ 'Status' => ['description' => '', 'type' => 'string', 'example' => 'Revised'],
'OrderIdList' => [
'description' => '',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '[11396641]',
- ],
- ],
- 'AppId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'EQ4W772D0VJ33IV1',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1645516991000',
+ 'items' => ['description' => '', 'type' => 'string', 'example' => '[11396641]'],
],
+ 'AppId' => ['description' => '', 'type' => 'string', 'example' => 'EQ4W772D0VJ33IV1'],
+ 'CreateTime' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1645516991000'],
'ResourceList' => [
'description' => '',
'type' => 'array',
@@ -182,82 +100,24 @@
'description' => '',
'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Finish',
- ],
- 'ResourceType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vpc',
- ],
- 'ModifiedTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1714031840000',
- ],
- 'Remark' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{\\"Description\\":\\"\\",\\"ClassicLinkEnabled\\":false,\\"ResourceGroupId\\":\\"rg-acfm4mlwqjalz7a\\",\\"SecondaryCidrBlocks\\":[],\\"CidrBlock\\":\\"192.168.0.0/16\\",\\"UserCidrs\\":[],\\"NetworkAclNum\\":\\"0\\",\\"VRouterId\\":\\"vrt-m5ek7vcyld0x5ym8m9hix\\",\\"OwnerId\\":1986207497633020,\\"AssociatedCens\\":[],\\"id\\":\\"vpc-m5e3c9nz4lj19byan9m2g\\",\\"CloudResources\\":[{\\"ResourceCount\\":1,\\"ResourceType\\":\\"VSwitch\\"},{\\"ResourceCount\\":1,\\"ResourceType\\":\\"VRouter\\"},{\\"ResourceCount\\":1,\\"ResourceType\\":\\"RouteTable\\"}],\\"Tags\\":[],\\"Status\\":\\"Available\\",\\"IsDefault\\":false,\\"RequestId\\":\\"494646FB-14C0-5B4C-9684-B6EFBF4DF01C\\",\\"SupportIpv4Gateway\\":false,\\"Ipv4GatewayId\\":\\"\\",\\"VSwitchIds\\":[\\"vsw-m5egl9wtppiadysjwlgb1\\"],\\"VpcId\\":\\"vpc-m5e3c9nz4lj19byan9m2g\\",\\"CreationTime\\":\\"2024-04-25T07:56:59Z\\",\\"VpcName\\":\\"vpc\\",\\"refId\\":\\"1714031764_0\\",\\"RegionId\\":\\"cn-qingdao\\",\\"Ipv6CidrBlock\\":\\"\\",\\"Ipv6CidrBlocks\\":[]}',
- ],
- 'NodeName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vpc',
- ],
- 'ChargeType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Free',
- ],
- 'BuyDuration' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'ResourceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'i-2zehnzxqixu1pywsfbx1',
- ],
- 'ResourceCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ecs',
- ],
- 'RefId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1716049421',
- ],
- 'MonitorURL' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'https://cloudmonitor.console.aliyun.com/?#/generalcharts/product=vpc&group=&type=&return&region=cn-hangzhou&dimension=instanceId:vpc-bp1n6uc5jqxtff2euhnx5',
- ],
- 'ExecutionStrategy' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'OpenApi',
- ],
+ 'Status' => ['description' => '', 'type' => 'string', 'example' => 'Finish'],
+ 'ResourceType' => ['description' => '', 'type' => 'string', 'example' => 'vpc'],
+ 'ModifiedTime' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1714031840000'],
+ 'Remark' => ['description' => '', 'type' => 'string', 'example' => '{\\"Description\\":\\"\\",\\"ClassicLinkEnabled\\":false,\\"ResourceGroupId\\":\\"rg-acfm4mlwqjalz7a\\",\\"SecondaryCidrBlocks\\":[],\\"CidrBlock\\":\\"192.168.0.0/16\\",\\"UserCidrs\\":[],\\"NetworkAclNum\\":\\"0\\",\\"VRouterId\\":\\"vrt-m5ek7vcyld0x5ym8m9hix\\",\\"OwnerId\\":1986207497633020,\\"AssociatedCens\\":[],\\"id\\":\\"vpc-m5e3c9nz4lj19byan9m2g\\",\\"CloudResources\\":[{\\"ResourceCount\\":1,\\"ResourceType\\":\\"VSwitch\\"},{\\"ResourceCount\\":1,\\"ResourceType\\":\\"VRouter\\"},{\\"ResourceCount\\":1,\\"ResourceType\\":\\"RouteTable\\"}],\\"Tags\\":[],\\"Status\\":\\"Available\\",\\"IsDefault\\":false,\\"RequestId\\":\\"494646FB-14C0-5B4C-9684-B6EFBF4DF01C\\",\\"SupportIpv4Gateway\\":false,\\"Ipv4GatewayId\\":\\"\\",\\"VSwitchIds\\":[\\"vsw-m5egl9wtppiadysjwlgb1\\"],\\"VpcId\\":\\"vpc-m5e3c9nz4lj19byan9m2g\\",\\"CreationTime\\":\\"2024-04-25T07:56:59Z\\",\\"VpcName\\":\\"vpc\\",\\"refId\\":\\"1714031764_0\\",\\"RegionId\\":\\"cn-qingdao\\",\\"Ipv6CidrBlock\\":\\"\\",\\"Ipv6CidrBlocks\\":[]}'],
+ 'NodeName' => ['description' => '', 'type' => 'string', 'example' => 'vpc'],
+ 'ChargeType' => ['description' => '', 'type' => 'string', 'example' => 'Free'],
+ 'BuyDuration' => ['description' => '', 'type' => 'string', 'example' => ''],
+ 'ResourceId' => ['description' => '', 'type' => 'string', 'example' => 'i-2zehnzxqixu1pywsfbx1'],
+ 'ResourceCode' => ['description' => '', 'type' => 'string', 'example' => 'ecs'],
+ 'RefId' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1716049421'],
+ 'MonitorURL' => ['description' => '', 'type' => 'string', 'example' => 'https://cloudmonitor.console.aliyun.com/?#/generalcharts/product=vpc&group=&type=&return&region=cn-hangzhou&dimension=instanceId:vpc-bp1n6uc5jqxtff2euhnx5'],
+ 'ExecutionStrategy' => ['description' => '', 'type' => 'string', 'example' => 'OpenApi'],
'Operation' => [
'description' => '',
'type' => 'object',
'properties' => [
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ecsDelete',
- ],
- 'Operations' => [
- 'description' => '',
- 'type' => 'object',
- 'example' => '',
- ],
+ 'Name' => ['description' => '', 'type' => 'string', 'example' => 'ecsDelete'],
+ 'Operations' => ['description' => '', 'type' => 'object', 'example' => ''],
],
],
'ResourceTimeList' => [
@@ -265,123 +125,46 @@
'items' => [
'type' => 'object',
'properties' => [
- 'id' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'BizId' => [
- 'type' => 'string',
- ],
- 'CreationStartTime' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'CreationEndTime' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'id' => ['type' => 'integer', 'format' => 'int64'],
+ 'BizId' => ['type' => 'string'],
+ 'CreationStartTime' => ['type' => 'integer', 'format' => 'int64'],
+ 'CreationEndTime' => ['type' => 'integer', 'format' => 'int64'],
],
],
],
- 'ExpiredTime' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'ExpiredTime' => ['type' => 'integer', 'format' => 'int64'],
],
],
],
- 'Error' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'OperationNotSupport.SubscriptionCommodityCanNotDelete',
- ],
- 'FailStatus' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '',
- ],
- 'TerraformScriptUrl' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'https://cadt-studio-publish.oss-cn-hangzhou.aliyuncs.com/1986207497633020/app_EXN4FNUR12M35KJM.tf?Expires=1716967763&OSSAccessKeyId=*******nw4rvYAweFuQc3&Signature=%2********lYROqJLNvyA8g6qD9U%3D',
- ],
- 'ExecutionTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '',
- ],
- 'PdfUrl' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'https://cadt-studio-publish.oss-cn-hangzhou.aliyuncs.com/1986207497633020/deployReport-EXN4FNUR12M35KJM.pdf?Expires=1716967763&OSSAccessKeyId=********nw4rvYAweFuQc3&Signature=*******fKo6164wykT9jBOsSGeQ%3D',
- ],
- 'ResourceGroupId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'rg-aekzhfgmw4e6fwq',
- ],
- 'CurrentProcess' => [
- 'title' => '当前流程: IMPORT/DEPLOY',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DEPLOY',
- ],
- 'DeployPercent' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0',
- ],
+ 'Error' => ['description' => '', 'type' => 'string', 'example' => 'OperationNotSupport.SubscriptionCommodityCanNotDelete'],
+ 'FailStatus' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => ''],
+ 'TerraformScriptUrl' => ['description' => '', 'type' => 'string', 'example' => 'https://cadt-studio-publish.oss-cn-hangzhou.aliyuncs.com/1986207497633020/app_EXN4FNUR12M35KJM.tf?Expires=1716967763&OSSAccessKeyId=*******nw4rvYAweFuQc3&Signature=%2********lYROqJLNvyA8g6qD9U%3D'],
+ 'ExecutionTime' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => ''],
+ 'PdfUrl' => ['description' => '', 'type' => 'string', 'example' => 'https://cadt-studio-publish.oss-cn-hangzhou.aliyuncs.com/1986207497633020/deployReport-EXN4FNUR12M35KJM.pdf?Expires=1716967763&OSSAccessKeyId=********nw4rvYAweFuQc3&Signature=*******fKo6164wykT9jBOsSGeQ%3D'],
+ 'ResourceGroupId' => ['description' => '', 'type' => 'string', 'example' => 'rg-aekzhfgmw4e6fwq'],
+ 'CurrentProcess' => ['title' => '当前流程: IMPORT/DEPLOY', 'description' => '', 'type' => 'string', 'example' => 'DEPLOY'],
+ 'DeployPercent' => ['description' => '', 'type' => 'number', 'format' => 'double', 'example' => '0'],
'DeployingNodeList' => [
'description' => '',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'example' => '[{"nodeNameList":"vpc","nodeType":"vpc"},{"nodeNameList":"vswitch","nodeType":"vswitch"}]',
- ],
+ 'items' => ['description' => '', 'type' => 'object', 'example' => '[{"nodeNameList":"vpc","nodeType":"vpc"},{"nodeNameList":"vswitch","nodeType":"vswitch"}]'],
],
'DeployedNodeList' => [
'description' => '',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'example' => '[{"nodeNameList":"vpc","nodeType":"vpc"},{"nodeNameList":"vswitch","nodeType":"vswitch"}]',
- ],
+ 'items' => ['description' => '', 'type' => 'object', 'example' => '[{"nodeNameList":"vpc","nodeType":"vpc"},{"nodeNameList":"vswitch","nodeType":"vswitch"}]'],
],
'DeletingNodeList' => [
'description' => '',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'example' => '[{"nodeNameList":"vpc","nodeType":"vpc"},{"nodeNameList":"vswitch","nodeType":"vswitch"}]',
- ],
+ 'items' => ['description' => '', 'type' => 'object', 'example' => '[{"nodeNameList":"vpc","nodeType":"vpc"},{"nodeNameList":"vswitch","nodeType":"vswitch"}]'],
],
],
],
],
- 'Code' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'NextToken' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
+ 'Code' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'TotalCount' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'NextToken' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
],
],
],
@@ -390,13 +173,7 @@
],
],
'endpoints' => [
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'bpstudio.cn-hangzhou.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'bpstudio.ap-southeast-1.aliyuncs.com',
- ],
+ ['regionId' => 'cn-hangzhou', 'endpoint' => 'bpstudio.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-1', 'endpoint' => 'bpstudio.ap-southeast-1.aliyuncs.com'],
],
];
diff --git a/data/en_us/bpstudio/2021-09-31/api-docs.php b/data/en_us/bpstudio/2021-09-31/api-docs.php
index 604f39f..ee1ce73 100644
--- a/data/en_us/bpstudio/2021-09-31/api-docs.php
+++ b/data/en_us/bpstudio/2021-09-31/api-docs.php
@@ -1,724 +1,249 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'BPStudio',
- 'version' => '2021-09-31',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'BPStudio', 'version' => '2021-09-31'],
'directories' => [
[
- 'id' => 356458,
- 'title' => null,
+ 'children' => ['ValuateTemplate', 'GetLinkageAttributesTemplate'],
'type' => 'directory',
- 'children' => [
- 'GetToken',
- ],
+ 'title' => 'Template',
],
[
- 'id' => 356460,
- 'title' => null,
+ 'children' => ['GetApplicationVariables', 'ReConfigApplication', 'GetApplicationVariables4Fail', 'ListApplication', 'DeployApplication', 'ReleaseApplication', 'ValidateApplication', 'ValuateApplication', 'GetResource4ModifyRecord', 'GetResult4QueryInstancePrice4Modify', 'ModifyApplicationSpec', 'QueryInstancePrice4Modify', 'QueryInstanceSpec4Modify'],
'type' => 'directory',
- 'children' => [
- 'GetTemplate',
- 'ListTemplate',
- 'ValuateTemplate',
- 'GetLinkageAttributesTemplate',
- ],
+ 'title' => 'Application',
],
[
- 'id' => 356465,
- 'title' => null,
+ 'children' => ['ExecuteOperationSync', 'ExecuteOperationASync', 'GetExecuteOperationResult', 'GetOperationParams'],
'type' => 'directory',
- 'children' => [
- 'GetApplicationVariables',
- 'ReConfigApplication',
- 'GetApplicationVariables4Fail',
- 'CreateApplication',
- 'DeleteApplication',
- 'GetApplication',
- 'ListApplication',
- 'DeployApplication',
- 'ReleaseApplication',
- 'ValidateApplication',
- 'ValuateApplication',
- 'GetResource4ModifyRecord',
- 'GetResult4QueryInstancePrice4Modify',
- 'ModifyApplicationSpec',
- 'QueryInstancePrice4Modify',
- 'QueryInstanceSpec4Modify',
- ],
+ 'title' => 'Application operations',
],
[
- 'id' => 356482,
- 'title' => null,
+ 'children' => ['AppFailOver', 'GetPotentialFailZones', 'GetFoTaskStatus', 'AppFailBack', 'ListFoCreatedApps', 'InitAppFailOver'],
'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',
- ],
+ 'title' => 'Disaster recovery service',
],
[
- 'id' => 356498,
- 'title' => null,
+ 'children' => ['ExecuteTask', 'ChangeResourceGroup', 'CreateApplication', 'CreateTask', 'DeleteApplication', 'GetApplication', 'GetTask', 'GetTemplate', 'GetToken', 'ListOperations', 'ListServices', 'ListTagResources', 'ListTemplate'],
'type' => 'directory',
- 'children' => [
- 'ListTagResources',
- 'ExecuteTask',
- 'CreateTask',
- 'GetTask',
- ],
+ 'title' => 'Others',
],
],
'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',
- ],
+ 'AppFailBack' => [
+ 'summary' => 'Fails back a disaster recovery application to the primary zone.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
- 'deprecated' => true,
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '91666',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioCGSK4A',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeCode' => '208124',
+ 'abilityTreeNodes' => ['FEATUREbpstudioJD8QWK'],
],
'parameters' => [
[
- 'name' => 'ResourceGroupId',
+ 'name' => 'ApplicationId',
'in' => 'formData',
- 'schema' => [
- 'title' => '资源组ID',
- 'description' => 'The ID of the resource group.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-aekzhfgmw4e6fwq',
- ],
+ 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '61ZW1DY5Y3FSAOO2'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'The response parameters.',
'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',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '7036DDBE-0ABA-52D7-A39D-75E511970F07'],
+ 'Message' => ['description' => 'The returned message. If the request was successful, a success message is returned. If the request failed, an error message is returned.', 'type' => 'string', 'title' => '', 'example' => 'OKITHEVRQCN6ULQG'],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'title' => '', 'example' => '200'],
+ 'Data' => ['description' => 'The disaster recovery switchback task ID.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3309'],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 200 => [
- [
- 'errorCode' => 'Success',
- 'errorMessage' => 'The transaction is successful.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'ServiceError',
- 'errorMessage' => 'A server error occurred. Please try again later.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'AppFailBack',
+ 'description' => 'Fails back a disaster recovery application to the primary zone.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AppFailBack'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bpstudio:AppFailBack',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
+ ],
],
],
],
- '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>',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7036DDBE-0ABA-52D7-A39D-75E511970F07\\",\\n \\"Message\\": \\"OKITHEVRQCN6ULQG\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": 3309\\n}","type":"json"}]',
],
- 'GetTemplate' => [
- 'summary' => 'Gets template images and information about architecture diagrams.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AppFailOver' => [
+ 'summary' => 'Switches a disaster recovery set to a supported zone.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '91665',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioJLICAE',
- 'FEATUREbpstudio3E4W4L',
- ],
+ 'abilityTreeCode' => '208078',
+ 'abilityTreeNodes' => ['FEATUREbpstudioJD8QWK'],
],
'parameters' => [
[
- 'name' => 'TemplateId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'Template ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'XFKR6WYRVS24S07R',
- ],
- ],
- [
- 'name' => 'Region',
+ 'name' => 'ApplicationId',
'in' => 'formData',
- 'schema' => [
- 'description' => 'Template Area',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the application.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'BE68D71ZY5YYIU9R'],
],
[
- 'name' => 'ResourceGroupId',
+ 'name' => 'FailZone',
'in' => 'formData',
- 'schema' => [
- 'description' => 'ResourceGroup ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-aekzhfgmw4e6fwq',
- ],
+ 'schema' => ['description' => 'The destination zone for the switchover.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'cn-hangzhou-g'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'The data returned.',
'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',
- ],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '9656C816-1E9A-58D2-86D5-710678D61AF1'],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'The application has an incorrect state of the master/slave switching group. All groups must be in the state to be switched before switching!'],
+ 'Code' => ['description' => 'The return code.', 'type' => 'string', 'title' => '', 'example' => '200'],
+ 'Data' => ['description' => 'The ID of the switchover task (TaskId).', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '7441'],
],
- 'description' => '',
+ 'example' => '',
],
],
],
- '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.',
+ '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' => 'Switches a disaster recovery set to a supported zone.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AppFailOver'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bpstudio:AppFailOver',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
+ ],
],
],
],
- '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',
- ],
+ 'ChangeResourceGroup' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '91668',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioRJ9IF1',
- ],
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeCode' => '150656',
+ 'abilityTreeNodes' => ['FEATUREbpstudioINUEOA'],
],
'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',
+ 'name' => 'ResourceId',
'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,
- ],
+ 'schema' => ['description' => 'The ID of the CADT application or template.', 'type' => 'string', 'required' => true, 'example' => 'P7RMVSVM9LOVYQOM', 'title' => ''],
],
[
- 'name' => 'ResourceGroupId',
+ 'name' => 'NewResourceGroupId',
'in' => 'formData',
- 'schema' => [
- 'description' => 'The ID of the resource group.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-acfmyjt3c5om3hi',
- ],
+ 'schema' => ['description' => 'The ID of the new resource group.', 'type' => 'string', 'required' => true, 'example' => 'rg-aek2ajbjoloa23q', 'title' => ''],
],
[
- 'name' => 'Tag',
+ 'name' => 'ResourceType',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'type' => 'string',
- ],
- 'Value' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
+ 'schema' => ['description' => 'The type of the resource whose resource group you want to change. Valid values: APPLICATION and TEMPLATE.', 'type' => 'string', 'required' => true, 'example' => 'APPLICATION', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'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',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A3488F1D-xxxx-xxxx-xxxx-5374BA0F3562'],
+ 'Data' => ['description' => 'The data returned. This parameter is not used.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'Message' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'Code' => ['description' => 'The status code. A value of 200 indicates success. Other values indicate failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
],
+ 'example' => '',
],
],
],
- '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.',
+ 'title' => 'ChangeResourceGroup',
+ 'summary' => 'This operation transfers an application or template created in CADT to another resource group.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeResourceGroup'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ChangeResourceGroup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio:*:{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
+ ],
],
],
],
- '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',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A3488F1D-xxxx-xxxx-xxxx-5374BA0F3562\\",\\n \\"Data\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
],
- 'ValuateTemplate' => [
- 'summary' => 'Queries the price of a template.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateApplication' => [
+ 'summary' => 'This operation creates an application in CADT from an official or a private template. Before calling this operation, ensure that you understand the billing methods and pricing for the associated Alibaba Cloud products.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -727,48 +252,66 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '181941',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioJLQBYK',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeCode' => '91661',
+ 'abilityTreeNodes' => ['FEATUREbpstudioCGSK4A'],
],
'parameters' => [
[
'name' => 'TemplateId',
'in' => 'formData',
- 'schema' => [
- 'title' => '模板ID',
- 'description' => 'The template ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '0KSHPM6SJU03TNZP',
- ],
+ 'schema' => ['description' => 'The template ID.', 'type' => 'string', 'required' => true, 'title' => '', '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',
- ],
+ 'schema' => ['description' => 'A client token to ensure the idempotence of the request.'."\n"
+ ."\n"
+ .'This token must be client-generated, unique across requests, and contain only ASCII characters.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => '1600765710019'],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The name of the application.'."\n"
+ ."\n"
+ .'- The name must be unique. You can call the <props="china">[ListApplication](~~428266~~)</props><props="intl">[ListApplication](https://www.alibabacloud.com/help/zh/bp-studio/latest/api-bpstudio-2021-09-31-listapplication)</props> operation to query the list of applications.'."\n"
+ ."\n"
+ .'- The name can contain letters, Chinese characters, digits, underscores (`_`), and hyphens (`-`). It must be 2 to 128 characters long, start with a letter or a Chinese character, and not start with `http://` or `https://`.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cadt-application'],
],
[
'name' => 'AreaId',
'in' => 'formData',
+ 'schema' => ['description' => 'The ID of the region. This must be the same as the region where the template was published. Otherwise, the system reverts to the default version of the template.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'ResourceGroupId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The ID of the resource group.'."\n"
+ ."\n"
+ .'><notice>'."\n"
+ ."\n"
+ .'This parameter specifies the resource group for all resources in the application. Ensure that the resources you import belong to this resource group.'."\n"
+ ."\n"
+ .'></notice>', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'rg-acfmyjt3c5om3hi'],
+ ],
+ [
+ 'name' => 'CreateAsync',
+ 'in' => 'formData',
'schema' => [
- 'title' => '区域ID',
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
+ 'description' => 'Specifies whether to create the application asynchronously.'."\n"
+ ."\n"
+ .'Asynchronous creation: The application ID is returned immediately, but the application\'s state is `Creating`. Before performing subsequent operations, you must wait for the state to change to `Modified`.'."\n"
+ ."\n"
+ .'Synchronous creation: The application ID is returned only after the application is created.'."\n"
+ ."\n"
+ .'Note: If an application template is large or has a large number of template variables, synchronous creation may time out. In this case, create the application asynchronously.',
+ 'enumValueTitles' => ['true' => 'The application is created asynchronously.', 'false' => 'The application is created synchronously.'],
+ 'type' => 'boolean',
'required' => false,
- 'example' => 'cn-hangzhou',
+ 'example' => 'false',
+ 'title' => '',
],
],
[
@@ -776,48 +319,36 @@
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '待替换实例列表',
- 'description' => 'The instances to be replaced.'."\n",
+ 'title' => '',
+ 'description' => 'The instances to import. You can use this parameter to create an application in an existing Virtual Private Cloud (VPC).',
'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',
- ],
+ 'NodeType' => ['description' => 'The node type.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'vpc'],
+ 'NodeName' => ['description' => 'The node name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'vpc'],
+ 'Id' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'vpc-bp1q56trhtaq40vlq5ojm'],
],
'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
+ 'example' => '',
],
],
[
- 'name' => 'ResourceGroupId',
+ 'name' => 'Configuration',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '应用所属资源组ID',
- 'description' => 'The ID of the resource group to which the application belongs.'."\n",
- 'type' => 'string',
+ 'description' => 'The configuration parameters for the application. For example, `enableMonitor` determines whether to automatically create a monitoring task in Cloud Monitor, `enableReport` determines whether to generate reports, and setting `enableCompliance` to 1 enables compliance checks.',
+ 'type' => 'object',
'required' => false,
- 'example' => 'rg-acfmyjt3c5om3fi',
+ 'additionalProperties' => ['description' => 'The value of the configuration parameter.', 'type' => 'string', 'example' => '${var1}', 'title' => ''],
+ 'example' => '{"enableMonitor":"0", "enableReport":"1"}',
+ 'title' => '',
],
],
[
@@ -825,15 +356,25 @@
'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",
+ 'description' => 'The values of the template variables. If you omit this parameter, the variables\' default values are used.',
'type' => 'object',
'required' => false,
- 'additionalProperties' => [
- 'type' => 'any',
- 'example' => '${var1}',
- 'description' => 'The supported variable.'."\n",
- ],
- 'enumValueTitles' => [],
+ 'additionalProperties' => ['description' => 'The value of the template variable.', 'type' => 'any', 'example' => '', 'title' => ''],
+ 'example' => '{"variable1":"1"}',
+ 'title' => '',
+ ],
+ ],
+ [
+ 'name' => 'ProcessVariables',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The key-value pairs for the process variables.',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['description' => 'The value of the parameter.', 'type' => 'any', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -842,1067 +383,628 @@
'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',
- ],
+ 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', 'title' => ''],
+ 'Data' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => '002XWH7MXB8MJRU0'],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
200 => [
- [
- 'errorCode' => 'Success',
- 'errorMessage' => 'The transaction is successful.',
- ],
+ ['errorCode' => 'Success', 'errorMessage' => 'The transaction is successful.', 'description' => ''],
],
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.',
- ],
+ ['errorCode' => 'ParameterEmpty', 'errorMessage' => 'You must specify the request parameter.', 'description' => 'You must specify request parameters.'],
+ ['errorCode' => 'bp.java.8004', 'errorMessage' => 'No permissions.', 'description' => ''],
+ ['errorCode' => 'bp.java.appNameNotNull', 'errorMessage' => 'Application name cannot be repeated.', 'description' => ''],
+ ['errorCode' => 'bp.java.nopower', 'errorMessage' => 'No permissions.', 'description' => ''],
+ ['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.', 'description' => ''],
+ ['errorCode' => 'bp.java.tempNameNotNull', 'errorMessage' => 'Application name cannot be repeated.', 'description' => ''],
+ ['errorCode' => 'bp.java.userNotExist', 'errorMessage' => 'The user does not exist. The current user does not authenticate AliCloud with his real name.', 'description' => ''],
],
404 => [
- [
- 'errorCode' => 'EntityNotExist.ResourceGroup',
- 'errorMessage' => 'The resource group does not exist.',
- ],
- [
- 'errorCode' => 'EntityNotExist.ResourceId',
- 'errorMessage' => 'The resource does not exist.',
- ],
+ ['errorCode' => 'EntityNotExist.ResourceGroup', 'errorMessage' => 'The resource group does not exist.', 'description' => ''],
+ ['errorCode' => 'EntityNotExist.ResourceId', 'errorMessage' => 'The resource does not exist.', 'description' => ''],
],
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.',
- ],
+ ['errorCode' => 'bp.java.notDelete', 'errorMessage' => 'This template has been shared with other users and cannot be deleted.', 'description' => ''],
+ ['errorCode' => 'bp.java.serviceError', 'errorMessage' => 'The server is abnormal. Please try again later.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Data\\": \\"002XWH7MXB8MJRU0\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
+ 'title' => 'CreateApplication',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApplication'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'bpstudio:CreateApplication',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Template', 'arn' => 'acs:bpstudio::{#accountId}:template/{#TemplateId}'],
+ ],
+ ],
+ ],
],
- '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' => '获取模板变参可选值',
+ 'CreateTask' => [
+ 'summary' => 'Creates a task.',
'path' => '',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '181941',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioRJ9IF1',
- ],
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeNodes' => ['FEATUREbpstudioJLICAE'],
],
'parameters' => [
[
- 'name' => 'TemplateId',
+ 'name' => 'ProcessId',
'in' => 'formData',
- 'schema' => [
- 'title' => '模板ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'XFKR6WYRVS24S07R',
- ],
+ 'schema' => ['description' => 'The process ID.', 'type' => 'string', 'required' => true, 'example' => 'P3KTG43SW7**6A17I', 'title' => ''],
],
[
- 'name' => 'AreaId',
+ 'name' => 'TaskName',
'in' => 'formData',
- 'schema' => [
- 'title' => '区域ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The name of the task.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
[
- 'name' => 'Instances',
+ 'name' => 'AppId',
'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,
- ],
+ 'schema' => ['description' => 'The ID of the application. To obtain the application ID, call the ListApplication operation. For more information, see ListApplication.', 'type' => 'string', 'required' => true, 'example' => 'JXT3MLZJ56**65D6', 'title' => ''],
],
[
'name' => 'Variables',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'description' => '',
'type' => 'object',
+ 'additionalProperties' => ['description' => '"${var}":"value"', 'type' => 'any', 'example' => '"${var}":"value"', 'title' => ''],
+ 'description' => 'A list of variable values for the flow.',
'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',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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"
- .' }',
- ],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'F439A659-3B3D-50FB-A4BC-69FBF16413C8'],
+ 'Message' => ['description' => 'The returned error message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'Data' => ['description' => 'The ID of the task.', 'type' => 'integer', 'format' => 'int32', 'example' => '1994', 'title' => ''],
+ 'Code' => ['description' => 'The return code.', 'type' => 'string', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
+ 'title' => '',
+ 'description' => 'The response schema.',
+ 'example' => '',
],
],
],
'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' => 'NoPermissions', 'errorMessage' => 'No permissions.', 'description' => ''],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'CreateTask',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- [
- 'errorCode' => 'EntityNotExist.ResourceGroup',
- 'errorMessage' => 'The resource group does not exist.',
- ],
- [
- 'errorCode' => 'EntityNotExist.ResourceId',
- 'errorMessage' => 'The resource does not exist.',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'bpstudio:CreateTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
+ ],
],
],
],
- '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"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F439A659-3B3D-50FB-A4BC-69FBF16413C8\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": 1994,\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
],
- 'GetApplicationVariables' => [
- 'summary' => 'Queries the values specified for template variables when an application was created.',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DeleteApplication' => [
+ 'summary' => 'Deletes an application.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
+ 'operationType' => 'write',
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '240229',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioCGSK4A',
- ],
+ 'abilityTreeCode' => '91663',
+ 'abilityTreeNodes' => ['FEATUREbpstudioCGSK4A'],
],
'parameters' => [
[
- 'name' => 'AppId',
+ 'name' => 'ApplicationId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Q2P4O9YSOKCQ35L9',
- ],
+ 'schema' => ['description' => 'The ID of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '002XWH7MXB8MJRU0', 'title' => ''],
+ ],
+ [
+ 'name' => 'ResourceGroupId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyjt3c5om3hi', 'title' => ''],
],
],
'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',
- ],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', 'title' => ''],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- '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',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'ParameterEmpty', 'errorMessage' => 'The request parameter cannot be empty.', 'description' => ''],
+ ],
+ 404 => [
+ ['errorCode' => 'EntityNotExist.ResourceGroup', 'errorMessage' => 'The resource group does not exist.', 'description' => ''],
+ ['errorCode' => 'EntityNotExist.ResourceId', 'errorMessage' => 'The resource does not exist.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'ServiceError', 'errorMessage' => 'A server error occurred. Please try again later.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'https',
+ 'title' => 'DeleteApplication',
+ 'description' => 'Before you delete an application, its status must be `Destroyed_Success`. Otherwise, the deletion fails. You can call <props="intl">[GetApplication](https://www.alibabacloud.com/help/en/bp-studio/latest/api-bpstudio-2021-09-31-getapplication)</props> to query the application status.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApplication'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'bpstudio:DeleteApplication',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
+ ],
+ 'DeployApplication' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
- 'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '238269',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioCGSK4A',
- ],
- 'autoTest' => true,
+ 'riskType' => 'high',
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '91660',
+ 'abilityTreeNodes' => ['FEATUREbpstudioCGSK4A'],
],
'parameters' => [
[
- 'name' => 'AppId',
+ 'name' => 'ApplicationId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'VVK605ZH00OA4MRT'],
+ ],
+ [
+ 'name' => 'ResourceGroupId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => 'Q2P4O9YSOKCT35L9',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'rg-acfmyjt3c5om3hi'],
],
[
- 'name' => 'Variables',
+ 'name' => 'ClientToken',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '{"${instance_type}":"ecs.c6.3xlarge"}',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The idempotency token.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1600765710019'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'type' => 'object',
'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',
- ],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', 'title' => ''],
+ 'Data' => ['description' => 'The application data.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
- 'title' => 'Schema of Response',
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- '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' => [],
+ 'errorCodes' => [
+ 200 => [
+ ['errorCode' => 'Success', 'errorMessage' => 'The transaction is successful.', 'description' => ''],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '238274',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioCGSK4A',
+ 400 => [
+ ['errorCode' => 'ParameterEmpty', 'errorMessage' => 'You must specify the request parameter.', 'description' => 'You must specify request parameters.'],
],
- ],
- 'parameters' => [
- [
- 'name' => 'AppId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Q2P4O9YSOKCT35L9',
- ],
+ 404 => [
+ ['errorCode' => 'EntityNotExist.ResourceGroup', 'errorMessage' => 'The resource group does not exist.', 'description' => ''],
+ ['errorCode' => 'EntityNotExist.ResourceId', 'errorMessage' => 'The resource does not exist.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'ServiceError', 'errorMessage' => 'A server error occurred. Please try again later.', 'description' => ''],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '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',
- ],
+ 'title' => 'DeployApplication',
+ 'summary' => 'Creates resources after successful billing.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeployApplication'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bpstudio:DeployApplication',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
],
],
],
],
- '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',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Data\\": 123,\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
],
- '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',
- ],
+ 'ExecuteOperationASync' => [
+ 'summary' => 'Performs asynchronous operations on a service.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '91661',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioCGSK4A',
- ],
+ 'abilityTreeCode' => '147059',
+ 'abilityTreeNodes' => ['FEATUREbpstudioCGSK4A'],
],
'parameters' => [
[
- 'name' => 'TemplateId',
+ 'name' => 'ApplicationId',
'in' => 'formData',
- 'schema' => [
- 'title' => '模板ID',
- 'description' => 'The ID of the template.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '0KSHPM6SJU03TNZP',
- ],
+ 'schema' => ['description' => 'The ID of the Cloud Architect Design Tools application.', 'type' => 'string', 'required' => false, 'example' => 'BG**********UQ', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'ServiceType',
'in' => 'formData',
'schema' => [
- 'title' => '客户端 Token，用于保证请求的幂等性。'."\n"
- ."\n"
- .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。',
- 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n",
+ 'title' => '',
+ 'description' => 'The resource type. To modify ECS-related parameters, set this parameter to ecs.',
+ 'enumValueTitles' => ['ecs' => 'ecs'],
'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => '1600765710019',
+ 'required' => true,
+ 'example' => 'ecs',
],
],
[
- 'name' => 'Name',
+ 'name' => 'Operation',
'in' => 'formData',
'schema' => [
- 'title' => '新建应用名',
- 'description' => 'The name of the application.'."\n"
+ 'title' => '',
+ 'description' => 'The operation type to perform on the service. Some operation types are general, and others are dedicated.'."\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 (-).',
+ .'The following examples show ECS-related operations:'."\n"
+ .'- Rename an ECS instance: rename'."\n"
+ .'- Change instance type: modifyInstanceType'."\n"
+ .'- Start an ECS instance: modifyInstanceType'."\n"
+ .'- Stop an ECS instance: modifyInstanceType'."\n"
+ .'- Restart an ECS instance: modifyInstanceType'."\n"
+ .'- Add tags to an ECS instance: addTags'."\n"
+ .'- Delete an ECS instance: ecsDelete'."\n"
+ .'- Change the billing method of an ECS instance: modifyPayType.',
+ 'enumValueTitles' => ['addTags' => 'addTags', 'modifyInstanceType' => 'modifyInstanceType'],
'type' => 'string',
'required' => true,
- 'example' => 'cadt-application',
+ 'example' => 'addTags',
],
],
[
- 'name' => 'AreaId',
+ 'name' => 'Attributes',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '区域ID',
- 'description' => 'The ID of the region.'."\n",
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'The operation parameters. Specify the parameters based on the Operation value. The value is passed as a map.'."\n"
+ ."\n"
+ .'The following examples show ECS configuration changes:'."\n"
+ .'- Common parameters required for ECS:'."\n"
+ .'change_type,'."\n"
+ .'regionId,'."\n"
+ .'instanceId,'."\n"
+ .'appId'."\n"
+ .'- Example for changing the ECS instance type:'."\n"
+ .'{'."\n"
+ .' "ServiceType": "ecs",'."\n"
+ .' "Operation": "modifyInstanceType",'."\n"
+ .' "Attributes": "{\\"change_type\\":\\"modify_instance_type\\",\\"instance_type\\":\\"ecs.hfr7.2xlarge\\",\\"instanceId\\":\\"i-xxxxxxxxx\\",\\"regionId\\":\\"ap-southeast-1\\",\\"appId\\":\\"xxxxxxxxxxxxx\\"}"'."\n"
+ .'}'."\n"
+ .'- Example for stopping an ECS instance:'."\n"
+ .'{'."\n"
+ .' "ServiceType": "ecs",'."\n"
+ .' "Operation": "modifyInstanceType",'."\n"
+ .' "Attributes": "{\\"change_type\\":\\"modify_status\\",\\"status\\":\\"Stopped\\",\\"instanceId\\":\\"i-xxxxxxxxx\\",\\"regionId\\":\\"ap-southeast-1\\",\\"appId\\":\\"xxxxxxxxxxxxx\\"}"'."\n"
+ .'}'."\n"
+ .'- Example for starting an ECS instance:'."\n"
+ .'{'."\n"
+ .' "ServiceType": "ecs",'."\n"
+ .' "Operation": "modifyInstanceType",'."\n"
+ .' "Attributes": "{\\"change_type\\":\\"modify_status\\",\\"status\\":\\"Running\\",\\"instanceId\\":\\"i-xxxxxxxxx\\",\\"regionId\\":\\"ap-southeast-1\\",\\"appId\\":\\"xxxxxxxxxxxxx\\"}"'."\n"
+ .'}'."\n"
+ .'- Example for restarting an ECS instance:'."\n"
+ .'{'."\n"
+ .' "ServiceType": "ecs",'."\n"
+ .' "Operation": "modifyInstanceType",'."\n"
+ .' "Attributes": "{\\"change_type\\":\\"modify_status\\",\\"status\\":\\"Restart\\",\\"instanceId\\":\\"i-xxxxxxxxx\\",\\"regionId\\":\\"ap-southeast-1\\",\\"appId\\":\\"xxxxxxxxxxxxx\\"}"'."\n"
+ .'}.',
+ 'type' => 'object',
'required' => false,
- 'example' => 'cn-hangzhou',
+ 'additionalProperties' => ['description' => '调试时请先选择“参数类型”，再输入参数值。', 'type' => 'any', 'example' => '选择string类型：”CADT“；'."\n"
+ .'选择number类型：123', 'title' => ''],
+ '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\\"}" }'],
+ 'example' => '',
],
],
[
'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',
- ],
+ 'schema' => ['title' => '', 'description' => 'The resource group ID, used for resource group permission verification.', 'type' => 'string', 'required' => false, 'example' => 'ceshi'],
],
[
- 'name' => 'CreateAsync',
+ 'name' => 'ClientToken',
'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The idempotence token.', 'type' => 'string', 'required' => false, 'example' => '1600765710019'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'type' => 'boolean',
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['title' => '', 'description' => '错误信息', 'type' => 'string', 'example' => '" "'],
+ 'RequestId' => ['title' => '', 'description' => '请求ID', 'type' => 'string', 'example' => 'SD-WEF-DSW-32ED-323DDSD-2332D'],
+ 'Data' => ['title' => '', 'description' => 'OperationId，可通过GetExecuteOperationResult这个api异步获取操作结果。（有效时间为 1 小时）', 'type' => 'string', 'example' => 'op_xxxxxxxxxxxxxxxxxx_ecs_modifyInstanceType_BYSOQGWUV6PME412_ERMEZLXNN3K9N3OL'],
+ 'Code' => ['title' => '', 'description' => '结果码，200代表成功；其它代表失败。', 'type' => 'string', 'format' => 'int32', 'example' => '200'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'title' => 'Perform asynchronous operations',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteOperationASync'],
+ ],
+ ],
+ 'ramActions' => [
[
- '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,
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ExecuteOperationASync',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
],
- 'required' => false,
],
],
+ ],
+ '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"}]',
+ 'translator' => 'machine',
+ ],
+ 'ExecuteOperationSync' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'Configuration',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '212309',
+ 'abilityTreeNodes' => ['FEATUREbpstudioCGSK4A'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ApplicationId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The ID of the Cloud Architect Design Tools (CADT) application.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'BE68D71ZY5YYIU9R'],
+ ],
+ [
+ 'name' => 'ServiceType',
'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"}',
+ 'description' => 'The resource type. For example, to perform an operation on a DDS resource, set this parameter to dds.',
+ 'enumValueTitles' => ['dds' => 'dds', 'ecs' => 'ecs'],
+ 'type' => 'string',
+ 'required' => true,
+ 'title' => '',
+ 'example' => 'dds',
],
],
[
- 'name' => 'Variables',
+ 'name' => 'Operation',
'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"}',
+ 'description' => 'The type of the operation.',
+ 'enumValueTitles' => ['modifyConnectionString' => 'modifyConnectionString', 'rename' => 'rename'],
+ 'type' => 'string',
+ 'required' => true,
+ 'title' => '',
+ 'example' => 'rename',
],
],
[
- 'name' => 'ProcessVariables',
+ 'name' => 'Attributes',
'in' => 'formData',
'style' => 'json',
'schema' => [
+ 'title' => '',
+ 'description' => 'The parameters for the operation. The parameters that you must specify vary based on the value of Operation.',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'any',
- ],
+ 'required' => false,
+ 'additionalProperties' => ['description' => 'When you test this operation, select a parameter type and then enter a value.', 'type' => 'any', 'example' => 'Select string type: "CADT"; Select number type: 123', 'title' => ''],
+ 'example' => '',
],
],
+ [
+ 'name' => 'ResourceGroupId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The ID of the resource group. This ID is used for permission verification.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'rg-acfmyjt3c5om3hi'],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The idempotence token.', 'type' => 'string', 'title' => '', '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',
- ],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Access key ID cannot be null.'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'FDC73B05-5331-57AA-BA93-4C9882792FF5'],
'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',
+ 'title' => '',
+ 'description' => 'The details of the synchronous operation.',
+ 'type' => 'object',
+ 'example' => 'op_xxxxxxxxxxxxxxxxxx_dds_modifyInstanceType_BYSOQGWUV6PME412_ERMEZLXNN3K9N3OL',
+ 'properties' => [
+ 'OperationId' => ['description' => 'The operation ID.', 'type' => 'string', 'title' => '', 'example' => 'op_xxxxxxxx'],
+ 'Status' => ['description' => 'The instance status.', 'type' => 'string', 'title' => '', 'example' => 'SUCCESS/FAILURE'],
+ 'Message' => ['description' => 'The information about the operation.', 'type' => 'string', 'title' => '', 'example' => '"[{"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":[]}]"'],
+ 'Arguments' => ['description' => 'The output of the operation.', 'type' => 'string', 'title' => '', 'example' => '{'."\n"
+ .' "tagMap":{'."\n"
+ .' "cadt": ['."\n"
+ .' "12xxxxxxx",'."\n"
+ .' "34xxxxxxx"'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .'}'],
+ ],
],
+ 'Code' => ['description' => 'The result code. A value of 200 indicates that the request was successful. Other values indicate that the request failed.', 'type' => 'string', 'example' => '200', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- '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'],
+ 'title' => 'ExecuteOperationSync',
+ 'summary' => 'Executes an operation synchronously to manage resources in an application.',
+ 'description' => 'Executes a product operation synchronously.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteOperationSync'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ExecuteOperationSync',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Data\\": \\"002XWH7MXB8MJRU0\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
- 'title' => 'CreateApplication',
+ '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"}]',
],
- 'DeleteApplication' => [
- 'summary' => 'Deletes an application.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ExecuteTask' => [
+ 'summary' => 'Creating a job',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '91663',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioCGSK4A',
- ],
+ 'abilityTreeNodes' => ['FEATUREbpstudioJLICAE'],
],
'parameters' => [
[
- 'name' => 'ApplicationId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'The ID of the application.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '002XWH7MXB8MJRU0',
- ],
- ],
- [
- 'name' => 'ResourceGroupId',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'description' => 'The ID of the resource group.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-acfmyjt3c5om3hi',
- ],
+ 'schema' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2615', 'title' => ''],
],
],
'responses' => [
@@ -1910,64 +1012,62 @@
'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',
+ 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'title' => '', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187'],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'Data' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '2615', 'title' => ''],
+ 'Name' => ['description' => 'The task name.', 'type' => 'string', 'example' => 'test_name', 'title' => ''],
+ 'Status' => ['description' => 'The status of the task.', 'type' => 'string', 'example' => 'FINISH', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'SyntaxError', 'title' => ''],
+ ],
+ 'description' => 'The execution result.',
+ 'title' => '',
+ 'example' => '',
],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'example' => '',
],
],
],
'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.',
- ],
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No Permission.', 'description' => ''],
+ ['errorCode' => 'NoPermissions', 'errorMessage' => 'No permissions.', 'description' => ''],
],
- 500 => [
- [
- 'errorCode' => 'ServiceError',
- 'errorMessage' => 'A server error occurred. Please try again later.',
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'ExecuteTask',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ExecuteTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
+ ],
],
],
],
- '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.',
+ '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"}]',
],
'GetApplication' => [
- 'summary' => 'The URL of the application topology image.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1980,30 +1080,18 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '91657',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioCGSK4A',
- ],
+ 'abilityTreeNodes' => ['FEATUREbpstudioCGSK4A'],
],
'parameters' => [
[
'name' => 'ApplicationId',
'in' => 'formData',
- 'schema' => [
- 'description' => 'The ID of the request.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'VVK605ZH00OA4MRT',
- ],
+ 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'VVK605ZH00OA4MRT', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'formData',
- 'schema' => [
- 'description' => 'The ID of the resource group.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-acfmyjt3c5om3hi',
- ],
+ 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyjt3c5om3hi', 'title' => ''],
],
],
'responses' => [
@@ -2011,388 +1099,237 @@
'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',
- ],
+ 'Message' => ['description' => 'The reason why the request failed.', 'type' => 'string', 'title' => '', 'example' => 'Success'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187'],
'Data' => [
- 'description' => 'The details of the application.'."\n",
+ 'description' => 'The application details.',
'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',
- ],
+ 'Description' => ['description' => 'The description of the application.', 'type' => 'string', 'title' => '', 'example' => 'remark'],
+ 'ImageURL' => ['description' => 'The URL of the image in the database.', 'type' => 'string', 'title' => '', 'example' => 'https://cadt-studio-publish.oss-cn-hangzhou.aliyuncs.com/xxxxxxxxxxxxxxxxxxx/sr-8DWU4RUS49NIDII0.png'],
+ 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'VVK605ZH00OA4MRT'],
+ 'Name' => ['description' => 'The application name.', 'type' => 'string', 'title' => '', 'example' => 'CADT'],
+ 'TemplateId' => ['description' => 'The ID of the template that is associated with the application.', 'type' => 'string', 'title' => '', 'example' => 'FYS9VZ535U20V7HT'],
+ 'CreateTime' => ['description' => 'The time when the application was created.', 'type' => 'string', 'title' => '', 'example' => '2021-08-09 14:37:16'],
+ 'ResourceGroupId' => ['description' => 'The ID of the resource group to which the application belongs.', 'type' => 'string', 'title' => '', 'example' => 'rg-aekzhfgmw4e6fwq'],
'PriceList' => [
- 'title' => '计费结果列表',
- 'description' => 'The billing results.'."\n",
+ 'title' => '',
+ 'description' => 'The list of billing results.',
'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',
- ],
+ 'ResourceCode' => ['description' => 'The product code.', 'type' => 'string', 'title' => '', 'example' => 'ecs'],
+ 'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'title' => '', 'example' => 'ecs'],
+ 'OriginalPrice' => ['description' => 'The original price.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '3.570'],
+ 'OnePrice' => ['description' => 'The unit price.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.01'],
+ 'Period' => ['description' => 'The duration.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Count' => ['description' => 'The quantity.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ 'PriceUnit' => ['description' => 'The unit of the price. <props="china">CNY/hour</props>'."\n"
+ .'<props="intl">USD/hour</props>', 'type' => 'string', 'title' => '', 'example' => '200/hour'],
+ 'Price' => ['description' => 'The total price.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.01'],
+ 'ChargeType' => ['description' => 'The billing method.', 'type' => 'string', 'title' => '', 'example' => 'PayAsYouGo'],
+ 'Region' => ['description' => 'The region.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'],
+ 'Specification' => ['description' => 'The instance specification.'."\n"
+ .'For example, for a VPC, a CIDR block such as "192.168.0.0/16" is returned. For an ECS instance, an instance type such as "ecs.g5.large" is returned. For an SLB instance, an instance type such as "slb.s1.small" is returned. If the instance does not have a specification property, an empty string is returned.', 'type' => 'string', 'title' => '', 'example' => '"slb.s1.small"'."\n"
+ .' "192.168.0.0/24"'."\n"
+ .'"ecs.c6.large"'."\n"
+ .'"normal"'."\n"
+ .' ""'],
+ 'Lifecycle' => ['description' => 'The resource tag.', 'type' => 'string', 'example' => 'Create', 'title' => ''],
+ 'Remark' => ['description' => 'The error message that is returned when the price inquiry fails.', 'type' => 'string', 'example' => 'ecs Sold Out', 'title' => ''],
+ 'type' => ['description' => 'The creation type. Valid values:'."\n"
+ .'<br>1: Create'."\n"
+ .'<br>2: Import<br><br><br><br><br>', 'type' => 'string', 'example' => '1', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
'Checklist' => [
- 'title' => '校验结果列表',
- 'description' => 'The resource tag.'."\n",
+ 'title' => '',
+ 'description' => 'The list of validation results.',
'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',
- ],
+ 'ResourceCode' => ['description' => 'The product code.', 'type' => 'string', 'title' => '', 'example' => 'vpc'],
+ 'ResourceName' => ['description' => 'The instance name.', 'type' => 'string', 'title' => '', 'example' => 'vpc'],
+ 'Region' => ['description' => 'The region.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'],
+ 'Result' => ['description' => 'The validation result.', 'type' => 'string', 'title' => '', 'example' => 'Finish'],
+ 'Remark' => ['description' => 'The reason for the failure.', 'type' => 'string', 'title' => '', 'example' => 'Verification passed'],
+ 'Specification' => ['description' => 'The specification.', 'type' => 'string', 'title' => '', 'example' => '192.168.0.0/16'],
+ 'Lifecycle' => ['description' => 'The resource tag.', 'type' => 'string', 'example' => 'Create', 'title' => ''],
],
+ 'description' => 'The list of validation results.',
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
- 'Status' => [
- 'title' => '应用状态',
- 'description' => 'Verification passed'."\n",
- 'type' => 'string',
- 'example' => 'Deployed_Success',
- ],
+ 'Status' => ['description' => 'The application status.', 'type' => 'string', 'title' => '', 'example' => 'Deployed_Success'],
'ResourceList' => [
- 'title' => '资源列表',
- 'description' => 'The resource specification.'."\n",
+ 'title' => '',
+ 'description' => 'The list of resources.',
'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',
- ],
+ 'Status' => ['description' => 'The deployment result of the resource.', 'type' => 'string', 'title' => '', 'example' => 'Finish'],
+ 'ResourceCode' => ['description' => 'The product code.', 'type' => 'string', 'title' => '', 'example' => 'ecs'],
+ 'ResourceName' => ['description' => 'The instance name.', 'type' => 'string', 'title' => '', 'example' => 'ecs'],
+ 'ResourceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'i-2zehnzxqixu1pywsfbx1'],
+ 'ChargeType' => ['description' => 'The billing method.', 'type' => 'string', 'title' => '', 'example' => 'PayAsYouGo'],
+ 'ResourceType' => ['description' => 'The resource type.', 'type' => 'string', 'title' => '', 'example' => 'ecs'],
+ 'Remark' => ['description' => 'The deployment result.', 'type' => 'string', 'title' => '', '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' => ['description' => 'The resource tag.', 'type' => 'string', 'example' => 'Create', 'title' => ''],
+ 'NodeLabel' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
+ 'description' => 'The list of resources.',
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
- 'Error' => [
- 'title' => '失败原因',
- 'description' => 'The resource type.'."\n",
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'DeployPercent' => [
- 'title' => '部署进度',
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- ],
+ 'Error' => ['description' => 'The reason for the failure.', 'type' => 'string', 'title' => '', 'example' => 'Success'],
+ 'DeployPercent' => ['description' => 'The deployment progress.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.8'],
'ComplianceList' => [
+ 'description' => 'The compliance check results.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Rules' => [
+ 'description' => 'The check results.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'ruleId' => [
- 'type' => 'string',
- ],
- 'ruleDetail' => [
- 'type' => 'string',
- ],
+ 'ruleId' => ['description' => 'The rule ID.', 'type' => 'string', 'example' => 'ecs-instances-in-vpc', 'title' => ''],
+ 'ruleDetail' => ['description' => 'The rule name.', 'type' => 'string', 'title' => '', 'example' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
- 'ResourceName' => [
- 'type' => 'string',
- ],
- 'ResourceCode' => [
- 'type' => 'string',
- ],
+ 'ResourceName' => ['description' => 'The resource name.', 'type' => 'string', 'example' => 'ecs', 'title' => ''],
+ 'ResourceCode' => ['description' => 'The product code.', 'type' => 'string', 'example' => 'ecs', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
- 'Code' => [
- 'description' => 'The response code.'."\n",
- 'type' => 'string',
- 'example' => '200',
- ],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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.',
- ],
+ ['errorCode' => 'bp.java.8004', 'errorMessage' => 'No permissions.', 'description' => ''],
+ ['errorCode' => 'bp.java.nopower', 'errorMessage' => 'No permissions.', 'description' => ''],
+ ['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.', 'description' => ''],
+ ['errorCode' => 'bp.java.userNotExist', 'errorMessage' => 'The user does not exist. The current user does not authenticate AliCloud with his real name.', 'description' => ''],
+ ['errorCode' => 'ParameterEmpty', 'errorMessage' => 'The request parameter cannot be empty.', 'description' => ''],
],
404 => [
- [
- 'errorCode' => 'EntityNotExist.ResourceGroup',
- 'errorMessage' => 'The resource group does not exist.',
- ],
- [
- 'errorCode' => 'EntityNotExist.ResourceId',
- 'errorMessage' => 'The resource does not exist.',
- ],
+ ['errorCode' => 'EntityNotExist.ResourceGroup', 'errorMessage' => 'The resource group does not exist.', 'description' => ''],
+ ['errorCode' => 'EntityNotExist.ResourceId', 'errorMessage' => 'The resource does not exist.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServiceError',
- 'errorMessage' => 'A server error occurred. Please try again later.',
- ],
+ ['errorCode' => 'ServiceError', 'errorMessage' => 'A server error occurred. Please try again later.', 'description' => ''],
],
],
- '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',
+ 'summary' => 'Retrieves the basic information, validation results, billing results, and deployment results of a specified application.',
+ 'responseParamsDescription' => 'Application statuses:'."\n"
+ ."\n"
+ .'- Creating: The application is being created.'."\n"
+ ."\n"
+ .'- Modified: The application has been modified.'."\n"
+ ."\n"
+ .'- Verifying: The application is being validated.'."\n"
+ ."\n"
+ .'- Verified\\_Failure: Validation failed.'."\n"
+ ."\n"
+ .'- Verified\\_Success: Validation is successful.'."\n"
+ ."\n"
+ .'- Valuating: The price is being calculated.'."\n"
+ ."\n"
+ .'- Valuating\\_Failure: Price calculation failed.'."\n"
+ ."\n"
+ .'- Valuating\\_Success: Price calculation is successful.'."\n"
+ ."\n"
+ .'- Deploying: The application is being deployed.'."\n"
+ ."\n"
+ .'- Deployed\\_Failure: Deployment failed.'."\n"
+ ."\n"
+ .'- Partially\\_Deployed\\_Success: The application has been partially deployed.'."\n"
+ ."\n"
+ .'- Deployed\\_Success: The deployment is successful.'."\n"
+ ."\n"
+ .'- Destroying: The application is being released.'."\n"
+ ."\n"
+ .'- Delayed\\_Destroy: The application is scheduled to be released.'."\n"
+ ."\n"
+ .'- Destroyed\\_Failure: The release failed.'."\n"
+ ."\n"
+ .'- Partially\\_Destroyed\\_Success: The application has been partially released.'."\n"
+ ."\n"
+ .'- Destroyed\\_Success: The release is successful.'."\n"
+ ."\n"
+ .'- Revised: The architecture is being adjusted.'."\n"
+ ."\n"
+ .'- Verifying\\_In\\_Revision: Resource validation is in progress because of an architecture adjustment.'."\n"
+ ."\n"
+ .'- Verified\\_Failure\\_In\\_Revision: Resource validation failed because of an architecture adjustment.'."\n"
+ ."\n"
+ .'- Verified\\_Success\\_In\\_Revision: Resource validation is successful after an architecture adjustment.'."\n"
+ ."\n"
+ .'- Valuating\\_In\\_Revision: A price inquiry is in progress because of an architecture adjustment.'."\n"
+ ."\n"
+ .'- Valuating\\_Failure\\_In\\_Revision: The price inquiry failed because of an architecture adjustment.'."\n"
+ ."\n"
+ .'- Valuating\\_Success\\_In\\_Revision: The price inquiry is successful after an architecture adjustment.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetApplication'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:GetApplication',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ ],
+ 'GetApplicationVariables' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2404,318 +1341,196 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '91667',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioCGSK4A',
- ],
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeCode' => '240229',
+ 'abilityTreeNodes' => ['FEATUREbpstudioCGSK4A'],
],
'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',
+ 'name' => 'AppId',
'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",
- ],
+ 'schema' => ['description' => 'The ID of the application. Obtain the ID by calling the ListApplication operation.', 'type' => 'string', 'required' => false, 'example' => 'Q2P4O9YSOKCQ35L9', 'title' => ''],
],
- [
- 'name' => 'ResourceGroupId',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The ID of the resource group.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default',
+ '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' => 'The error message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The instances and variables of the application.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The return value.',
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => 'ob5epf79uv****', 'title' => ''],
+ 'VariableList' => [
+ 'description' => 'A collection of variables.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A list of variables.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Variable' => ['description' => 'The name of the variable.', 'type' => 'string', 'example' => '${instance_type}', 'title' => ''],
+ 'Value' => ['description' => 'The value of the variable.', 'type' => 'string', 'example' => 'ecs.c6.4xlarge', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ ],
+ 'example' => '',
],
],
- [
- 'name' => 'ResourceId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'Resource Id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vsw-xxxxxxxxxxxx',
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'GetApplicationVariables',
+ 'summary' => 'Retrieves the values of all input template variables for an application.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetApplicationVariables'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:GetApplicationVariables',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
+ ],
],
],
+ ],
+ '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"}]',
+ ],
+ 'GetApplicationVariables4Fail' => [
+ 'summary' => 'Retrieves a list of variables that need to be reconfigured.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'TemplateId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'Template Id',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0KSXXX6SJU03TXXX',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '238274',
+ 'abilityTreeNodes' => ['FEATUREbpstudioCGSK4A'],
+ ],
+ 'parameters' => [
[
- 'name' => 'ShowHide',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'boolean',
- ],
+ 'name' => 'AppId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The application ID. To obtain the application ID, call the ListApplication operation. For more information, see ListApplication.', 'type' => 'string', 'required' => false, 'example' => 'Q2P4O9YSOKCT35L9', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'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',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'BFB7F5C8-FE7A-06CA-9F87-ABBF6B848F0C'],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Data' => [
- 'description' => 'App listing information',
+ 'description' => 'A list of template variables that are related to the failed resource nodes of a partially deployed application.',
'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',
- ],
+ 'Region' => ['description' => 'The region.', 'type' => 'string', 'example' => 'cn-shenzhen', 'title' => ''],
+ 'Attribute' => ['description' => 'The variable name.', 'type' => 'string', 'example' => 'instance_name', 'title' => ''],
+ 'Variable' => ['description' => 'The variable value.', 'type' => 'string', 'example' => '${name}', 'title' => ''],
+ 'PlaceHolder' => ['description' => 'The variable value.', 'type' => 'string', 'example' => '${name}', 'title' => ''],
+ 'Value' => ['description' => 'The value set for the property.', 'type' => 'string', 'example' => 'cadt-app-01', 'title' => ''],
+ 'DefaultValue' => ['description' => 'The default value.', 'type' => 'string', 'example' => 'cadt-app-01', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
- 'Code' => [
- 'description' => 'The HTTP status code.'."\n",
- 'type' => 'string',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
- 'description' => '',
+ 'example' => '',
],
],
],
- '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.',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'GetApplicationVariables4Fail',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetApplicationVariables4Fail'],
],
- 500 => [
- [
- 'errorCode' => 'ServiceError',
- 'errorMessage' => 'A server error occurred. Please try again later.',
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:GetApplicationVariables4Fail',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
+ ],
],
],
],
- '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>',
+ '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"}]',
],
- 'DeployApplication' => [
- 'summary' => 'Deploys an application after the payment.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetExecuteOperationResult' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'high',
- 'chargeType' => 'paid',
- 'abilityTreeCode' => '91660',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioCGSK4A',
- ],
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '147061',
+ 'abilityTreeNodes' => ['FEATUREbpstudioJLQBYK', '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',
+ 'name' => 'OperationId',
'in' => 'formData',
- 'schema' => [
- 'title' => '资源组ID',
- 'description' => 'The ID of the resource group.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-acfmyjt3c5om3hi',
- ],
+ 'schema' => ['description' => 'The operation ID. This ID is valid for one hour. After the ID expires, you cannot query the result, and the Data property is not returned in the response.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'op_xxxxxxxxxxxxxxxxxxxxxx'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'ResourceGroupId',
'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',
- ],
+ 'schema' => ['description' => 'The ID of the resource group. This parameter is used for permission verification.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'testResourceId'],
],
],
'responses' => [
@@ -2723,248 +1538,367 @@
'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',
- ],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => '" "'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'A3488F1D-xxxx-xxxx-xxxx-5374BA0F3562'],
'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',
+ 'description' => 'The result of the asynchronous operation.',
+ 'type' => 'object',
+ 'properties' => [
+ 'OperationId' => ['description' => 'The operation ID.', 'type' => 'string', 'title' => '', 'example' => 'op_xxxxxxxx'],
+ 'Status' => ['description' => 'The status of the operation.', 'type' => 'string', 'title' => '', 'example' => 'INIT/RUNNING/SUCCESS/FAILURE'."\n"],
+ 'Message' => ['description' => 'Information about the operation.', 'type' => 'string', 'title' => '', 'example' => '"[{"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":[]}]"'],
+ 'Arguments' => ['description' => 'The output of the operation.', 'type' => 'string', 'title' => '', 'example' => '{'."\n"
+ .' "tagMap":{'."\n"
+ .' "cadt": ['."\n"
+ .' "12xxxxxxx",'."\n"
+ .' "34xxxxxxx"'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .'}'],
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'Code' => ['description' => 'The status code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 200 => [
- [
- 'errorCode' => 'Success',
- 'errorMessage' => 'The transaction is successful.',
+ 'title' => 'GetExecuteOperationResult',
+ 'summary' => 'Obtains the result of an asynchronous operation.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExecuteOperationResult'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:GetExecuteOperationResult',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
+ ],
],
],
- 400 => [
- [
- 'errorCode' => 'ParameterEmpty',
- 'errorMessage' => 'You must specify the request parameter.',
- ],
+ ],
+ '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"}]',
+ ],
+ 'GetFoTaskStatus' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
],
- 404 => [
- [
- 'errorCode' => 'EntityNotExist.ResourceGroup',
- 'errorMessage' => 'The resource group does not exist.',
- ],
- [
- 'errorCode' => 'EntityNotExist.ResourceId',
- 'errorMessage' => 'The resource does not exist.',
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '208114',
+ 'abilityTreeNodes' => ['FEATUREbpstudioSRFDAT'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TaskId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The disaster recovery switchover task ID.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '2615'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The response parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '923692F0-A15B-58B4-BAF4-2AFA4AF46240'],
+ 'Message' => ['description' => 'The returned message. If the request was successful, a success message is returned. If the request failed, an error message is returned.', 'type' => 'string', 'title' => '', 'example' => 'OKITHEVRQCN6ULQG'],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'title' => '', 'example' => '200'],
+ 'Data' => ['description' => 'The status of the switchover task.', 'type' => 'string', 'title' => '', 'example' => 'Running'],
+ ],
+ 'example' => '',
],
],
- 500 => [
- [
- 'errorCode' => 'ServiceError',
- 'errorMessage' => 'A server error occurred. Please try again later.',
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'GetFoTaskStatus',
+ 'summary' => 'Queries the status of a disaster recovery switchover task by task ID.',
+ 'description' => 'Queries the status of a disaster recovery switchover task by task ID.',
+ 'responseParamsDescription' => 'Task states:'."\n"
+ ."\n"
+ .'- Creating: The task is being created.'."\n"
+ ."\n"
+ .'- Modified: The task is modified.'."\n"
+ ."\n"
+ .'- Verifying: The task is being verified.'."\n"
+ ."\n"
+ .'- Verified\\_Failure: The task failed to pass the verification.'."\n"
+ ."\n"
+ .'- Verified\\_Success: The task passed the verification.'."\n"
+ ."\n"
+ .'- Valuating: Fees are being calculated for the task.'."\n"
+ ."\n"
+ .'- Valuating\\_Failure: Fees failed to be calculated for the task.'."\n"
+ ."\n"
+ .'- Valuating\\_Success: Fees are calculated for the task.'."\n"
+ ."\n"
+ .'- Deploying: The task is being deployed.'."\n"
+ ."\n"
+ .'- Deployed\\_Failure: The task failed to be deployed.'."\n"
+ ."\n"
+ .'- Partially\\_Deployed\\_Success: Some resources of the task are deployed.'."\n"
+ ."\n"
+ .'- Deployed\\_Success: The task is deployed.'."\n"
+ ."\n"
+ .'- Destroying: The task is being released.'."\n"
+ ."\n"
+ .'- Delayed\\_Destroy: The task release is delayed.'."\n"
+ ."\n"
+ .'- Destroyed\\_Failure: The task failed to be released.'."\n"
+ ."\n"
+ .'- Partially\\_Destroyed\\_Success: Some resources of the task are released.'."\n"
+ ."\n"
+ .'- Destroyed\\_Success: The task is released.'."\n"
+ ."\n"
+ .'- Revised: The task architecture is adjusted.'."\n"
+ ."\n"
+ .'- Verifying\\_In\\_Revision: The task resources are being verified during architecture adjustment.'."\n"
+ ."\n"
+ .'- Verified\\_Failure\\_In\\_Revision: The task resources failed to pass the verification during architecture adjustment.'."\n"
+ ."\n"
+ .'- Verified\\_Success\\_In\\_Revision: The task resources are verified during architecture adjustment.'."\n"
+ ."\n"
+ .'- Valuating\\_In\\_Revision: Fees are being calculated for the task during architecture adjustment.'."\n"
+ ."\n"
+ .'- Valuating\\_Failure\\_In\\_Revision: Fees failed to be calculated for the task during architecture adjustment.'."\n"
+ ."\n"
+ .'- Valuating\\_Success\\_In\\_Revision: Fees are calculated for the task during architecture adjustment.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFoTaskStatus'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:GetFoTaskStatus',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
+ ],
],
],
],
- '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',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"923692F0-A15B-58B4-BAF4-2AFA4AF46240\\",\\n \\"Message\\": \\"OKITHEVRQCN6ULQG\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"Running\\"\\n}","type":"json"}]',
],
- 'ReleaseApplication' => [
- 'summary' => 'Releases the resources of an application.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetLinkageAttributesTemplate' => [
+ 'summary' => 'Retrieves the optional values for template variables.',
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'high',
+ 'operationType' => 'get',
+ 'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '91662',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioCGSK4A',
- ],
+ 'abilityTreeCode' => '181941',
+ 'abilityTreeNodes' => ['FEATUREbpstudioRJ9IF1'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'ApplicationId',
+ 'name' => 'TemplateId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用ID',
- 'description' => 'The ID of the application.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '7QSXFQW46ZNGOUDM',
- ],
+ 'schema' => ['description' => 'The template ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'XFKR6WYRVS24S07R'],
],
[
- 'name' => 'ResourceGroupId',
+ 'name' => 'AreaId',
'in' => 'formData',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'Instances',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => 'The ID of the resource group.',
- 'type' => 'string',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'NodeName' => ['description' => 'The name of the instance in the graph.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'vpc'],
+ 'NodeType' => ['description' => 'The instance type.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'vpc'],
+ 'Id' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'vpc-**1q56**taq40*****'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'description' => 'The list of instances to be replaced.',
'required' => false,
- 'example' => 'default',
+ 'example' => '',
],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'Variables',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '幂等标记',
- 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n",
- 'type' => 'string',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'The parameter value.', 'type' => 'any', 'example' => '{"${instance_type}":"ecs.c6.3xlarge"}', 'title' => ''],
+ 'description' => 'The values for the parameters in the template. If you do not specify this parameter, the default values are used.',
'required' => false,
- 'example' => '1600765710019',
+ 'title' => '',
+ 'example' => '',
],
],
+ [
+ 'name' => 'TargetVariable',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The template variable to query.', 'type' => 'string', 'required' => true, 'example' => '${instance_type}', 'title' => ''],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The token to retrieve the next page of results.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '50', 'required' => false, 'example' => '10', 'title' => ''],
+ ],
],
'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',
- ],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', 'title' => ''],
'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',
+ 'type' => 'object',
+ 'properties' => [
+ 'OptionalValues' => ['description' => 'The optional values.', '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"
+ .']', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '400', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'SyntaxError', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '19', 'title' => ''],
+ 'NextToken' => ['description' => 'The token that is used to retrieve the next page of results.', 'type' => 'string', 'example' => '2', 'title' => ''],
+ ],
+ 'description' => 'The data that is returned.',
+ 'title' => '',
+ 'example' => '',
],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'AccessDeniedDetail' => ['description' => 'The details of the access denial.', 'type' => 'string', 'example' => '{'."\n"
+ .' "PolicyType": "",'."\n"
+ .' "AuthPrincipalOwnerId": "",'."\n"
+ .' "EncodedDiagnosticMessage": "",'."\n"
+ .' "AuthPrincipalType": "",'."\n"
+ .' "AuthPrincipalDisplayName": "",'."\n"
+ .' "NoPermissionType": "",'."\n"
+ .' "AuthAction": ""'."\n"
+ .' }', 'title' => ''],
],
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'example' => '',
],
],
],
'errorCodes' => [
200 => [
- [
- 'errorCode' => 'Success',
- 'errorMessage' => 'The transaction is successful.',
- ],
+ ['errorCode' => 'Success', 'errorMessage' => 'The transaction is successful.', 'description' => ''],
],
400 => [
- [
- 'errorCode' => 'ParameterEmpty',
- 'errorMessage' => 'You must specify the request parameter.',
- ],
+ ['errorCode' => 'ParameterEmpty', 'errorMessage' => 'You must specify the request parameter.', 'description' => 'You must specify request parameters.'],
],
- 404 => [
- [
- 'errorCode' => 'EntityNotExist.ResourceGroup',
- 'errorMessage' => 'The resource group does not exist.',
- ],
- [
- 'errorCode' => 'EntityNotExist.ResourceId',
- 'errorMessage' => 'The resource does not exist.',
- ],
+ 403 => [
+ ['errorCode' => 'NoPermissions', 'errorMessage' => 'No permissions.', 'description' => ''],
],
- 500 => [
- [
- 'errorCode' => 'ServiceError',
- 'errorMessage' => 'A server error occurred. Please try again later.',
- ],
+ [
+ ['errorCode' => 'EntityNotExist.ResourceGroup', 'errorMessage' => 'The resource group does not exist.', 'description' => ''],
+ ['errorCode' => 'EntityNotExist.ResourceId', 'errorMessage' => 'The resource does not exist.', 'description' => ''],
],
],
- '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',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'GetLinkageAttributesTemplate',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:GetLinkageAttributesTemplate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Template', 'arn' => 'acs:bpstudio::{#accountId}:template/{#TemplateId}'],
+ ],
+ ],
+ ],
],
+ '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"}]',
+ ],
+ 'GetOperationParams' => [
+ 'summary' => 'Retrieves the input parameters for a specific operation.',
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '91658',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioCGSK4A',
- ],
+ 'abilityTreeCode' => '212309',
+ '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',
+ 'name' => 'ServiceType',
'in' => 'formData',
- 'schema' => [
- 'title' => '资源组ID',
- 'description' => 'The ID of the resource group.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-acfmyjt3c5om3hi',
- ],
+ 'schema' => ['description' => 'The service type.', 'type' => 'string', 'required' => true, 'example' => 'ecs', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'Operation',
'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',
- ],
+ 'schema' => ['description' => 'The operation name.', 'type' => 'string', 'required' => true, 'example' => 'addTags', 'title' => ''],
],
],
'responses' => [
@@ -2972,191 +1906,164 @@
'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',
- ],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'getBpmOperationParams errors'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'F439A659-3B3D-50FB-A4BC-69FBF16413C8'],
+ 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => '200', 'title' => ''],
'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',
+ 'type' => 'object',
+ 'properties' => [
+ 'Service' => ['description' => 'The service type.', 'type' => 'string', 'example' => 'ecs', 'title' => ''],
+ 'Operation' => ['description' => 'The operation name.', 'type' => 'string', 'example' => 'addTags', 'title' => ''],
+ 'Attributes' => ['description' => 'The input parameters.', 'type' => 'object', 'example' => '{'."\n"
+ .' "tags": {'."\n"
+ .' "controlType": "KeyValue",'."\n"
+ .' "display": "Label",'."\n"
+ .' "orderBy": 0,'."\n"
+ .' "associatedLabel": true,'."\n"
+ .' "required": true'."\n"
+ .' }'."\n"
+ .' }', 'title' => ''],
+ 'Properties' => ['description' => 'The input parameters.', 'type' => 'object', 'example' => '{'."\n"
+ .' "instanceId": "ResourceId",'."\n"
+ .' "regionId": "region",'."\n"
+ .' "appId": "appId"'."\n"
+ .' }', 'title' => ''],
+ 'Outputs' => ['description' => 'The output results.', '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"
+ .' }', 'title' => ''],
+ ],
+ 'description' => 'The result set.',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'example' => '',
],
],
],
- '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.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'GetOperationParams',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:GetOperationParams',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Data\\": \\"123\\",\\n \\"Code\\": 200\\n}","type":"json"}]',
- 'title' => 'ValidateApplication',
+ '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"}]',
],
- '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',
- ],
+ 'GetPotentialFailZones' => [
+ 'summary' => 'Queries the zones to which a disaster recovery service can fail over.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '91659',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioCGSK4A',
- ],
+ 'abilityTreeCode' => '208010',
+ 'abilityTreeNodes' => ['FEATUREbpstudio9F383C'],
],
'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',
+ 'name' => 'IsPlanId',
'in' => 'formData',
- 'schema' => [
- 'title' => '资源组ID',
- 'description' => 'The ID of the resource group.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-acfmyjt3c5om3hi',
- ],
+ 'schema' => ['description' => 'Specifies whether the ObjectId parameter specifies a disaster recovery set ID.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'ObjectId',
'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',
- ],
+ 'schema' => ['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.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'FS3ATPTOSC4SE1GG'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'The response parameters.',
'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',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'BFB7F5C8-FE7A-06CA-9F87-ABBF6B848F0C'],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'The specified ResourceIds are not found in our records.'],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'title' => '', 'example' => '200'],
'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',
+ 'title' => '',
+ 'description' => 'The zones to which the disaster recovery service can fail over.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The zone to which the disaster recovery service can fail over.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou-f'],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- '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.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'GetPotentialFailZones',
+ 'description' => 'Queries the zones to which a disaster recovery service can fail over.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPotentialFailZones'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'bpstudio:GetPotentialFailZones',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
+ ],
],
],
],
- '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',
+ '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"}]',
],
'GetResource4ModifyRecord' => [
- 'summary' => 'Queries the configuration change records for an application.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -3168,46 +2075,23 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioDXU2R7',
- ],
+ 'abilityTreeNodes' => ['FEATUREbpstudioDXU2R7'],
],
'parameters' => [
[
'name' => 'ApplicationId',
'in' => 'formData',
- 'schema' => [
- 'title' => '资源组ID，用于资源组相关权限校验',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'BE68D71ZY5YYIU9R',
- ],
+ 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'BE68D71ZY5YYIU9R'],
],
[
'name' => 'NextToken',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The page number to return.', 'type' => 'integer', 'format' => 'int64', 'minimum' => '1', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '100', 'minimum' => '1', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
@@ -3217,126 +2101,96 @@
'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',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187'],
+ 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Data' => [
- 'description' => '',
+ 'description' => 'The change records.'."\n"
+ .'><notice>Upgrading or downgrading a CADT application changes its status to deploying. Query the results after the deployment is complete.></notice>',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'A change record.',
'type' => 'object',
'properties' => [
- 'ResourceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'rm-uf6308dyal1*****',
- ],
- 'Type' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'rds',
- ],
+ 'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'rm-uf6308dyal1*****', 'title' => ''],
+ 'Type' => ['description' => 'The resource type.', 'type' => 'string', 'example' => 'rds', 'title' => ''],
'Status' => [
- 'description' => '',
+ 'description' => 'The change status.',
+ 'enumValueTitles' => ['Init' => 'Init', 'Finish' => 'Finish', 'Fail' => 'Failed', 'Processing' => 'Processing'],
'type' => 'string',
- 'enumValueTitles' => [
- 'Finish' => 'Finish',
- 'Fail' => 'Fail',
- ],
'example' => 'Finish',
+ 'title' => '',
],
- 'ModifyTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1726645341000',
- ],
- 'Attribute' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{\'InstanceId\': \'\', \'AttributeName\': \'drmCommand\', \'Id\': 16800, \'Desc\': \'test\'}',
- ],
- 'Error' => [
- 'type' => 'string',
- ],
+ 'ModifyTime' => ['description' => 'The time when the resource was last modified.', 'type' => 'string', 'example' => '2024-10-15 19:09:25', 'title' => ''],
+ 'Attribute' => ['description' => 'The details of the resource.', 'type' => 'string', 'example' => '{'."\n"
+ .' "InstanceId": "",'."\n"
+ .' "AttributeName": "drmCommand",'."\n"
+ .' "Id": 16800,'."\n"
+ .' "Desc": "test"'."\n"
+ .'}', 'title' => ''],
+ 'Error' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Postpaid.NotSupport : The charge type does not support for postpaid.'."\n"
+ .'RequestId : A0XXXDF2-78FA-1B48-9XX8-88E833A93XXX', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
- '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"
- .' }',
- ],
+ 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'string', 'example' => '123', 'title' => ''],
+ 'NextToken' => ['description' => 'The token that is used to start the next query.', 'type' => 'string', 'example' => '2', 'title' => ''],
+ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '{'."\n"
+ .' "PolicyType": "",'."\n"
+ .' "AuthPrincipalOwnerId": "",'."\n"
+ .' "EncodedDiagnosticMessage": "",'."\n"
+ .' "AuthPrincipalType": "",'."\n"
+ .' "AuthPrincipalDisplayName": "",'."\n"
+ .' "NoPermissionType": "",'."\n"
+ .' "AuthAction": ""'."\n"
+ .' }', 'title' => ''],
],
+ 'example' => '',
],
],
],
'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.',
- ],
+ ['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.', 'description' => ''],
+ ['errorCode' => 'bp.java.8004', 'errorMessage' => 'No permissions.', 'description' => ''],
+ ['errorCode' => 'bp.java.nopower', 'errorMessage' => 'No permissions.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ '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',
+ 'summary' => 'Retrieves the upgrade or downgrade records for an application.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResource4ModifyRecord'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:GetResource4ModifyRecord',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
+ ],
+ ],
+ ],
+ ],
+ '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"}]',
],
'GetResult4QueryInstancePrice4Modify' => [
- 'summary' => 'Queries the result of a request for quotation.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -3348,32 +2202,18 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioDXU2R7',
- ],
+ 'abilityTreeNodes' => ['FEATUREbpstudioDXU2R7'],
],
'parameters' => [
[
'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '操作ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '58d5d8c5b5489150417a7cd6caa614bb',
- ],
+ 'schema' => ['description' => 'The ID of the price inquiry task for the instance configuration change. The ID is valid for one hour. If the task times out, you cannot query the result and the Data parameter is not returned.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'price4modify/19862074****/rm-uf69xr871l***fj39/WQ9ULO4SLD**PQY5/FL1IZLW**3H78OC'],
],
[
'name' => 'ApplicationId',
'in' => 'formData',
- 'schema' => [
- 'title' => '资源组ID，用于资源组相关权限校验',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '02S7UU41WKJL7ERR',
- ],
+ 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '02S7UU41WKJL7ERR'],
],
],
'responses' => [
@@ -3383,704 +2223,460 @@
'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',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187'],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Data' => [
- 'description' => '',
+ 'description' => 'The result of the price inquiry for the instance configuration change.',
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'd9a3e99b-6954-4a16-ad51-954db4a528b7',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
+ 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'd9a3e99b-6954-4a16-ad51-954db4a528b7', 'title' => ''],
+ 'Status' => ['description' => 'The application status.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''],
'PriceList' => [
- 'description' => '',
+ 'description' => 'The list of billing results.<br>'."\n"
+ .'If the instance is a pay-as-you-go instance, three prices are returned. If the instance is a subscription instance and you specify the period\\_unit and period parameters when you query the price for the configuration change, three prices are returned. If you do not specify the period\\_unit and period parameters, only the amount that you must pay after the configuration change is returned.<br>'."\n"
+ .'The three prices are returned in the following order:'."\n"
+ ."\n"
+ .'- The amount that you must pay after the configuration change. For a pay-as-you-go instance, this is the price of the new instance type. For a subscription instance, this is the amount that you must pay for the remaining subscription duration after an upgrade. For example, if you upgrade a one-month instance after half a month, this is the amount that you must pay for the remaining half a month. For a subscription instance, this amount changes as the remaining subscription duration decreases. The amount also varies based on the time when you call the QueryInstancePrice4Modify operation.'."\n"
+ ."\n"
+ .'- The price of the original instance type.'."\n"
+ ."\n"
+ .'- The price of the new instance type. For a subscription instance, this is the price for a full subscription period, such as one month.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The list of billing results.',
'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',
- ],
+ 'NodeType' => ['description' => 'The product code.', 'type' => 'string', 'example' => 'vpc', 'title' => ''],
+ 'TradeAmount' => ['description' => 'The final price. This is the original price minus the discount.', 'type' => 'number', 'format' => 'double', 'example' => '1', 'title' => ''],
+ 'DiscountAmount' => ['description' => 'The discount.', 'type' => 'number', 'format' => 'double', 'example' => '2', 'title' => ''],
+ 'OriginalAmount' => ['description' => 'The original price.', 'type' => 'number', 'format' => 'double', 'example' => '3', 'title' => ''],
+ 'PriceUnit' => ['description' => 'The unit: Amount/Hour.', 'type' => 'string', 'example' => '200/hour', 'title' => ''],
+ 'PromotionName' => ['description' => 'The discount information.', 'type' => 'string', 'example' => 'Offer Information', 'title' => ''],
+ 'Error' => ['description' => 'The cause of the failure.', 'type' => 'string', 'example' => 'Get information on price failures', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
- 'AccessDeniedDetail' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{'."\n"
- .' "PolicyType": "",'."\n"
- .' "AuthPrincipalOwnerId": "",'."\n"
- .' "EncodedDiagnosticMessage": "",'."\n"
- .' "AuthPrincipalType": "",'."\n"
- .' "AuthPrincipalDisplayName": "",'."\n"
- .' "NoPermissionType": "",'."\n"
- .' "AuthAction": ""'."\n"
- .' }',
- ],
+ 'AccessDeniedDetail' => ['description' => 'The details about the failed permission verification.', 'type' => 'string', 'example' => '{'."\n"
+ .' "PolicyType": "",'."\n"
+ .' "AuthPrincipalOwnerId": "",'."\n"
+ .' "EncodedDiagnosticMessage": "",'."\n"
+ .' "AuthPrincipalType": "",'."\n"
+ .' "AuthPrincipalDisplayName": "",'."\n"
+ .' "NoPermissionType": "",'."\n"
+ .' "AuthAction": ""'."\n"
+ .' }', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ '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',
+ 'summary' => 'Retrieves the result of a price inquiry.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResult4QueryInstancePrice4Modify'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:GetResult4QueryInstancePrice4Modify',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
+ ],
+ ],
+ ],
],
+ '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"}]',
+ ],
+ 'GetTask' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '230209',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioRJ9IF1',
- ],
+ 'abilityTreeNodes' => ['FEATUREbpstudioJLICAE'],
],
'parameters' => [
[
- 'name' => 'ApplicationId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '02S7UU41WKJL7ERR',
- ],
- ],
- [
- 'name' => 'InstanceSpec',
+ 'name' => 'TaskId',
'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,
- ],
+ 'schema' => ['description' => 'The ID of the task.', 'type' => 'string', 'required' => false, 'example' => '2615', 'title' => ''],
],
],
'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',
- ],
+ 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'title' => '', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187'],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'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"
- .' }',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => 'The ID of the task.', 'type' => 'integer', 'format' => 'int32', 'example' => '1333', 'title' => ''],
+ 'Name' => ['description' => 'The name of the task.', 'type' => 'string', 'example' => 'test_name', 'title' => ''],
+ 'ProcessId' => ['description' => 'The flow ID.', 'type' => 'string', 'example' => '64QQBC02**FA3W3G', 'title' => ''],
+ 'AppId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'JXT**LZJ568665D6', 'title' => ''],
+ 'InstanceIds' => ['description' => 'The ID of the attached application.', 'type' => 'string', 'example' => '{\\"app\\":\\"JJXT**LZJ568665D6\\"}', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'SyntaxError', 'title' => ''],
+ 'Status' => ['description' => 'FINISH: The task is complete.<br>'."\n"
+ .'BINDING: The application is being attached.<br>', 'type' => 'string', 'example' => 'FINISH ', 'title' => ''],
+ 'GmtCreate' => ['description' => 'The time when the task was created.', 'type' => 'string', 'example' => '2025-08-21 14:07:02', 'title' => ''],
+ ],
+ 'description' => 'The details of the task.',
+ 'title' => '',
+ 'example' => '',
],
+ 'Code' => ['description' => 'The return code.', 'type' => 'string', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'example' => '',
],
],
],
'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.',
- ],
+ 403 => [
+ ['errorCode' => 'NoPermissions', 'errorMessage' => 'No permissions.', 'description' => ''],
],
],
- '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',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'schemes' => [
- 'https',
+ 'title' => 'GetTask',
+ 'summary' => 'Retrieves information about a task.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:GetTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
+ ],
+ ],
+ ],
],
+ '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"}]',
+ ],
+ 'GetTemplate' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
+ 'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '230186',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioJLQBYK',
- ],
+ 'abilityTreeCode' => '91665',
+ 'abilityTreeNodes' => ['FEATUREbpstudioJLICAE', 'FEATUREbpstudio3E4W4L'],
],
'parameters' => [
[
- 'name' => 'ApplicationId',
+ 'name' => 'TemplateId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '002XWH7MXB8MJRU0',
- ],
+ 'schema' => ['description' => 'The ID of the template.', 'type' => 'string', 'required' => true, 'example' => 'XFKR6WYRVS24S07R', 'title' => ''],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'Region',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'rm-uf66k9143r2ch*****',
- ],
+ 'schema' => ['description' => 'The region of the template.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'Configuration',
+ 'name' => 'ResourceGroupId',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'any',
- 'description' => '',
- 'example' => '',
- ],
- ],
+ 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-aekzhfgmw4e6fwq', 'title' => ''],
],
],
'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',
- ],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', 'title' => ''],
'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"
- .' }',
+ 'description' => 'The details of the template.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Description' => ['description' => 'The description of the template.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'ImageURL' => ['description' => 'The path of the template\'s architecture diagram file.', 'type' => 'string', 'example' => 'bp-studio-template/sr-U37UD2YQCRJ75X5V.png', 'title' => ''],
+ 'Name' => ['description' => 'The name of the template.', 'type' => 'string', 'example' => 'cadt-template', 'title' => ''],
+ 'TemplateId' => ['description' => 'The ID of the template.', 'type' => 'string', 'example' => 'XFKR6WYRVS24S07R', 'title' => ''],
+ 'CreateTime' => ['description' => 'The time when the template was created.', 'type' => 'string', 'example' => '2020-09-22 17:08:31', 'title' => ''],
+ 'ResourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'example' => 'rg-aekzhfgmw4e6fwq', 'title' => ''],
+ 'Variables' => [
+ 'description' => 'The details of the template variables.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Attribute' => ['description' => 'The name of the variable.', 'type' => 'string', 'title' => '', 'example' => 'instance_name'],
+ 'DataType' => ['description' => 'The type of the variable.', 'type' => 'string', 'title' => '', 'example' => 'String'],
+ 'DefaultValue' => ['description' => 'The default value.', 'type' => 'string', 'title' => '', 'example' => 'cadt-app-01'],
+ 'Variable' => ['description' => 'The value of the variable.', 'type' => 'string', 'title' => '', 'example' => '${name}'],
+ 'Options' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'DocumentUrl' => ['description' => 'The details of the scenario.', 'type' => 'string', 'title' => '', 'example' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => '200', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- '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',
+ 'errorCodes' => [
+ 200 => [
+ ['errorCode' => 'Success', 'errorMessage' => 'The transaction is successful.', 'description' => ''],
+ ],
+ 400 => [
+ ['errorCode' => 'ParameterEmpty', 'errorMessage' => 'You must specify the request parameter.', 'description' => 'You must specify request parameters.'],
+ ],
+ 404 => [
+ ['errorCode' => 'EntityNotExist.ResourceGroup', 'errorMessage' => 'The resource group does not exist.', 'description' => ''],
+ ['errorCode' => 'EntityNotExist.ResourceId', 'errorMessage' => 'The resource does not exist.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'ServiceError', 'errorMessage' => 'A server error occurred. Please try again later.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'https',
+ 'title' => 'GetTemplate',
+ 'summary' => 'Retrieves information about the template image and architecture diagram.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTemplate'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:GetTemplate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Template', 'arn' => 'acs:bpstudio::{#accountId}:template/{#TemplateId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ ],
+ 'GetToken' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
+ 'deprecated' => true,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioDXU2R7',
- ],
+ 'abilityTreeCode' => '91666',
+ 'abilityTreeNodes' => ['FEATUREbpstudioCGSK4A'],
+ 'tenantRelevance' => 'publicInformation',
],
'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',
+ 'name' => 'ResourceGroupId',
'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' => '',
- ],
- ],
+ 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'rg-aekzhfgmw4e6fwq'],
],
],
'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',
- ],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', 'title' => ''],
'Data' => [
- 'description' => '',
+ 'description' => 'The authorization information.',
'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',
- ],
- ],
- ],
- ],
+ 'SecurityToken' => ['description' => 'The token used to access Object Storage Service (OSS).', 'type' => 'string', 'title' => '', 'example' => 'ABCD'],
+ 'Endpoint' => ['description' => 'The endpoint of OSS.', 'type' => 'string', 'title' => '', 'example' => 'https://oss-cn-beijing.aliyuncs.com'],
+ 'AccessKeySecret' => ['description' => 'The AccessKey secret used to access OSS.', 'type' => 'string', 'title' => '', 'example' => '9NG*****K4X'],
+ 'AccessKeyId' => ['description' => 'The AccessKey ID used to access OSS.', 'type' => 'string', 'title' => '', 'example' => 'STS.NTm*****8tu'],
+ 'Bucket' => ['description' => 'The OSS bucket where files are stored.', 'type' => 'string', 'title' => '', 'example' => 'bucket-1'],
+ 'SnapshotBucket' => ['description' => 'The OSS bucket where snapshots are stored.', 'type' => 'string', 'title' => '', 'example' => 'bucket-2'],
+ 'UploadPrefix' => ['type' => 'string', 'example' => '/12345/', 'description' => '', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
- '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"
- .' }',
- ],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
+ 'errorCodes' => [
+ 200 => [
+ ['errorCode' => 'Success', 'errorMessage' => 'The transaction is successful.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'ServiceError', 'errorMessage' => 'A server error occurred. Please try again later.', 'description' => ''],
+ ],
+ ],
'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'substitutions' => ['BPStudio::2021-09-31::GetApplication'],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'title' => 'GetToken',
+ 'summary' => 'Obtains temporary authorization to read an architecture diagram, which is valid for 30 minutes.',
+ 'description' => '><warning>'."\n"
+ ."\n"
+ .'This API operation is deprecated. Access authorization for application images is included in the properties of the GetApplication response.'."\n"
+ ."\n"
+ .'></warning>',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetToken'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:GetToken',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
+ ],
+ ],
+ ],
],
- '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',
+ 'responseDemo' => '[{"errorExample":"","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 \\"UploadPrefix\\": \\"/12345/\\"\\n },\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
],
- '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',
- ],
+ 'InitAppFailOver' => [
+ 'summary' => 'Prepares for an application switchover and initializes the switchover task.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '212309',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioCGSK4A',
- ],
+ 'abilityTreeCode' => '208065',
+ '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',
- ],
+ 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '002XWH7MXB8MJRU0'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The data returned.',
'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',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187'],
+ 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'title' => '', 'example' => 'Unsupported Operation PrepareEvent->FailOverPrepareSuccess FoApp_DDLJK2WM8ETU9JAC'],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'title' => '', 'example' => '200'],
+ 'Data' => ['description' => 'The ID of the switchover task.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '7250'],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'InitAppFailOver',
+ 'description' => 'Prepares for an application switchover and initializes the switchover task.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InitAppFailOver'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bpstudio:InitAppFailOver',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
+ ],
+ ],
+ ],
],
- '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',
+ '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"}]',
],
- 'ExecuteOperationASync' => [
- 'summary' => 'Asynchronous execution of product operation functions.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListApplication' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4089,122 +2685,61 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '147059',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioCGSK4A',
- ],
+ 'abilityTreeCode' => '91667',
+ 'abilityTreeNodes' => ['FEATUREbpstudioCGSK4A'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'ApplicationId',
+ 'name' => 'NextToken',
'in' => 'formData',
- 'schema' => [
- 'description' => 'The ID of the Cloud Architect Design Tools (CADT) application.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'BG**********UQ',
- ],
+ 'schema' => ['description' => 'The page number for the returned results. The value must be an integer from 1 to 10000.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '10000', 'minimum' => '1', 'example' => '1', 'title' => ''],
],
[
- 'name' => 'ServiceType',
+ 'name' => 'MaxResults',
'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',
- ],
+ 'schema' => ['description' => 'The number of entries to return on each page. The value must be an integer from 1 to 50.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '50', 'minimum' => '1', 'example' => '10', 'title' => ''],
],
[
- 'name' => 'Operation',
+ 'name' => 'Keyword',
'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',
- ],
+ 'schema' => ['description' => 'The keyword to search for in application names.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
- 'name' => 'Attributes',
+ 'name' => 'OrderType',
'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\\"}" }',
- ],
- ],
+ 'schema' => ['description' => 'The sorting order. Valid values:1: Sort by update time.<br>2: Sort by creation time.<br>', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '10', 'minimum' => '1', 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The status of the application.', 'type' => 'string', 'example' => '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", 'title' => '', 'required' => false],
],
[
'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',
- ],
+ 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'ResourceId',
'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',
- ],
+ 'schema' => ['description' => 'The ID of the resource.', 'type' => 'string', 'required' => false, 'example' => 'vsw-xxxxxxxxxxxx', 'title' => ''],
+ ],
+ [
+ 'name' => 'TemplateId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The ID of the template.', 'type' => 'string', 'required' => false, 'example' => '0KSXXX6SJU03TXXX', 'title' => ''],
+ ],
+ [
+ 'name' => 'ShowHide',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Specifies whether to show hidden applications. Default value: \\`true\\`.- \\`true\\`: Shows hidden applications.- \\`false\\`: Does not show hidden applications.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
@@ -4212,49 +2747,105 @@
'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',
- ],
+ 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '123', 'title' => ''],
+ 'Message' => ['description' => 'The message returned for the request.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'NextToken' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'BFB7F5C8-FE7A-06CA-9F87-ABBF6B848F0C', 'title' => ''],
'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' => [
+ 'description' => 'The list of applications.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ImageURL' => ['description' => 'The URL of the application\'s topology graph.', 'type' => 'string', 'title' => '', 'example' => 'https://bp-studio-daily.oss-cn-beijing.aliyuncs.com/1411182597819805/sr-Y3KR7ZSQZR2F0YX3.png'],
+ 'Status' => ['description' => 'The status of the application.', 'type' => 'string', 'title' => '', 'example' => 'Deployed_Success'],
+ 'ApplicationId' => ['description' => 'The ID of the application.', 'type' => 'string', 'title' => '', 'example' => 'JIX9NEZUALGS46UI'],
+ 'Name' => ['description' => 'The name of the application.', 'type' => 'string', 'title' => '', 'example' => 'cadt-appName'],
+ 'CreateTime' => ['description' => 'The time when the application was created.', 'type' => 'string', 'example' => '2021-09-15 08:30:00', 'title' => ''],
+ 'ResourceGroupId' => ['description' => 'The ID of the resource group to which the application belongs.', 'type' => 'string', 'title' => '', 'example' => 'default'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
'title' => '',
- 'description' => 'Result code, 200 for success; Other representatives fail.',
- 'type' => 'string',
- 'format' => 'int32',
- 'example' => '200',
+ 'example' => '',
],
+ 'Code' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- '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',
+ 'errorCodes' => [
+ 200 => [
+ ['errorCode' => 'Success', 'errorMessage' => 'The transaction is successful.', 'description' => ''],
+ ],
+ 400 => [
+ ['errorCode' => 'ParameterEmpty', 'errorMessage' => 'You must specify the request parameter.', 'description' => 'You must specify request parameters.'],
+ ],
+ 404 => [
+ ['errorCode' => 'EntityNotExist.ResourceGroup', 'errorMessage' => 'The resource group does not exist.', 'description' => ''],
+ ['errorCode' => 'EntityNotExist.ResourceId', 'errorMessage' => 'The resource does not exist.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'ServiceError', 'errorMessage' => 'A server error occurred. Please try again later.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'ListApplication',
+ 'summary' => 'This operation returns a list of all applications that belong to the current user. You can use the optional `keyword` parameter to filter the applications by name.',
+ 'responseParamsDescription' => 'The following list describes the possible statuses of an application.'."\n"
+ ."\n"
+ .'Creating: Creating the application.<br>'."\n"
+ .'Modified: The application has been modified.<br>'."\n"
+ .'Verifying: Verifying the application.<br>'."\n"
+ .'Verified\\_Failure: Verification failed.<br>'."\n"
+ .'Verified\\_Success: Verification successful.<br>'."\n"
+ .'Evaluating: Evaluating the application.<br>'."\n"
+ .'Evaluating\\_Failure: Evaluation failed.<br>'."\n"
+ .'Evaluating\\_Success: Evaluation successful.<br>'."\n"
+ .'Deploying: Deploying the application.<br>'."\n"
+ .'Deployed\\_Failure: Deployment failed.<br>'."\n"
+ .'Partially\\_Deployed\\_Success: Partial deployment successful.<br>'."\n"
+ .'Deployed\\_Success: Deployment successful.<br>'."\n"
+ .'Destroying: Destroying the application.<br>'."\n"
+ .'Delayed\\_Destroy: Delayed destruction.<br>'."\n"
+ .'Destroyed\\_Failure: Destruction failed.<br>'."\n"
+ .'Partially\\_Destroyed\\_Success: Partial destruction successful.<br>'."\n"
+ .'Destroyed\\_Success: Destruction successful.<br>'."\n"
+ .'Revised: Architecture revised.<br>'."\n"
+ .'Verifying\\_In\\_Revision: Verifying resources for the revised architecture.<br>'."\n"
+ .'Verified\\_Failure\\_In\\_Revision: Resource verification failed for the revised architecture.<br>'."\n"
+ .'Verified\\_Success\\_In\\_Revision: Resource verification successful for the revised architecture.<br>'."\n"
+ .'Evaluating\\_In\\_Revision: Evaluating the revised architecture.<br>'."\n"
+ .'Evaluating\\_Failure\\_In\\_Revision: Evaluation failed for the revised architecture.<br>'."\n"
+ .'Evaluating\\_Success\\_In\\_Revision: Evaluation successful for the revised architecture.<br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListApplication'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ListApplication',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ ],
+ 'ListFoCreatedApps' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4263,110 +2854,127 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'list',
'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',
- ],
- ],
+ 'abilityTreeCode' => '207619',
+ 'abilityTreeNodes' => ['FEATUREbpstudioJLQBYK'],
],
+ 'parameters' => [],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'The data returned.',
'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',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '40F63F07-3AB6-53B3-8825-0580C130E3EA'],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Cannot find region according to your domain.'],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => '200'],
'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' => '" "',
+ 'title' => '',
+ 'description' => 'The list of templates.',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '',
+ 'description' => 'The application data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'JIX9NEZUALGS46UI'],
+ 'Title' => ['description' => 'The title.', 'type' => 'string', 'title' => '', 'example' => 'Disaster Recovery Plan'],
+ 'ReportUrl' => ['description' => 'The URL of the fault report.', 'type' => 'string', 'title' => '', 'example' => '14318082782*****/drs-application-3ET9ZEVPOWRDZK0N.pdf'],
+ 'Status' => ['description' => 'The status of the application.', 'type' => 'string', 'title' => '', 'example' => 'Deployed_Success'],
],
+ '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',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- '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',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ListFoCreatedApps',
+ 'summary' => 'This operation queries all disaster recovery service plans in the current account.',
+ 'description' => 'This operation queries all disaster recovery service plans in the current account.',
+ 'requestParamsDescription' => 'No request parameters are required.',
+ 'responseParamsDescription' => 'The following list describes the application statuses:'."\n"
+ ."\n"
+ .'- Creating: The application is being created.'."\n"
+ ."\n"
+ .'- Modified: The application has been modified.'."\n"
+ ."\n"
+ .'- Verifying: The application is being verified.'."\n"
+ ."\n"
+ .'- Verified\\_Failure: The application verification failed.'."\n"
+ ."\n"
+ .'- Verified\\_Success: The application is successfully verified.'."\n"
+ ."\n"
+ .'- Pricing: The price of the application is being calculated.'."\n"
+ ."\n"
+ .'- Pricing\\_Failure: The price calculation for the application failed.'."\n"
+ ."\n"
+ .'- Pricing\\_Success: The price of the application has been calculated.'."\n"
+ ."\n"
+ .'- Deploying: The application is being deployed.'."\n"
+ ."\n"
+ .'- Deployed\\_Failure: The application deployment failed.'."\n"
+ ."\n"
+ .'- Partially\\_Deployed\\_Success: The application is partially deployed.'."\n"
+ ."\n"
+ .'- Deployed\\_Success: The application is successfully deployed.'."\n"
+ ."\n"
+ .'- Destroying: The application is being destroyed.'."\n"
+ ."\n"
+ .'- Delayed\\_Destroy: The application is scheduled to be destroyed.'."\n"
+ ."\n"
+ .'- Destroyed\\_Failure: The application destruction failed.'."\n"
+ ."\n"
+ .'- Partially\\_Destroyed\\_Success: The application is partially destroyed.'."\n"
+ ."\n"
+ .'- Destroyed\\_Success: The application is successfully destroyed.'."\n"
+ ."\n"
+ .'- Revised: The architecture is being adjusted.'."\n"
+ ."\n"
+ .'- Verifying\\_In\\_Revision: The resources are being verified for architecture adjustment.'."\n"
+ ."\n"
+ .'- Verified\\_Failure\\_In\\_Revision: The resource verification for the architecture adjustment failed.'."\n"
+ ."\n"
+ .'- Verified\\_Success\\_In\\_Revision: The resources for the architecture adjustment have been verified.'."\n"
+ ."\n"
+ .'- Pricing\\_In\\_Revision: The price for the architecture adjustment is being calculated.'."\n"
+ ."\n"
+ .'- Pricing\\_Failure\\_In\\_Revision: The price calculation for the architecture adjustment failed.'."\n"
+ ."\n"
+ .'- Pricing\\_Success\\_In\\_Revision: The price for the architecture adjustment has been calculated.',
+ 'extraInfo' => '无',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFoCreatedApps'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ListFoCreatedApps',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
+ ],
+ ],
+ ],
+ ],
+ '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"}]',
],
- 'ListServices' => [
- 'summary' => '查看支持的服务列表',
+ 'ListOperations' => [
+ 'summary' => 'Lists the operations that a service supports.',
'path' => '',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -4379,63 +2987,73 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '212309',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioCGSK4A',
+ 'abilityTreeNodes' => ['FEATUREbpstudioCGSK4A'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ServiceType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The service type.', 'type' => 'string', 'required' => true, 'example' => 'ecs', 'title' => ''],
],
],
- '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',
- ],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'NotFound'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187'],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Data' => [
- 'description' => '',
'type' => 'array',
'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ecs',
+ 'type' => 'object',
+ 'properties' => [
+ 'Service' => ['description' => 'The service type.', 'type' => 'string', 'example' => 'ecs', 'title' => ''],
+ 'Operation' => ['description' => 'The operation name.', 'type' => 'string', 'example' => 'addTags', 'title' => ''],
+ 'DisplayName' => ['description' => 'The description of the operation.', 'type' => 'string', 'example' => 'Add Tag', 'title' => ''],
+ ],
+ 'description' => 'A list of operations.',
+ 'title' => '',
+ 'example' => '',
],
+ 'description' => 'The data returned.',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ListOperations',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"error\\",\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": [\\n \\"ecs\\"\\n ]\\n}","type":"json"}]',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ListOperations',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
+ ],
+ ],
+ ],
+ ],
+ '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"}]',
],
- 'ListOperations' => [
- 'summary' => '查看某服务支持的操作',
+ 'ListServices' => [
+ 'summary' => 'Lists the supported services.',
'path' => '',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -4448,90 +3066,56 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '212309',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioCGSK4A',
- ],
- ],
- 'parameters' => [
- [
- 'name' => 'ServiceType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ecs',
- ],
- ],
+ 'abilityTreeNodes' => ['FEATUREbpstudioCGSK4A'],
],
+ 'parameters' => [],
'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',
- ],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'error'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187'],
+ 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => '200', 'title' => ''],
'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',
- ],
- ],
- ],
+ 'items' => ['description' => 'The service type.', 'type' => 'string', 'example' => 'ecs', 'title' => ''],
+ 'description' => 'A collection of service types.',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'example' => '',
],
],
],
- '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',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ListServices',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ListServices',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"error\\",\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": [\\n \\"ecs\\"\\n ]\\n}","type":"json"}]',
+ ],
+ 'ListTagResources' => [
+ 'summary' => 'Queries the tags of an application or a template.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4543,739 +3127,1571 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '212309',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioCGSK4A',
- ],
+ 'abilityTreeCode' => '173661',
+ 'abilityTreeNodes' => ['FEATUREbpstudioCGSK4A'],
],
'parameters' => [
[
- 'name' => 'ServiceType',
+ 'name' => 'ClientToken',
'in' => 'formData',
+ 'schema' => ['description' => 'An idempotence token.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => '1600765710019'],
+ ],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The token that is used to start the next query.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'ResourceType',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The resource type.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'Application'],
+ ],
+ [
+ 'name' => 'ResourceId',
+ 'in' => 'formData',
+ 'style' => 'flat',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'The resource IDs. You can specify up to 50 resource IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'If you set \\`ResourceType\\` to \\`Application\\`, \\`ResourceId\\` is the application ID.'."\n"
+ .'If you set \\`ResourceType\\` to \\`Template\\`, \\`ResourceId\\` is the template ID.', 'type' => 'string', 'required' => true, 'example' => 'A926QK1X89YF2G62', 'title' => ''],
'required' => true,
- 'example' => 'ecs',
+ 'example' => '',
],
],
[
- 'name' => 'Operation',
+ 'name' => 'Tag',
'in' => 'formData',
+ 'style' => 'flat',
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'rename',
+ 'title' => '',
+ 'description' => 'The tags. You can specify up to 20 tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the tag.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'tag1'],
+ 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'value1'],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'example' => '',
],
],
],
'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"
- .' }',
+ 'NextToken' => ['description' => 'The token that is used to start the next query. If this parameter is empty, it indicates that no more results are available.', 'type' => 'string', 'title' => '', 'example' => '1'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '847C9D0A-BABD-589C-8A9C-6464409EDED9', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'bp.java.nopowerContact', 'title' => ''],
+ 'TagResources' => [
+ 'title' => 'TagResource',
+ 'description' => 'The details of the tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A collection of tag resources.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ResourceType' => ['description' => '\\`Application\\` or \\`Template\\`.', 'type' => 'string', 'example' => 'application', 'title' => ''],
+ 'TagValue' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'Value', 'title' => ''],
+ 'ResourceId' => ['description' => 'The ID of the CADT application or template.', 'type' => 'string', 'example' => 'MW7T1820ACJX9BI7', 'title' => ''],
+ 'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'Key', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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.', 'description' => ''],
+ ],
],
- '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',
+ 'title' => 'ListTagResources',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ListTagResources',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
+ ],
+ ],
+ ],
],
+ '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"}]',
+ ],
+ 'ListTemplate' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '150656',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioINUEOA',
- ],
+ 'abilityTreeCode' => '91668',
+ 'abilityTreeNodes' => ['FEATUREbpstudioRJ9IF1'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'ResourceId',
+ 'name' => 'NextToken',
'in' => 'formData',
- 'schema' => [
- 'description' => 'The ID of the resource.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'P7RMVSVM9LOVYQOM',
- ],
+ 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '10000', 'minimum' => '1', 'example' => '1', 'title' => ''],
],
[
- 'name' => 'NewResourceGroupId',
+ 'name' => 'MaxResults',
'in' => 'formData',
- 'schema' => [
- 'description' => 'The ID of the new resource group.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'rg-aek2ajbjoloa23q',
- ],
+ 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '50', 'exclusiveMaximum' => false, 'minimum' => '1', 'example' => '10', 'title' => ''],
],
[
- 'name' => 'ResourceType',
+ 'name' => 'OrderType',
'in' => 'formData',
+ 'schema' => ['description' => 'The field to sort by:'."\n"
+ ."\n"
+ .'- 1: Sort by update time.'."\n"
+ ."\n"
+ .'- 2: Sort by creation time.'."\n"
+ ."\n"
+ .'- 3: Sort by system recommendation.'."\n"
+ ."\n"
+ .'- 4: Sort by usage count.'."\n"
+ ."\n"
+ .'- If you do not specify this parameter or specify an integer other than 1, 2, 3, or 4, the results are sorted by system recommendation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '5', 'minimum' => '1', 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'Keyword',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'A keyword for searching template names.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '“CADT”'],
+ ],
+ [
+ 'name' => 'Type',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'public indicates a public template. private indicates a private template.', 'type' => 'string', 'required' => true, 'example' => 'private', 'title' => ''],
+ ],
+ [
+ 'name' => 'TagList',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The tags of the template.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => true, 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '2', 'title' => ''],
+ ],
+ [
+ 'name' => 'ResourceGroupId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyjt3c5om3hi', 'title' => ''],
+ ],
+ [
+ 'name' => 'Tag',
+ 'in' => 'formData',
+ 'style' => 'json',
'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',
+ 'description' => 'The list of tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Tag information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'tag', 'title' => ''],
+ 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'value', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
'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',
- ],
+ 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'NextToken' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', 'title' => ''],
'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',
+ 'description' => 'The list of templates.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ImageURL' => ['description' => 'The image URL of the template.', 'type' => 'string', 'title' => '', 'example' => 'bp-studio-template/sr-U37UD2YQCRJ75X5V.png'],
+ 'TagId' => ['description' => 'The ID of the template\'s tag.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => true, 'title' => '', 'example' => '1'],
+ 'TagName' => ['description' => 'The name of the template\'s tag.', 'type' => 'string', 'deprecated' => true, 'title' => '', 'example' => 'TagName'],
+ 'Name' => ['description' => 'The name of the template.', 'type' => 'string', 'title' => '', 'example' => 'cadt-name'],
+ 'TemplateId' => ['description' => 'The ID of the template.', 'type' => 'string', 'title' => '', 'example' => 'CJQ6H0XUEQ20IYJQ'],
+ 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'title' => '', 'example' => '2021-03-18 16:41:31'],
+ 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'title' => '', 'example' => 'rg-acfmyjt3c5om3hi'],
+ 'Tag' => [
+ 'description' => 'The list of tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Tag information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'tag1', 'title' => ''],
+ 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'value1', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Description' => ['description' => 'The description of the template.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'DocumentUrl' => ['description' => 'The scenario details.', 'type' => 'string', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- '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',
+ 'errorCodes' => [
+ 200 => [
+ ['errorCode' => 'Success', 'errorMessage' => 'The transaction is successful.', 'description' => ''],
+ ],
+ 400 => [
+ ['errorCode' => 'ParameterEmpty', 'errorMessage' => 'You must specify the request parameter.', 'description' => 'You must specify request parameters.'],
+ ],
+ 404 => [
+ ['errorCode' => 'EntityNotExist.ResourceId', 'errorMessage' => 'The resource does not exist.', 'description' => ''],
+ ['errorCode' => 'EntityNotExist.ResourceGroup', 'errorMessage' => 'The resource group does not exist.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'ServiceError', 'errorMessage' => 'A server error occurred. Please try again later.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'ListTemplate',
+ 'summary' => 'Retrieves a list of templates, including their names, architecture diagram URLs, and serialized architecture diagram file URLs.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTemplate'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ListTemplate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ ],
+ 'ModifyApplicationSpec' => [
+ 'summary' => 'Modifies the configuration of an application.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
- 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '208078',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioJD8QWK',
- ],
+ 'abilityTreeCode' => '230209',
+ 'abilityTreeNodes' => ['FEATUREbpstudioRJ9IF1'],
],
'parameters' => [
[
'name' => 'ApplicationId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用ID',
- 'description' => 'The application ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'BE68D71ZY5YYIU9R',
- ],
+ 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '02S7UU41WKJL7ERR', 'title' => ''],
],
[
- 'name' => 'FailZone',
+ 'name' => 'InstanceSpec',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '容灾切换目标可用区',
- 'description' => 'The destination zone to which you want to switch the disaster recovery application.'."\n",
- 'type' => 'string',
+ 'description' => 'The specifications for the configuration change.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The parameters for the configuration change.',
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['description' => 'The ID of the resource to change.', 'type' => 'string', 'required' => false, 'example' => 'rm-2ze8f4ah378a*****', 'title' => ''],
+ 'Configuration' => [
+ 'description' => 'The parameters for the configuration change.',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['description' => 'The input parameters for the configuration change.'."\n"
+ ."\n"
+ .'> - For subscription instances, use \\`UPGRADE\\` for upgrades and \\`DOWNGRADE\\` for downgrades. For pay-as-you-go instances, use \\`UPGRADE\\` for all configuration changes.'."\n"
+ ."\n"
+ .'ecs<br>'."\n"
+ ."\n"
+ .'- orderType: UPGRADE<br>'."\n"
+ ."\n"
+ .'- instance\\_type: xxx (Instance type)<br>'."\n"
+ ."\n"
+ .'rds (You can change the instance type and storage capacity at the same time.)<br>'."\n"
+ ."\n"
+ .'- orderType: UPGRADE<br>'."\n"
+ ."\n"
+ .'- instance\\_type: xxx (Instance type)<br>'."\n"
+ ."\n"
+ .'- instance\\_storage: xxx (Storage capacity)<br>'."\n"
+ ."\n"
+ .'kvstore<br>'."\n"
+ ."\n"
+ .'- orderType: UPGRADE<br>'."\n"
+ ."\n"
+ .'- number: 1 (Number of shards)<br>'."\n"
+ ."\n"
+ .'- instance\\_class: xxx (Instance type)'."\n"
+ ."\n"
+ .'kvstore\\_prepaid\\_public\\_cn<br>'."\n"
+ ."\n"
+ .'- orderType: UPGRADE<br>'."\n"
+ ."\n"
+ .'- shard\\_quantity: 4 (Number of shards)<br>'."\n"
+ ."\n"
+ .'- shard\\_class: xxx (Shard specifications)<br>'."\n"
+ ."\n"
+ .'- storage: 10 (Disk capacity)<br>'."\n"
+ ."\n"
+ .'tair<br>'."\n"
+ ."\n"
+ .'- orderType: UPGRADE<br>'."\n"
+ ."\n"
+ .'- shard\\_quantity: 4 (Number of shards)<br>'."\n"
+ ."\n"
+ .'- shard\\_class: xxxx (Shard specifications)<br>'."\n"
+ ."\n"
+ .'kafka<br>'."\n"
+ ."\n"
+ .'- orderType: UPGRADE<br>'."\n"
+ ."\n"
+ .'- eip\\_max (Internet traffic):<br>'."\n"
+ ."\n"
+ .'- IO\\_max (Internet traffic):<br>'."\n"
+ ."\n"
+ .'- partition\\_num: Number of partitions<br>'."\n"
+ ."\n"
+ .'- disk\\_size (Disk capacity):<br>'."\n"
+ ."\n"
+ .'polardb<br>'."\n"
+ ."\n"
+ .'- orderType: UPGRADE<br>'."\n"
+ ."\n"
+ .'- master\\_spec (Node specifications):<br>'."\n"
+ ."\n"
+ .'elasticsearch<br>'."\n"
+ ."\n"
+ .'- orderType: UPGRADE<br>'."\n"
+ ."\n"
+ .'- node\\_spec (Data node specifications):'."\n"
+ ."\n"
+ .'- kibana\\_node\\_spec (Kibana node specifications):'."\n"
+ ."\n"
+ .'- master\\_spec (Dedicated master node specifications)'."\n"
+ ."\n"
+ .'- warm\\_node\\_spec (Cold data node specifications):'."\n"
+ ."\n"
+ .'- client\\_node\\_spec (Coordinating node specifications):'."\n"
+ ."\n"
+ .'- elastic\\_node\\_spec (Elastic data node):'."\n"
+ ."\n"
+ .'hitsdb\\_lindormnext\\_v2<br>'."\n"
+ ."\n"
+ .'- orderType: UPGRADE<br>'."\n"
+ ."\n"
+ .'- upgrade\\_type: SPEC (specifications), OPEN (enable), or `COUNT` (number of nodes)'."\n"
+ ."\n"
+ .'- engine\\_type (Engine type): TABLE (LindormTable), TSDB (LindormTSDB), LSEARCH (search engine), LTS (LTS engine), LVECTOR (vector engine), or `LCOLUMN` (column store engine)'."\n"
+ ."\n"
+ .'- node\\_type (Node type): universal (general-purpose), calculated (compute-optimized), mem\\_enhanced (memory-optimized), local\\_hdd\\_pro (local HDD), or `local_ssd_pro` (local SSD)'."\n"
+ ."\n"
+ .'- node\\_spec (Node specifications):'."\n"
+ ."\n"
+ .'- core\\_num (Number of nodes):'."\n"
+ ."\n"
+ .'- is\\_cloud\\_disk (Mount a cloud disk): \\`true\\` or \\`false\\`'."\n"
+ ."\n"
+ .'- disk\\_type (Cloud disk type): \\`cloud\\_efficiency\\` or \\`cloud\\_essd\\`'."\n"
+ ."\n"
+ .'- disk\\_size (Cloud disk storage capacity):<br><br>'."\n"
+ ."\n"
+ .'slb<br>'."\n"
+ ."\n"
+ .'> Valid values for \\`InstanceChargeType\\` (instance billing method): \\`PayBySpec\\` (pay-by-specification) and \\`PayByCLCU\\` (pay-by-usage).<br>'."\n"
+ .'> Valid values for \\`internet\\_charge\\_type\\` (Internet traffic fee): \\`0\\` (pay-by-bandwidth) and \\`1\\` (pay-by-traffic).<br>'."\n"
+ .'> If you set \\`InstanceChargeType\\` to \\`PayBySpec\\`, the \\`specification\\` parameter is required.<br>'."\n"
+ .'> If you set \\`internet\\_charge\\_type\\` to \\`0\\`, the \\`bandwidth\\` parameter is required.<br><br><br><br>'."\n"
+ ."\n"
+ .'- orderType: UPGRADE<br>'."\n"
+ ."\n"
+ .'- specification (Instance type):'."\n"
+ ."\n"
+ .'- InstanceChargeType (Instance billing method):<br>'."\n"
+ ."\n"
+ .'- internet\\_charge\\_type (Internet traffic fee):'."\n"
+ ."\n"
+ .'- bandwidth (Bandwidth):'."\n"
+ ."\n"
+ .'hbase<br>'."\n"
+ ."\n"
+ .'- orderType: UPGRADE<br>'."\n"
+ ."\n"
+ .'- core\\_instance\\_type (Core instance type):'."\n"
+ ."\n"
+ .'dds<br>'."\n"
+ ."\n"
+ .'- orderType: UPGRADE<br>'."\n"
+ ."\n"
+ .'- db\\_instance\\_class (Instance type):'."\n"
+ ."\n"
+ .'onspre<br>'."\n"
+ ."\n"
+ .'<details>'."\n"
+ ."\n"
+ .'<summary>'."\n"
+ ."\n"
+ .'Upgrade or downgrade the specifications of an Enterprise Platinum Edition instance'."\n"
+ ."\n"
+ .'</summary>'."\n"
+ ."\n"
+ .'- orderType: UPGRADE<br>'."\n"
+ ."\n"
+ .'- tps\\_max (Peak TPS):'."\n"
+ ."\n"
+ .'- topic\\_capacity (Maximum number of topics):'."\n"
+ ."\n"
+ .'- message\\_capacity (Message storage):'."\n"
+ ."\n"
+ .'</details>'."\n"
+ ."\n"
+ .'<details>'."\n"
+ ."\n"
+ .'<summary>'."\n"
+ ."\n"
+ .'Upgrade a Standard Edition instance to an Enterprise Platinum Edition instance'."\n"
+ ."\n"
+ .'</summary>'."\n"
+ ."\n"
+ .'orderType: BUY'."\n"
+ .'tps\\_max (Peak TPS):'."\n"
+ .'topic\\_capacity (Maximum number of topics):'."\n"
+ .'message\\_capacity (Message storage):'."\n"
+ .'period\\_unit (Subscription unit): \\`Month\\` or \\`Year\\`'."\n"
+ ."\n"
+ .'- period (Subscription duration):'."\n"
+ ."\n"
+ .'</details>'."\n"
+ ."\n"
+ .'hitsdb\\_lindorm<br>'."\n"
+ ."\n"
+ .'- orderType: UPGRADE<br>'."\n"
+ ."\n"
+ .'- lindorm\\_core\\_spec (Wide table node specifications):'."\n"
+ ."\n"
+ .'drds<br>'."\n"
+ ."\n"
+ .'- orderType: UPGRADE<br>'."\n"
+ ."\n"
+ .'- drds\\_instance\\_spec (Instance type):'."\n"
+ ."\n"
+ .'clickhouse'."\n"
+ .'Change the configuration of an Enterprise Edition instance:<br>'."\n"
+ ."\n"
+ .'- max\\_ccu (Maximum CCUs):'."\n"
+ ."\n"
+ .'- mini\\_ccu (Minimum CCUs):'."\n"
+ ."\n"
+ .'Community Edition instance:'."\n"
+ .'Horizontal scaling:<br>'."\n"
+ ."\n"
+ .'- node\\_count (Number of nodes):'."\n"
+ ."\n"
+ .'Vertical scaling:'."\n"
+ ."\n"
+ .'- zkSize (Zookeeper specifications):'."\n"
+ ."\n"
+ .'- instance\\_class (Instance type):'."\n"
+ ."\n"
+ .'- storage\\_type (Storage class):'."\n"
+ ."\n"
+ .'- storage\\_size (Storage space):'."\n"
+ ."\n"
+ .'drds\\_polarx'."\n"
+ .'Standard Edition:<br>'."\n"
+ ."\n"
+ .'- node\\_spec (Node specifications):'."\n"
+ ."\n"
+ .'Enterprise Edition:'."\n"
+ ."\n"
+ .'- cn\\_node\\_spec (Compute node specifications):'."\n"
+ ."\n"
+ .'- dn\\_node\\_spec (Data node specifications):'."\n"
+ ."\n"
+ .'- dn\\_storage\\_space (Data node disk):'."\n"
+ ."\n"
+ .'opensearch'."\n"
+ ."\n"
+ .'- buytype (Cluster preference):'."\n"
+ ."\n"
+ .'- storage (Storage capacity):'."\n"
+ ."\n"
+ .'- compute (Compute resource):'."\n"
+ ."\n"
+ .'eip'."\n"
+ ."\n"
+ .'- bandwidths (Peak bandwidth):'."\n"
+ ."\n"
+ .'- internet\\_charge\\_type (Traffic):'."\n"
+ ."\n"
+ .'- bandwidth (Bandwidth):'."\n"
+ ."\n"
+ .'adb'."\n"
+ ."\n"
+ .'- reserved\\_node\\_size (Single-node specifications of reserved resources):'."\n"
+ ."\n"
+ .'- reserved\\_node\\_count (Number of reserved nodes):'."\n"
+ ."\n"
+ .'- Activate\\_AI\\_node (Enable AI nodes):'."\n"
+ ."\n"
+ .'- ADB\\_AI\\_Node\\_Size (AI node specifications):'."\n"
+ ."\n"
+ .'- AI\\_Node\\_Count\\_Postpaid (Number of AI nodes):'."\n"
+ ."\n"
+ .'- Deployment\\_Method (Deployment mode):'."\n"
+ ."\n"
+ .'- zone\\_id (Primary zone):'."\n"
+ ."\n"
+ .'- vswitch\\_id (vSwitch of the primary zone):'."\n"
+ ."\n"
+ .'- StandbyAZ (Secondary zone):'."\n"
+ ."\n"
+ .'- Standby\\_vswitch\\_id (vSwitch of the secondary zone):'."\n"
+ ."\n"
+ .'hologres'."\n"
+ ."\n"
+ .'- size (Compute resources):'."\n"
+ ."\n"
+ .'- GatewayNum (Number of Gateway nodes):'."\n"
+ ."\n"
+ .'- warehouse\\_cu (Reserved compute resources for the compute group):'."\n"
+ ."\n"
+ .'- enable\\_serverless\\_computing (Enable Serverless Computing):'."\n"
+ ."\n"
+ .'flink'."\n"
+ ."\n"
+ .'- max\\_cu (Maximum quota):'."\n"
+ ."\n"
+ .'- min\\_cu (Compute resource quota in a single zone):'."\n"
+ ."\n"
+ .'- min\\_cu\\_ha (Cross-zone):'."\n"
+ ."\n"
+ .'dts'."\n"
+ ."\n"
+ .'- instance\\_class (Data synchronization configuration change):'."\n"
+ ."\n"
+ .'- migration\\_instance\\_class (Data migration configuration change):'."\n"
+ ."\n"
+ .'hitsdb\\_lts'."\n"
+ ."\n"
+ .'- upgrade\\_type: upgrade-lts-core-num'."\n"
+ ."\n"
+ .'- core\\_number (Number of nodes):'."\n"
+ ."\n"
+ .'- upgrade\\_type: upgrade-lts-engine'."\n"
+ ."\n"
+ .'- core\\_spec (Node specifications):'."\n"
+ ."\n"
+ .'ons\\_rmq'."\n"
+ ."\n"
+ .'- msg\\_process\\_spec (Message processing compute specifications):'."\n"
+ ."\n"
+ .'- series\\_type (Primary series type):', 'type' => 'any', 'example' => 'orderType:UPGRADE', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
- 'example' => 'cn-hangzhou-g',
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '返回数据',
- 'description' => 'The response parameters.'."\n",
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'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',
- ],
+ 'Success' => ['title' => 'Id of the request', 'description' => 'Indicates whether the request was successful.', 'type' => 'string', 'example' => 'true'],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'Data' => ['description' => 'The return value.', 'type' => 'string', 'example' => '-1', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A3488F1D-xxxx-xxxx-xxxx-5374BA0F3562', 'title' => ''],
+ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '{'."\n"
+ .' "PolicyType": "",'."\n"
+ .' "AuthPrincipalOwnerId": "",'."\n"
+ .' "EncodedDiagnosticMessage": "",'."\n"
+ .' "AuthPrincipalType": "",'."\n"
+ .' "AuthPrincipalDisplayName": "",'."\n"
+ .' "NoPermissionType": "",'."\n"
+ .' "AuthAction": ""'."\n"
+ .' }', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'bp.java.8004', 'errorMessage' => 'No permissions.', 'description' => ''],
+ ['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.', 'description' => ''],
+ ['errorCode' => 'bp.java.nopower', 'errorMessage' => 'No permissions.', 'description' => ''],
+ ],
],
- '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',
+ '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',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApplicationSpec'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ModifyApplicationSpec',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'QueryInstancePrice4Modify' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
- 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '208010',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudio9F383C',
- ],
+ 'abilityTreeCode' => '230186',
+ 'abilityTreeNodes' => ['FEATUREbpstudioJLQBYK'],
],
'parameters' => [
[
- 'name' => 'IsPlanId',
+ 'name' => 'ApplicationId',
'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',
- ],
+ 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '002XWH7MXB8MJRU0', 'title' => ''],
],
[
- 'name' => 'ObjectId',
+ 'name' => 'InstanceId',
'in' => 'formData',
+ 'schema' => ['description' => 'The ID of the resource to upgrade or downgrade.', 'type' => 'string', 'required' => true, 'example' => 'rm-uf66k9143r2ch*****', 'title' => ''],
+ ],
+ [
+ 'name' => 'Configuration',
+ 'in' => 'formData',
+ 'style' => 'json',
'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',
+ 'description' => 'The list of target configurations.',
+ 'type' => 'object',
'required' => false,
- 'example' => 'FS3ATPTOSC4SE1GG',
+ 'additionalProperties' => ['description' => 'The target configuration parameters.<br>'."\n"
+ ."\n"
+ .'> - For subscription instances, set this parameter to \\`UPGRADE\\` for upgrades and \\`DOWNGRADE\\` for downgrades. For pay-as-you-go instances, set this parameter to \\`UPGRADE\\` for both upgrades and downgrades because the configuration is simply changed.'."\n"
+ .'>'."\n"
+ .'> - Optional parameters for subscription instances. \\`period\\_unit\\`: The unit of the subscription duration. Valid values: \\`Month\\`, \\`Week\\`, and \\`Year\\`. \\`period\\`: The subscription duration. If you set this to \\`1\\`, the price for one unit of time is returned.'."\n"
+ ."\n"
+ .'ecs<br>'."\n"
+ ."\n"
+ .'- orderType:UPGRADE<br>'."\n"
+ ."\n"
+ .'- instance\\_type:xxx (Instance type)<br>'."\n"
+ ."\n"
+ .'rds (You can change the instance type and capacity at the same time.)<br>'."\n"
+ ."\n"
+ .'- orderType:UPGRADE<br>'."\n"
+ ."\n"
+ .'- instance\\_type:xxx (Instance type)<br>'."\n"
+ ."\n"
+ .'- instance\\_storage:xxx (Capacity)<br>'."\n"
+ ."\n"
+ .'kvstore<br>'."\n"
+ ."\n"
+ .'- orderType:UPGRADE<br>'."\n"
+ ."\n"
+ .'- number:1 (Number of shards)<br>'."\n"
+ ."\n"
+ .'- instance\\_class:xxx (Instance type)'."\n"
+ ."\n"
+ .'kvstore\\_prepaid\\_public\\_cn<br>'."\n"
+ ."\n"
+ .'- orderType:UPGRADE<br>'."\n"
+ ."\n"
+ .'- shard\\_quantity:4 (Number of shards)<br>'."\n"
+ ."\n"
+ .'- shard\\_class: xxx (Shard specifications)<br>'."\n"
+ ."\n"
+ .'- storage: 10 (Disk capacity)<br>'."\n"
+ ."\n"
+ .'tair<br>'."\n"
+ ."\n"
+ .'- orderType:UPGRADE<br>'."\n"
+ ."\n"
+ .'- shard\\_quantity:4 (Number of shards)<br>'."\n"
+ ."\n"
+ .'- shard\\_class: xxxx (Shard specifications)<br>'."\n"
+ ."\n"
+ .'kafka<br>'."\n"
+ ."\n"
+ .'- orderType:UPGRADE<br>'."\n"
+ ."\n"
+ .'- eip\\_max (Internet traffic):<br>'."\n"
+ ."\n"
+ .'- IO\\_max (Internet traffic):<br>'."\n"
+ ."\n"
+ .'- partition\\_num: Number of partitions<br>'."\n"
+ ."\n"
+ .'- disk\\_size (Disk capacity):<br>'."\n"
+ ."\n"
+ .'polardb<br>'."\n"
+ ."\n"
+ .'- orderType:UPGRADE<br>'."\n"
+ ."\n"
+ .'- master\\_spec (Node specifications):<br>'."\n"
+ ."\n"
+ .'elasticsearch<br>'."\n"
+ ."\n"
+ .'- orderType:UPGRADE<br>'."\n"
+ ."\n"
+ .'- node\\_spec (Data node specifications):'."\n"
+ ."\n"
+ .'- kibana\\_node\\_spec (Kibana node specifications):'."\n"
+ ."\n"
+ .'- master\\_spec (Dedicated master node specifications)'."\n"
+ ."\n"
+ .'- warm\\_node\\_spec (Cold data node specifications):'."\n"
+ ."\n"
+ .'- client\\_node\\_spec (Coordinator node specifications):'."\n"
+ ."\n"
+ .'- elastic\\_node\\_spec (Elastic data node):'."\n"
+ ."\n"
+ .'hitsdb\\_lindormnext<br>'."\n"
+ ."\n"
+ .'> - You can add engines. The parameters required to enable each type of engine are listed below.<br>'."\n"
+ .'>'."\n"
+ .'> - To change specifications, enter the node specifications for the corresponding engine.'."\n"
+ .'>'."\n"
+ .'> - To change the number of nodes, enter the number of nodes.'."\n"
+ .'>'."\n"
+ .'> - To change the disk storage capacity, enter the disk storage capacity.'."\n"
+ .'>'."\n"
+ .'> - You can perform only one type of change at a time. After a change is successful, you can perform the next one.'."\n"
+ ."\n"
+ .'- orderType:UPGRADE<br>'."\n"
+ ."\n"
+ .'<details>'."\n"
+ ."\n"
+ .'<summary>'."\n"
+ ."\n"
+ .'Production instance changes'."\n"
+ ."\n"
+ .'</summary>'."\n"
+ ."\n"
+ .'Add a search engine'."\n"
+ ."\n"
+ .'- basic\\_search\\_engine (Add a search engine):true'."\n"
+ ."\n"
+ .'- basic\\_search\\_type (Node type):'."\n"
+ ."\n"
+ .'- basic\\_search\\_node\\_spec (Node specifications):'."\n"
+ ."\n"
+ .'- basic\\_search\\_core\\_num (Number of nodes):'."\n"
+ ."\n"
+ .'- basic\\_search\\_cloud\\_disk (Attach a disk):true'."\n"
+ ."\n"
+ .'- basic\\_search\\_disk\\_type (Attached disk type):'."\n"
+ ."\n"
+ .'- basic\\_search\\_disk\\_size (Attached disk storage capacity):'."\n"
+ ."\n"
+ .'Add a vector engine'."\n"
+ ."\n"
+ .'- basic\\_vector\\_engine (Add a vector engine):true'."\n"
+ ."\n"
+ .'- basic\\_vector\\_type (Node type):'."\n"
+ ."\n"
+ .'- basic\\_vector\\_node\\_spec (Node specifications):'."\n"
+ ."\n"
+ .'- basic\\_vector\\_core\\_num (Number of nodes):'."\n"
+ ."\n"
+ .'- basic\\_vector\\_cloud\\_disk (Attach a disk):true'."\n"
+ ."\n"
+ .'- basic\\_vector\\_disk\\_type (Attached disk type):'."\n"
+ ."\n"
+ .'- basic\\_vector\\_disk\\_size (Attached disk storage capacity):'."\n"
+ ."\n"
+ .'Add a wide table engine'."\n"
+ ."\n"
+ .'- basic\\_wide\\_table\\_engine (Add a wide table engine):'."\n"
+ ."\n"
+ .'- basic\\_wide\\_table\\_type (Node type):'."\n"
+ ."\n"
+ .'- basic\\_wide\\_table\\_node\\_spec (Node specifications):'."\n"
+ ."\n"
+ .'- basic\\_wide\\_table\\_core\\_num (Number of nodes):'."\n"
+ ."\n"
+ .'- basic\\_wide\\_table\\_cloud\\_disk (Attach a disk):'."\n"
+ ."\n"
+ .'- basic\\_wide\\_table\\_disk\\_type (Attached disk type):'."\n"
+ ."\n"
+ .'- basic\\_wide\\_table\\_disk\\_size (Attached disk storage capacity):'."\n"
+ ."\n\n"
+ ."\n"
+ .'</details>'."\n"
+ ."\n"
+ .'<details>'."\n"
+ ."\n"
+ .'<summary>'."\n"
+ ."\n"
+ .'Test instance changes'."\n"
+ ."\n"
+ .'</summary>'."\n"
+ ."\n"
+ .'Add a time series engine'."\n"
+ .'\\- timing\\_engine (Add a time series engine):true'."\n"
+ .'\\- timing\\_node\\_spec (Node specifications):'."\n"
+ .'\\- timing\\_core\\_num (Number of nodes):'."\n"
+ .'\\- timing\\_cloud\\_disk (Attach a disk):'."\n"
+ .'\\- timing\\_disk\\_type (Attached disk type):'."\n"
+ .'\\- timing\\_disk\\_size (Attached disk storage capacity):'."\n"
+ ."\n"
+ .'Add a search engine'."\n"
+ ."\n"
+ .'- search\\_engine (Add a search engine):'."\n"
+ ."\n"
+ .'- search\\_node\\_spec (Node specifications):'."\n"
+ ."\n"
+ .'- search\\_core\\_num (Number of nodes):'."\n"
+ ."\n"
+ .'- search\\_cloud\\_disk (Attach a disk):'."\n"
+ ."\n"
+ .'- search\\_disk\\_type (Attached disk type):'."\n"
+ ."\n"
+ .'- search\\_disk\\_size (Attached disk storage capacity):'."\n"
+ ."\n"
+ .'Add an LTL engine'."\n"
+ ."\n"
+ .'- lts\\_engine (Add an LTL engine):true'."\n"
+ ."\n"
+ .'- lts\\_node\\_spec (Node specifications):'."\n"
+ ."\n"
+ .'- lts\\_core\\_num (Number of nodes):'."\n"
+ ."\n"
+ .'- lts\\_cloud\\_disk (Attach a disk):true'."\n"
+ ."\n"
+ .'- lts\\_disk\\_type (Attached disk type):'."\n"
+ ."\n"
+ .'- lts\\_disk\\_size (Attached disk storage capacity):'."\n"
+ ."\n"
+ .'Add a vector engine'."\n"
+ ."\n"
+ .'- vector\\_engine (Add a vector engine):'."\n"
+ ."\n"
+ .'- vector\\_node\\_spec (Node specifications):'."\n"
+ ."\n"
+ .'- vector\\_core\\_num (Number of nodes):'."\n"
+ ."\n"
+ .'- vector\\_cloud\\_disk (Attach a disk):'."\n"
+ ."\n"
+ .'- vector\\_disk\\_type (Attached disk type):'."\n"
+ ."\n"
+ .'- vector\\_disk\\_size (Attached disk storage capacity):'."\n"
+ ."\n"
+ .'</details>'."\n"
+ ."\n"
+ .'slb<br>'."\n"
+ ."\n"
+ .'> The billing method of the instance (\\`InstanceChargeType\\`): \\`PayBySpec\\` (pay-by-specification) or \\`PayByCLCU\\` (pay-by-usage).<br>'."\n"
+ .'> The billing method for Internet traffic (\\`internet\\_charge\\_type\\`): \\`0\\` (pay-by-bandwidth) or \\`1\\` (pay-by-traffic).<br>'."\n"
+ .'> If \\`InstanceChargeType\\` is \\`PayBySpec\\`, \\`specification\\` is required.<br>'."\n"
+ .'> If \\`internet\\_charge\\_type\\` is \\`0\\`, \\`bandwidth\\` is required.<br><br><br><br>'."\n"
+ ."\n"
+ .'- orderType:UPGRADE<br>'."\n"
+ ."\n"
+ .'- specification (Instance type):'."\n"
+ ."\n"
+ .'- InstanceChargeType (Instance billing method):<br>'."\n"
+ ."\n"
+ .'- internet\\_charge\\_type (Internet traffic fee):'."\n"
+ ."\n"
+ .'- bandwidth (Bandwidth):'."\n"
+ ."\n"
+ .'hbase<br>'."\n"
+ ."\n"
+ .'- orderType:UPGRADE<br>'."\n"
+ ."\n"
+ .'- core\\_instance\\_type (Core specifications):'."\n"
+ ."\n"
+ .'dds<br>'."\n"
+ ."\n"
+ .'- orderType:UPGRADE<br>'."\n"
+ ."\n"
+ .'- db\\_instance\\_class (Specifications):'."\n"
+ ."\n"
+ .'onspre<br>'."\n"
+ ."\n"
+ .'<details>'."\n"
+ ."\n"
+ .'<summary>'."\n"
+ ."\n"
+ .'Upgrade or downgrade an Enterprise Platinum Edition instance'."\n"
+ ."\n"
+ .'</summary>'."\n"
+ ."\n"
+ .'- orderType:UPGRADE<br>'."\n"
+ ."\n"
+ .'- tps\\_max (Peak TPS):'."\n"
+ ."\n"
+ .'- topic\\_capacity (Maximum number of topics):'."\n"
+ ."\n"
+ .'- message\\_capacity (Message storage space):'."\n"
+ ."\n"
+ .'</details>'."\n"
+ ."\n"
+ .'<details>'."\n"
+ ."\n"
+ .'<summary>'."\n"
+ ."\n"
+ .'Upgrade a Standard Edition instance to an Enterprise Platinum Edition instance'."\n"
+ ."\n"
+ .'</summary>'."\n"
+ ."\n"
+ .'- orderType:BUY<br>'."\n"
+ ."\n"
+ .'- tps\\_max (Peak TPS):'."\n"
+ ."\n"
+ .'- topic\\_capacity (Maximum number of topics):'."\n"
+ ."\n"
+ .'- message\\_capacity (Message storage space):'."\n"
+ ."\n"
+ .'- period\\_unit (Subscription unit):Month, Year'."\n"
+ ."\n"
+ .'- period (Subscription duration):'."\n"
+ ."\n"
+ .'</details>'."\n"
+ ."\n"
+ .'hitsdb\\_lindorm<br>'."\n"
+ ."\n"
+ .'- orderType:UPGRADE<br>'."\n"
+ ."\n"
+ .'- lindorm\\_core\\_spec (Wide table node specifications):'."\n"
+ ."\n"
+ .'drds<br>'."\n"
+ ."\n"
+ .'- orderType:UPGRADE<br>'."\n"
+ ."\n"
+ .'- drds\\_instance\\_spec (Instance type):'."\n"
+ ."\n"
+ .'clickhouse<br>'."\n"
+ .'Enterprise Edition instance changes:<br>'."\n"
+ ."\n"
+ .'- max\\_ccu (Maximum CCUs):'."\n"
+ ."\n"
+ .'- mini\\_ccu (Minimum CCUs):'."\n"
+ ."\n"
+ .'Community Edition instance:<br>'."\n"
+ .'Horizontal scaling:<br>'."\n"
+ ."\n"
+ .'- node\\_count (Number of nodes):'."\n"
+ ."\n"
+ .'Vertical scaling:'."\n"
+ ."\n"
+ .'- zkSize (Zookeeper specifications):'."\n"
+ ."\n"
+ .'- instance\\_class (Specifications):'."\n"
+ ."\n"
+ .'- storage\\_type (Storage class):'."\n"
+ ."\n"
+ .'- storage\\_size (Storage space):'."\n"
+ ."\n"
+ .'drds\\_polarx<br>'."\n"
+ .'Standard Edition:<br>'."\n"
+ ."\n"
+ .'- node\\_spec (Node specifications):'."\n"
+ ."\n"
+ .'Enterprise Edition:'."\n"
+ ."\n"
+ .'- cn\\_node\\_spec (Compute node specifications):'."\n"
+ ."\n"
+ .'- dn\\_node\\_spec (Data node specifications):'."\n"
+ ."\n"
+ .'- dn\\_storage\\_space (Data node disk):'."\n"
+ ."\n"
+ .'opensearch'."\n"
+ ."\n"
+ .'- buytype (Cluster preference):'."\n"
+ ."\n"
+ .'- storage (Storage capacity):'."\n"
+ ."\n"
+ .'- compute (Computing resource):', 'type' => 'any', 'example' => 'orderType:UPGRADE', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '接口返回数据',
- 'description' => 'The response parameters.'."\n",
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'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',
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the application.', 'type' => 'string', 'example' => '9656C816-1E9A-58D2-86D5-710678D61AF1'],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'Data' => ['description' => 'The task ID. You can use this ID to call the GetResult4QueryInstancePrice4Modify operation to query the price inquiry result. The task ID is valid for one hour.', 'type' => 'string', 'example' => 'price4modify/19862074****/rm-uf69xr871l***fj39/WQ9ULO4SLD**PQY5/FL1IZLW**3H78OC', 'title' => ''],
+ 'AccessDeniedDetail' => ['description' => 'The detailed reason why the access was denied.', 'type' => 'string', 'example' => '{'."\n"
+ .' "PolicyType": "",'."\n"
+ .' "AuthPrincipalOwnerId": "",'."\n"
+ .' "EncodedDiagnosticMessage": "",'."\n"
+ .' "AuthPrincipalType": "",'."\n"
+ .' "AuthPrincipalDisplayName": "",'."\n"
+ .' "NoPermissionType": "",'."\n"
+ .' "AuthAction": ""'."\n"
+ .' }', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'QueryInstancePrice4Modify',
+ 'summary' => 'Queries the price for an upgrade or downgrade.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryInstancePrice4Modify'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:QueryInstancePrice4Modify',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
+ ],
+ ],
+ ],
],
- '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",
+ '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"}]',
],
- 'GetFoTaskStatus' => [
- 'summary' => 'Queries the status of a disaster recovery switchover task by task ID.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'QueryInstanceSpec4Modify' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
- 'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '208114',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioSRFDAT',
- ],
+ 'abilityTreeNodes' => ['FEATUREbpstudioDXU2R7'],
],
'parameters' => [
[
- 'name' => 'TaskId',
+ 'name' => 'ApplicationId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The ID of the Cloud Architect Design Tools application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'BE68D71ZY5YYIU9R', 'title' => ''],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The ID of the resource to be upgraded or downgraded.', 'type' => 'string', 'required' => true, 'example' => 'rm-uf66k9143r2ch*****', 'title' => ''],
+ ],
+ [
+ 'name' => 'MethodName',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The API operation name of the corresponding product.'."\n"
+ ."\n"
+ .'- To query the specifications of an ECS instance, enter \\`describeResourcesModification\\`.'."\n"
+ ."\n"
+ .'- To query the specifications of an ApsaraDB RDS instance, enter \\`listAvailableClasses\\`.'."\n"
+ ."\n"
+ .'- To query the specifications of an ApsaraDB for Redis instance, enter \\`getKvstoreInstanceClass\\`.'."\n"
+ ."\n"
+ .'- To query the number of shards of an ApsaraDB for Redis instance, enter \\`getKvstoreShardNum\\`.'."\n"
+ ."\n"
+ .'- To query the specifications of a subscription ApsaraDB for Redis instance, enter \\`getShardClass\\`.'."\n"
+ ."\n"
+ .'- To query the disk capacity of a subscription ApsaraDB for Redis instance, enter \\`getStorage\\`.'."\n"
+ ."\n"
+ .'- To query the number of shards of a subscription ApsaraDB for Redis instance, enter \\`getShardQuantity\\`.'."\n"
+ ."\n"
+ .'- To query the specifications of a Tair instance, enter \\`getShardClass\\`.'."\n"
+ ."\n"
+ .'- To query the number of shards of a Tair instance, enter \\`getShardQuantity\\`.'."\n"
+ ."\n"
+ .'- To query the Internet traffic of a Kafka instance, enter \\`getEipMax\\`.'."\n"
+ ."\n"
+ .'- To query the traffic specifications of a Kafka instance, enter \\`getIoMax\\`.'."\n"
+ ."\n"
+ .'- To query the number of partitions of a Kafka instance, enter \\`getPartitionNum\\`.'."\n"
+ ."\n"
+ .'- To query the disk capacity of a Kafka instance, enter \\`getDiskSize\\`.'."\n"
+ ."\n"
+ .'- To query the node specifications of a PolarDB cluster, enter \\`getMasterSpec\\`.'."\n"
+ ."\n"
+ .'- To query the data node specifications of an Elasticsearch cluster, enter \\`getNodeSpec\\`.'."\n"
+ ."\n"
+ .'- To query the Kibana node specifications of an Elasticsearch cluster, enter \\`getKibanaNodeSpecList\\`.'."\n"
+ ."\n"
+ .'- To query the dedicated master node specifications of an Elasticsearch cluster, enter \\`getMasterSpecList\\`.'."\n"
+ ."\n"
+ .'- To query the warm data node specifications of an Elasticsearch cluster, enter \\`getWarmNodeSpecList\\`.'."\n"
+ ."\n"
+ .'- To query the client node specifications of an Elasticsearch cluster, enter \\`getClientNodeSpecList\\`.'."\n"
+ ."\n"
+ .'- To query the elastic data node specifications of an Elasticsearch cluster, enter \\`getElasticNodeSpecList\\`.'."\n"
+ ."\n"
+ .'- To query the specifications of a trial LindormTSDB, search engine, LTL engine, or vector engine for a Lindorm instance, enter \\`getLightNodeSpec\\`.'."\n"
+ ."\n"
+ .'- To query the specifications of a production search engine for a Lindorm instance, enter \\`getBasicSearchNodeSpec\\`.'."\n"
+ ."\n"
+ .'- To query the specifications of a production vector engine for a Lindorm instance, enter \\`getBasicVectorNodeSpec\\`.'."\n"
+ ."\n"
+ .'- To query the specifications of a production LindormTable for a Lindorm instance, enter \\`getBasicWideTableNodeSpec\\`.'."\n"
+ ."\n"
+ .'- To query the instance type of an SLB instance, enter \\`getSlbLoadBalancerSpec\\`.'."\n"
+ ."\n"
+ .'- To query the specifications of an Hbase instance, enter \\`getHbaseCoreSpec\\`.'."\n"
+ ."\n"
+ .'- To query the specifications of an ApsaraDB for MongoDB instance, enter \\`getDdsClass\\`.'."\n"
+ ."\n"
+ .'- To query the peak TPS of a Message Queue for Apache RocketMQ instance, enter \\`getOnsPreTpsMax\\`.'."\n"
+ ."\n"
+ .'- To query the maximum number of topics for a Message Queue for Apache RocketMQ instance, enter \\`getOnsPreTopicCapacity\\`.'."\n"
+ ."\n"
+ .'- To query the log broker capacity of a Message Queue for Apache RocketMQ instance, enter \\`getOnsPreMessageCapacity\\`.'."\n"
+ ."\n"
+ .'- To query the wide table specifications of a Lindorm instance, enter \\`getHitsdbLindormCoreSpec\\`.'."\n"
+ ."\n"
+ .'- To query the instance type of a DRDS instance, enter \\`getDrdsInstanceSpec\\`.'."\n"
+ ."\n"
+ .'- To query the maximum number of ClickHouse Compute Units (CCUs), enter \\`getClickHouseMaxCcu\\`.'."\n"
+ ."\n"
+ .'- To query the minimum number of CCUs, enter \\`getClickHouseMinCcu\\`.'."\n"
+ ."\n"
+ .'- To query the Zookeeper specifications, enter \\`getClickHouseZkSize\\`.'."\n"
+ ."\n"
+ .'- To query the specifications, enter \\`getClickHouseInstanceClass\\`.'."\n"
+ ."\n"
+ .'- To query the storage class, enter \\`getClickHouseStorageType\\`.'."\n"
+ ."\n"
+ .'- To query the storage space, enter \\`getClickHouseStorageSize\\`.'."\n"
+ ."\n"
+ .'- To query the node specifications of a PolarDB-X 1.0 instance, enter \\`getDrdsPolarxNodeSpec\\`.'."\n"
+ ."\n"
+ .'- To query the compute node specifications of a PolarDB-X 1.0 instance, enter \\`getDrdsPolarxCnNodeSpec\\`.'."\n"
+ ."\n"
+ .'- To query the data node specifications of a PolarDB-X 1.0 instance, enter \\`getDrdsPolarxDnNodeSpec\\`.'."\n"
+ ."\n"
+ .'- To query the disk space of data nodes for a PolarDB-X 1.0 instance, enter \\`getDrdsPolarxDnStorageSpace\\`.'."\n"
+ ."\n"
+ .'- To query the cluster preference of an OpenSearch instance, enter \\`getOpenSearchBuyType\\`.'."\n"
+ ."\n"
+ .'- To query the storage capacity of an OpenSearch instance, enter \\`getOpenSearchStorage\\`.'."\n"
+ ."\n"
+ .'- To query the computing resources of an OpenSearch instance, enter \\`getOpenSearchCompute\\`.', 'type' => 'string', 'required' => false, 'example' => 'describeResourcesModification', 'title' => ''],
+ ],
+ [
+ 'name' => 'Parameters',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '容灾切换任务ID',
- 'description' => 'The disaster recovery switchover task ID.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => 'The constraints on the specifications.',
+ 'type' => 'object',
'required' => false,
- 'example' => '2615',
+ 'additionalProperties' => ['description' => 'The parameters.<br>'."\n"
+ ."\n"
+ .'> - For subscription instances, use \\`UPGRADE\\` for upgrades and \\`DOWNGRADE\\` for downgrades. For pay-as-you-go instances, use \\`UPGRADE\\` for both upgrades and downgrades because it indicates a configuration change.'."\n"
+ ."\n"
+ .'To query the specifications for an ECS instance modification:<br>'."\n"
+ ."\n"
+ .'- orderType:UPGRADE<br>'."\n"
+ ."\n"
+ .'To query the specifications for an ApsaraDB RDS instance modification:<br>'."\n"
+ ."\n"
+ .'- orderType:UPGRADE'."\n"
+ ."\n"
+ .'To query the specifications for an ApsaraDB for Redis instance modification:<br>'."\n"
+ ."\n"
+ .'- orderType:UPGRADE<br>'."\n"
+ ."\n"
+ .'To query the specifications for a subscription ApsaraDB for Redis instance modification:<br>'."\n"
+ ."\n"
+ .'- orderType:UPGRADE<br>'."\n"
+ ."\n"
+ .'To query the disk capacity that corresponds to the specifications for a subscription ApsaraDB for Redis instance modification:<br>'."\n"
+ ."\n"
+ .'- orderType:UPGRADE<br>'."\n"
+ ."\n"
+ .'- shard\\_class:xxx<br>'."\n"
+ ."\n"
+ .'To query the specifications for a Tair instance modification:<br>'."\n"
+ ."\n"
+ .'- orderType:UPGRADE<br>'."\n"
+ ."\n"
+ .'To query the properties for a Lindorm instance modification:<br>'."\n"
+ ."\n"
+ .'- orderType:UPGRADE<br>'."\n"
+ ."\n"
+ .'To query the specifications for an SLB instance modification:<br>'."\n"
+ ."\n"
+ .'- orderType:UPGRADE<br>'."\n"
+ ."\n"
+ .'To query the core specifications for an Hbase instance modification:<br>'."\n"
+ ."\n"
+ .'- orderType:UPGRADE<br>'."\n"
+ ."\n"
+ .'To query the specifications for an ApsaraDB for MongoDB instance modification:<br>'."\n"
+ ."\n"
+ .'- orderType:UPGRADE<br>'."\n"
+ ."\n"
+ .'To query the specifications for an upgrade or downgrade of a Message Queue for Apache RocketMQ Platinum Edition instance:<br>'."\n"
+ ."\n"
+ .'- orderType:UPGRADE<br>'."\n"
+ ."\n"
+ .'To query the specifications for upgrading a Standard Edition instance of Message Queue for Apache RocketMQ to a Platinum Edition instance:<br>'."\n"
+ ."\n"
+ .'- orderType:BUY<br>'."\n"
+ ."\n"
+ .'To query the specifications for a Lindorm instance modification:<br>'."\n"
+ ."\n"
+ .'- orderType:UPGRADE<br>'."\n"
+ ."\n"
+ .'To query the specifications for a DRDS instance modification:<br>'."\n"
+ ."\n"
+ .'- orderType:UPGRADE<br>', 'type' => 'any', 'example' => 'orderType:UPGRADE', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '返回数据',
- 'description' => 'The response parameters.'."\n",
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'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',
- ],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Data' => [
- 'title' => '容灾切换任务Task的状态',
- 'description' => 'The status of the switchover task.'."\n",
- 'type' => 'string',
- 'example' => 'Running',
+ 'description' => 'The query results.',
+ 'type' => 'object',
+ 'example' => '',
+ 'properties' => [
+ 'OptionalValues' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Label' => ['description' => 'The name of the specification.', 'type' => 'string', 'example' => '1 GB', 'title' => ''],
+ 'Value' => ['description' => 'The value of the specification.', 'type' => 'string', 'example' => 'redis.shard.small.2.ce', 'title' => ''],
+ 'Min' => ['description' => 'The minimum value. This parameter is valid when you query the number of shards for an ApsaraDB for Redis instance.', 'type' => 'number', 'format' => 'double', 'example' => '1', 'title' => ''],
+ 'Max' => ['description' => 'The maximum value. This parameter is valid when you query the number of shards for an ApsaraDB for Redis instance.', 'type' => 'number', 'format' => 'double', 'example' => '1', 'title' => ''],
+ 'Step' => ['description' => 'The step size. This parameter is valid when you query the number of shards for an ApsaraDB for Redis instance.', 'type' => 'number', 'format' => 'double', 'example' => '1', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'The list of available specifications for modification.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '847C9D0A-BABD-589C-8A9C-6464409EDED9', 'title' => ''],
+ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '{'."\n"
+ .' "PolicyType": "",'."\n"
+ .' "AuthPrincipalOwnerId": "",'."\n"
+ .' "EncodedDiagnosticMessage": "",'."\n"
+ .' "AuthPrincipalType": "",'."\n"
+ .' "AuthPrincipalDisplayName": "",'."\n"
+ .' "NoPermissionType": "",'."\n"
+ .' "AuthAction": ""'."\n"
+ .' }', 'title' => ''],
],
+ 'example' => '',
],
],
],
- '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',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'QueryInstanceSpec4Modify',
+ 'summary' => 'Queries a list of specifications for an upgrade or downgrade.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryInstanceSpec4Modify'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:QueryInstanceSpec4Modify',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
+ ],
+ ],
+ ],
],
+ '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"}]',
+ ],
+ 'ReConfigApplication' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '208124',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioJD8QWK',
- ],
+ 'abilityTreeCode' => '238269',
+ 'abilityTreeNodes' => ['FEATUREbpstudioCGSK4A'],
+ 'autoTest' => true,
],
'parameters' => [
[
- 'name' => 'ApplicationId',
+ 'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用ID',
- 'description' => 'The application ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '61ZW1DY5Y3FSAOO2',
- ],
+ 'schema' => ['description' => 'The ID of the application. Call the ListApplication operation to obtain the application ID.', 'type' => 'string', 'required' => false, 'example' => 'Q2P4O9YSOKCT35L9', 'title' => ''],
+ ],
+ [
+ 'name' => 'Variables',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The properties to update.', 'type' => 'string', 'required' => false, 'example' => '{"${instance_type}":"ecs.c6.3xlarge"}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '返回数据',
- 'description' => 'The response parameters.'."\n",
- 'type' => 'object',
+ 'description' => 'Schema of Response',
'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',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '9656C816-1E9A-58D2-86D5-710678D61AF1'],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
+ 'title' => 'Schema of Response',
+ 'type' => 'object',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ReConfigApplication',
+ 'summary' => 'You can retrieve a list of template variables that need to be reconfigured. After you reassign values to these variables, call this function. The application status changes to `Modifying`, and the properties of failed nodes are updated with the new variable values. For example, you can change the instance type of a failed resource. After the function is executed, you can redeploy the application.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReConfigApplication'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ReConfigApplication',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
+ ],
+ ],
+ ],
],
- '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",
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9656C816-1E9A-58D2-86D5-710678D61AF1\\",\\n \\"Message\\": \\"Success\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
],
- 'ListFoCreatedApps' => [
- 'summary' => 'Queries the information about all disaster recovery plans of the current account.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ReleaseApplication' => [
+ 'summary' => 'Releases the resources of an application.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
+ 'operationType' => 'readAndWrite',
'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
+ 'operationType' => 'update',
+ 'riskType' => 'high',
'chargeType' => 'free',
- 'abilityTreeCode' => '207619',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioJLQBYK',
+ 'abilityTreeCode' => '91662',
+ 'abilityTreeNodes' => ['FEATUREbpstudioCGSK4A'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ApplicationId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '7QSXFQW46ZNGOUDM'],
+ ],
+ [
+ 'name' => 'ResourceGroupId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The idempotence token.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1600765710019'],
],
],
- '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',
- ],
- ],
- ],
- ],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BFB7F5C8-FE7A-06CA-9F87-ABBF6B848F0C', 'title' => ''],
+ 'Data' => ['description' => 'The return value.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'Code' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 200 => [
+ ['errorCode' => 'Success', 'errorMessage' => 'The transaction is successful.', 'description' => ''],
+ ],
+ 400 => [
+ ['errorCode' => 'ParameterEmpty', 'errorMessage' => 'You must specify the request parameter.', 'description' => 'You must specify request parameters.'],
+ ],
+ 404 => [
+ ['errorCode' => 'EntityNotExist.ResourceGroup', 'errorMessage' => 'The resource group does not exist.', 'description' => ''],
+ ['errorCode' => 'EntityNotExist.ResourceId', 'errorMessage' => 'The resource does not exist.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'ServiceError', 'errorMessage' => 'A server error occurred. Please try again later.', 'description' => ''],
+ ],
],
- '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',
+ 'title' => 'ReleaseApplication',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseApplication'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ReleaseApplication',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"BFB7F5C8-FE7A-06CA-9F87-ABBF6B848F0C\\",\\n \\"Data\\": 1,\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
+ ],
+ 'ValidateApplication' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5287,186 +4703,239 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '208065',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioCGSK4A',
- ],
+ 'abilityTreeCode' => '91658',
+ 'abilityTreeNodes' => ['FEATUREbpstudioCGSK4A'],
],
'parameters' => [
[
'name' => 'ApplicationId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '02S7UU41WKJL7ERR'],
+ ],
+ [
+ 'name' => 'ResourceGroupId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用ID',
- 'description' => 'The application ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '002XWH7MXB8MJRU0',
- ],
+ 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'rg-acfmyjt3c5om3hi'],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The idempotence token.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1600765710019'],
],
],
'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',
- ],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', 'title' => ''],
+ 'Data' => ['description' => 'The application data.', 'type' => 'string', 'example' => '123', 'title' => ''],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- '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',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'ParameterEmpty', 'errorMessage' => 'The request parameter cannot be empty.', 'description' => ''],
+ ],
+ 404 => [
+ ['errorCode' => 'EntityNotExist.ResourceGroup', 'errorMessage' => 'The resource group does not exist.', 'description' => ''],
+ ['errorCode' => 'EntityNotExist.ResourceId', 'errorMessage' => 'The resource does not exist.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'ServiceError', 'errorMessage' => 'A server error occurred. Please try again later.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'ValidateApplication',
+ 'summary' => 'Validates the input for resources in an application. This is an asynchronous operation. You can call GetApplication to retrieve the validation result.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ValidateApplication'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ValidateApplication',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Data\\": \\"123\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
+ ],
+ 'ValuateApplication' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
- 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '173661',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioCGSK4A',
- ],
+ 'abilityTreeCode' => '91659',
+ 'abilityTreeNodes' => ['FEATUREbpstudioCGSK4A'],
],
'parameters' => [
[
- 'name' => 'ClientToken',
+ 'name' => 'ApplicationId',
'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',
- ],
+ 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '02S7UU41WKJL7ERR'],
],
[
- 'name' => 'RegionId',
+ 'name' => 'ResourceGroupId',
'in' => 'formData',
- 'schema' => [
- 'title' => '区域ID',
- 'description' => 'The ID of the region.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'rg-acfmyjt3c5om3hi'],
],
[
- 'name' => 'NextToken',
+ 'name' => 'ClientToken',
'in' => 'formData',
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1600765710019'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'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',
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', 'title' => ''],
+ 'Data' => ['description' => 'The application data.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 200 => [
+ ['errorCode' => 'Success', 'errorMessage' => 'The transaction is successful.', 'description' => ''],
+ ],
+ 400 => [
+ ['errorCode' => 'ParameterEmpty', 'errorMessage' => 'You must specify the request parameter.', 'description' => 'You must specify request parameters.'],
+ ],
+ 404 => [
+ ['errorCode' => 'EntityNotExist.ResourceGroup', 'errorMessage' => 'The resource group does not exist.', 'description' => ''],
+ ['errorCode' => 'EntityNotExist.ResourceId', 'errorMessage' => 'The resource does not exist.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'ServiceError', 'errorMessage' => 'A server error occurred. Please try again later.', 'description' => ''],
+ ],
+ ],
+ 'title' => 'ValuateApplication',
+ 'summary' => 'Obtains a price quote for the resources in an application. Call GetApplication to retrieve the price quote.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ValuateApplication'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ValuateApplication',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Data\\": 123,\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
+ ],
+ 'ValuateTemplate' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'ResourceType',
+ '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' => '资源类型',
- 'description' => 'The resource type.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Application',
- ],
+ 'schema' => ['description' => 'The ID of the template.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '0KSHPM6SJU03TNZP'],
],
[
- 'name' => 'ResourceId',
+ 'name' => 'ClientToken',
'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,
- ],
+ 'schema' => ['description' => 'A token that ensures the idempotency of the request.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '1600765710019'],
],
[
- 'name' => 'Tag',
+ 'name' => 'AreaId',
'in' => 'formData',
- 'style' => 'flat',
+ 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'Instances',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '标签列表，最多包含20个子项',
- 'description' => 'The tags. A maximum of 20 tags are supported.'."\n",
+ 'title' => '',
+ 'description' => 'The list of instances to replace.',
'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",
- ],
+ 'NodeType' => ['description' => 'The type of the instance.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'ecs'],
+ 'NodeName' => ['description' => 'The name of the instance in the diagram.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'ecs'],
+ 'Id' => ['description' => 'The ID of the instance.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'vpc-bp1q56trhtaq40vlq5oj'],
],
'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
+ 'example' => '',
+ ],
+ ],
+ [
+ 'name' => 'ResourceGroupId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The ID of the resource group to which the application belongs.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'rg-acfmyjt3c5om3fi'],
+ ],
+ [
+ 'name' => 'Variables',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The variables for the template. If the template contains parameters, you can specify the parameter values. If you do not specify this parameter, default values are used.',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['description' => 'Specifies the supported type.', 'type' => 'any', 'example' => '${var1}', 'title' => ''],
+ 'enumValueTitles' => [],
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -5475,445 +4944,679 @@
'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',
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '847C9D0A-BABD-589C-8A9C-6464409EDED9', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The price inquiry results.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ResourceList' => [
+ 'description' => 'The result set of the price inquiry.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The result set.',
+ 'type' => 'object',
+ 'properties' => [
+ 'NodeType' => ['description' => 'The type of the resource.', 'type' => 'string', 'example' => 'ecs', 'title' => ''],
+ 'Error' => ['description' => 'The error message for the price inquiry.', 'type' => 'string', 'example' => 'InvalidSaleComponentFault : The request not refer to the correct order sale component.', 'title' => ''],
+ 'TradePrice' => ['description' => 'The transaction price.', 'type' => 'number', 'format' => 'double', 'example' => '10.0', 'title' => ''],
+ 'DiscountAmount' => ['description' => 'The discount amount.', 'type' => 'number', 'format' => 'double', 'example' => '73.0', 'title' => ''],
+ 'OriginalPrice' => ['description' => 'The original price.', 'type' => 'number', 'format' => 'double', 'example' => '83.0', 'title' => ''],
+ 'PromotionName' => ['description' => 'The promotional information.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'PriceUnit' => ['description' => 'The pricing unit.', 'type' => 'string', 'example' => 'CNY / USD', 'title' => ''],
+ 'PriceList' => [
+ 'description' => 'The list of sub-prices.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The list of sub-prices.',
+ 'type' => 'object',
+ 'properties' => [
+ 'NodeType' => ['description' => 'The type of the resource.', 'type' => 'string', 'example' => 'eip', 'title' => ''],
+ 'ResourceId' => ['description' => 'The topology ID of the resource.', 'type' => 'string', 'example' => '1687225092', 'title' => ''],
+ 'Error' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'ServiceUnavailable : The request has failed due to a temporary failure of the server.\\r\\nRequestId : 4AA302DB-3286-5589-8637-FF6D8507B7A9.', 'title' => ''],
+ 'TradePrice' => ['description' => 'The transaction price.', 'type' => 'number', 'format' => 'float', 'example' => '0.01', 'title' => ''],
+ 'DiscountAmount' => ['description' => 'The discount amount for the order.', 'type' => 'number', 'format' => 'float', 'example' => '82.99', 'title' => ''],
+ 'OriginalPrice' => ['description' => 'The original price.', 'type' => 'number', 'format' => 'float', 'example' => '83.0', 'title' => ''],
+ 'PromotionName' => ['description' => 'The promotional information.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'PriceUnit' => ['description' => 'The pricing unit.', 'type' => 'string', 'example' => 'CNY / USD'."\n", 'title' => ''],
+ 'Type' => ['description' => 'Indicates whether the resource is a new purchase.<br>1: New purchase<br>2: Existing<br>0: Not included in the price<br><br><br><br><br><br><br><br>', 'type' => 'string', 'example' => '"1"', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
+ 200 => [
+ ['errorCode' => 'Success', 'errorMessage' => 'The transaction is successful.', 'description' => ''],
+ ],
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' => 'ParameterEmpty', 'errorMessage' => 'You must specify the request parameter.', 'description' => 'You must specify request parameters.'],
+ ['errorCode' => 'bp.java.8004', 'errorMessage' => 'No permissions.', 'description' => ''],
+ ['errorCode' => 'bp.java.appNameNotNull', 'errorMessage' => 'Application name cannot be repeated.', 'description' => ''],
+ ['errorCode' => 'bp.java.nopower', 'errorMessage' => 'No permissions.', 'description' => ''],
+ ['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.', 'description' => ''],
+ ['errorCode' => 'bp.java.tempNameNotNull', 'errorMessage' => 'Application name cannot be repeated.', 'description' => ''],
+ ['errorCode' => 'bp.java.userNotExist', 'errorMessage' => 'The user does not exist. The current user does not authenticate AliCloud with his real name.', 'description' => ''],
+ ],
+ 404 => [
+ ['errorCode' => 'EntityNotExist.ResourceGroup', 'errorMessage' => 'The resource group does not exist.', 'description' => ''],
+ ['errorCode' => 'EntityNotExist.ResourceId', 'errorMessage' => 'The resource does not exist.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'bp.java.notDelete', 'errorMessage' => 'This template has been shared with other users and cannot be deleted.', 'description' => ''],
+ ['errorCode' => 'bp.java.serviceError', 'errorMessage' => 'The server is abnormal. Please try again later.', 'description' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ValuateTemplate',
+ 'summary' => 'Retrieves the price of a template.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ValuateTemplate'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ValuateTemplate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Template', 'arn' => 'acs:bpstudio::{#accountId}:template/{#TemplateId}'],
+ ],
],
],
],
- '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',
+ '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"}]',
],
- 'ExecuteTask' => [
- 'summary' => '创建任务',
- 'path' => '',
- 'methods' => [
- 'post',
+ ],
+ 'endpoints' => [
+ ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'bpstudio.ap-southeast-1.aliyuncs.com', 'endpoint' => 'bpstudio.ap-southeast-1.aliyuncs.com', 'vpc' => 'bpstudio.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'bpstudio.cn-hangzhou.aliyuncs.com', 'endpoint' => 'bpstudio.cn-hangzhou.aliyuncs.com', 'vpc' => 'bpstudio.vpc-proxy.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => 'bp.java.8004', 'message' => 'No permissions.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'bp.java.appNameNotNull', 'message' => 'Application name cannot be repeated.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'bp.java.nopower', 'message' => 'No permissions.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'bp.java.nopowerContact', 'message' => 'You do not have permission to use this function. Please contact the main account or permission administrator to authorize the relevant permissions.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'bp.java.notDelete', 'message' => 'This template has been shared with other users and cannot be deleted.', 'http_code' => 500, 'description' => ''],
+ ['code' => 'bp.java.serviceError', 'message' => 'The server is abnormal. Please try again later.', 'http_code' => 500, 'description' => ''],
+ ['code' => 'bp.java.tempNameNotNull', 'message' => 'Application name cannot be repeated.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'bp.java.userNotExist', 'message' => 'The user does not exist. The current user does not authenticate AliCloud with his real name.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'EntityNotExist.ResourceGroup', 'message' => 'The resource group does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'EntityNotExist.ResourceId', 'message' => 'The resource does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'NoPermission', 'message' => 'No Permission.', 'http_code' => 403, 'description' => 'No permission'],
+ ['code' => 'NoPermission.StreamingChat', 'message' => 'No permissions.', 'http_code' => 403, 'description' => 'No operation permission.'],
+ ['code' => 'NoPermissions', 'message' => 'No permissions.', 'http_code' => 403, 'description' => 'No permissions.'],
+ ['code' => 'ParameterEmpty', 'message' => 'You must specify the request parameter.', 'http_code' => 400, 'description' => 'You must specify request parameters.'],
+ ['code' => 'ServiceError', 'message' => 'A server error occurred. Please try again later.', 'http_code' => 500, 'description' => ''],
+ ],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResource4ModifyRecord'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFoTaskStatus'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AppFailOver'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeployApplication'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteOperationASync'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTemplate'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFoCreatedApps'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseApplication'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ValuateApplication'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InitAppFailOver'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApplication'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPotentialFailZones'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReConfigApplication'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApplicationSpec'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteOperationSync'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ValuateTemplate'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryInstanceSpec4Modify'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryInstancePrice4Modify'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetApplicationVariables4Fail'],
+ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetToken'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTemplate'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListApplication'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExecuteOperationResult'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AppFailBack'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetApplicationVariables'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ValidateApplication'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApplication'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetApplication'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeResourceGroup'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResult4QueryInstancePrice4Modify'],
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'BPStudio',
+ 'productName' => 'Cloud Architect Design Tools',
+ 'ramCodes' => ['bpstudio'],
+ 'ramLevel' => 'RESOURCE',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'ReConfigApplication',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ReConfigApplication',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
+ ],
+ ],
],
- 'schemes' => [
- 'https',
+ [
+ 'apiName' => 'InitAppFailOver',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bpstudio:InitAppFailOver',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'QueryInstancePrice4Modify',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:QueryInstancePrice4Modify',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
+ ],
],
],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioJLICAE',
+ [
+ 'apiName' => 'ValuateTemplate',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ValuateTemplate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Template', 'arn' => 'acs:bpstudio::{#accountId}:template/{#TemplateId}'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'TaskId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2615',
+ [
+ 'apiName' => 'ListTemplate',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ListTemplate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
],
],
],
- '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',
- ],
- ],
+ [
+ 'apiName' => 'ReleaseApplication',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ReleaseApplication',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No Permission.',
+ [
+ 'apiName' => 'ListOperations',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ListOperations',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
],
- [
- 'errorCode' => 'NoPermissions',
- 'errorMessage' => 'No permissions.',
+ ],
+ ],
+ [
+ 'apiName' => 'ValidateApplication',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ValidateApplication',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ [
+ 'apiName' => 'ExecuteOperationASync',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ExecuteOperationASync',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
+ ],
+ ],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ [
+ 'apiName' => 'GetOperationParams',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:GetOperationParams',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
+ ],
+ ],
],
- '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',
+ [
+ 'apiName' => 'GetLinkageAttributesTemplate',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:GetLinkageAttributesTemplate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Template', 'arn' => 'acs:bpstudio::{#accountId}:template/{#TemplateId}'],
+ ],
+ ],
],
- 'schemes' => [
- 'https',
+ [
+ 'apiName' => 'GetTemplate',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:GetTemplate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Template', 'arn' => 'acs:bpstudio::{#accountId}:template/{#TemplateId}'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'ListTagResources',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ListTagResources',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
+ ],
],
],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioJLICAE',
+ [
+ 'apiName' => 'GetApplicationVariables',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:GetApplicationVariables',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'ProcessId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'P3KTG43SW7**6A17I',
+ [
+ 'apiName' => 'GetPotentialFailZones',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'bpstudio:GetPotentialFailZones',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
],
],
- [
- 'name' => 'TaskName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test',
+ ],
+ [
+ 'apiName' => 'ListServices',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ListServices',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
],
],
- [
- 'name' => 'AppId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'JXT3MLZJ56**65D6',
+ ],
+ [
+ 'apiName' => 'GetToken',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:GetToken',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
],
],
- [
- 'name' => 'Variables',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'any',
- 'description' => '"${var}":"value"',
- 'example' => '"${var}":"value"',
- ],
+ ],
+ [
+ 'apiName' => 'GetApplicationVariables4Fail',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:GetApplicationVariables4Fail',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
],
],
],
- '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',
- ],
- ],
+ [
+ 'apiName' => 'ListApplication',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ListApplication',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermissions',
- 'errorMessage' => 'No permissions.',
+ [
+ 'apiName' => 'AppFailOver',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bpstudio:AppFailOver',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ [
+ 'apiName' => 'GetTask',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:GetTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
+ ],
+ ],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ [
+ 'apiName' => 'ExecuteOperationSync',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ExecuteOperationSync',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
+ ],
+ ],
],
- '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',
+ [
+ 'apiName' => 'AppFailBack',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bpstudio:AppFailBack',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
+ ],
+ ],
],
- 'schemes' => [
- 'https',
+ [
+ 'apiName' => 'CreateTask',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'bpstudio:CreateTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'GetFoTaskStatus',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:GetFoTaskStatus',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
+ ],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'DeployApplication',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bpstudio:DeployApplication',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetResource4ModifyRecord',
+ 'description' => '',
'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREbpstudioJLICAE',
+ 'ramAction' => [
+ 'action' => 'bpstudio:GetResource4ModifyRecord',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'TaskId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2615',
+ [
+ 'apiName' => 'GetApplication',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:GetApplication',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
],
],
],
- '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',
- ],
- ],
+ [
+ 'apiName' => 'GetExecuteOperationResult',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:GetExecuteOperationResult',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermissions',
- 'errorMessage' => 'No permissions.',
+ [
+ 'apiName' => 'ChangeResourceGroup',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ChangeResourceGroup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio:*:{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ [
+ 'apiName' => 'ModifyApplicationSpec',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ModifyApplicationSpec',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
+ ],
+ ],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ [
+ 'apiName' => 'DeleteApplication',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'bpstudio:DeleteApplication',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ValuateApplication',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ValuateApplication',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ExecuteTask',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ExecuteTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateApplication',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'bpstudio:CreateApplication',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Template', 'arn' => 'acs:bpstudio::{#accountId}:template/{#TemplateId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryInstanceSpec4Modify',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:QueryInstanceSpec4Modify',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetResult4QueryInstancePrice4Modify',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bpstudio:GetResult4QueryInstancePrice4Modify',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListFoCreatedApps',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'bpstudio:ListFoCreatedApps',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BPStudio', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
+ ],
+ ],
],
- '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',
+ 'resourceTypes' => [
+ ['validationType' => 'always', 'resourceType' => 'Application', 'arn' => 'acs:bpstudio::{#accountId}:application/{#ApplicationId}'],
+ ['validationType' => 'always', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
+ ['validationType' => 'always', 'resourceType' => 'Template', 'arn' => 'acs:bpstudio::{#accountId}:template/{#TemplateId}'],
+ ['validationType' => 'always', 'resourceType' => 'BPStudioVirtual', 'arn' => 'acs:bpstudio:*:{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}'],
],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 17:45:33 +0000