summaryrefslogtreecommitdiff
path: root/data/zh_cn/bpstudio/2020-07-10/api-docs.php
diff options
context:
space:
mode:
Diffstat (limited to 'data/zh_cn/bpstudio/2020-07-10/api-docs.php')
-rw-r--r--data/zh_cn/bpstudio/2020-07-10/api-docs.php345
1 files changed, 61 insertions, 284 deletions
diff --git a/data/zh_cn/bpstudio/2020-07-10/api-docs.php b/data/zh_cn/bpstudio/2020-07-10/api-docs.php
index 96f9d53..be4d7e8 100644
--- a/data/zh_cn/bpstudio/2020-07-10/api-docs.php
+++ b/data/zh_cn/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' => '应用ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '30GRJUY95TMYWBYJ',
- ],
+ 'schema' => ['description' => '应用ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '30GRJUY95TMYWBYJ'],
],
[
'name' => 'ResourceGroupId',
'in' => 'formData',
- 'schema' => [
- 'description' => '资源组ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-aekz44tg3bnpyba',
- ],
+ 'schema' => ['description' => '资源组ID', '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' => '资源ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vsw-xxxxxxxxxxxx',
- ],
+ 'schema' => ['description' => '资源ID', 'type' => 'string', 'required' => false, 'example' => 'vsw-xxxxxxxxxxxx'],
],
[
'name' => 'ResourceType',
'in' => 'formData',
- 'schema' => [
- 'description' => '产品CODE',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ecs',
- ],
+ 'schema' => ['description' => '产品CODE', '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' => '请求ID',
- 'type' => 'string',
- 'example' => 'E15B71B4-5D8F-5484-BC07-989E2987EE7C',
- ],
+ 'Message' => ['description' => '返回信息', 'type' => 'string', 'example' => 'Success'],
+ 'RequestId' => ['description' => '请求ID', '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' => '订单id集合',
'type' => 'array',
- 'items' => [
- 'description' => '订单id集合',
- 'type' => 'string',
- 'example' => '[11396641]',
- ],
- ],
- 'AppId' => [
- 'description' => '应用ID',
- 'type' => 'string',
- 'example' => 'EQ4W772D0VJ33IV1',
- ],
- 'CreateTime' => [
- 'description' => '创建时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1645516991000',
+ 'items' => ['description' => '订单id集合', 'type' => 'string', 'example' => '[11396641]'],
],
+ 'AppId' => ['description' => '应用ID', 'type' => 'string', 'example' => 'EQ4W772D0VJ33IV1'],
+ 'CreateTime' => ['description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1645516991000'],
'ResourceList' => [
'description' => '资源列表',
'type' => 'array',
@@ -182,74 +100,24 @@
'description' => '资源列表',
'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '阶段状态'."\n"
- .'FINISH 运行完成'."\n"
- .'RUNNING 运行中'."\n"
- .'CANCELED 已取消'."\n"
- .'WAITING 等待中'."\n"
- .'INIT 未开始'."\n"
- .'SUCCESS 成功',
- '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' => '1=新购，0=已保有',
- ],
- 'ResourceId' => [
- 'description' => '资源 ID',
- 'type' => 'string',
- 'example' => 'i-2zehnzxqixu1pywsfbx1',
- ],
- 'ResourceCode' => [
- 'description' => '资源Code',
- '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' => '阶段状态'."\n"
+ .'FINISH 运行完成'."\n"
+ .'RUNNING 运行中'."\n"
+ .'CANCELED 已取消'."\n"
+ .'WAITING 等待中'."\n"
+ .'INIT 未开始'."\n"
+ .'SUCCESS 成功', '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' => '1=新购，0=已保有'],
+ 'ResourceId' => ['description' => '资源 ID', 'type' => 'string', 'example' => 'i-2zehnzxqixu1pywsfbx1'],
+ 'ResourceCode' => ['description' => '资源Code', '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' => '本次操作类型，是修改产品的操作类型，有的操作类型是通用，有的是单独使用。'."\n"
.'下面为ecs的相关编配示例：'."\n"
@@ -263,17 +131,9 @@
.'- ecs的付费类型：modifyPayType',
'type' => 'object',
'properties' => [
- 'Name' => [
- 'description' => '操作名称',
- 'type' => 'string',
- 'example' => 'ecsDelete',
- ],
- 'Operations' => [
- 'description' => '操作描述信息'."\n"
- ."\n",
- 'type' => 'object',
- 'example' => '{"mode":"sync","display":"修改实例名","show":{},"attributes":{"instance_name":{"controlType":"Input","display":"VSWITCH名","format":"^[\\\\u4e00-\\\\u9fa5A-Za-z]{1}[\\\\u4e00-\\\\u9fa5\\\\w\\\\-\\\\_]{1,127}$","orderBy":0,"tip":"长度为2~128个字符，以英文大小字母或中文开头，可包含数字、下划线（_）和连字符（-）。","required":true}},"type":"window","properties":{"instanceId":"ResourceId","regionId":"region","appId":"appId"}}',
- ],
+ 'Name' => ['description' => '操作名称', 'type' => 'string', 'example' => 'ecsDelete'],
+ 'Operations' => ['description' => '操作描述信息'."\n"
+ ."\n", 'type' => 'object', 'example' => '{"mode":"sync","display":"修改实例名","show":{},"attributes":{"instance_name":{"controlType":"Input","display":"VSWITCH名","format":"^[\\\\u4e00-\\\\u9fa5A-Za-z]{1}[\\\\u4e00-\\\\u9fa5\\\\w\\\\-\\\\_]{1,127}$","orderBy":0,"tip":"长度为2~128个字符，以英文大小字母或中文开头，可包含数字、下划线（_）和连字符（-）。","required":true}},"type":"window","properties":{"instanceId":"ResourceId","regionId":"region","appId":"appId"}}'],
],
],
'ResourceTimeList' => [
@@ -281,123 +141,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' => '1, 否; 2, 是',
- ],
- 'TerraformScriptUrl' => [
- 'description' => 'TF脚本下载地址',
- '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' => '3010，单位ms',
- ],
- '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' => '资源组ID',
- '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' => '1, 否; 2, 是'],
+ 'TerraformScriptUrl' => ['description' => 'TF脚本下载地址', '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' => '3010，单位ms'],
+ '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' => '资源组ID', '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'],
],
],
],
@@ -408,13 +191,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'],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 22:37:03 +0000