summaryrefslogtreecommitdiff
path: root/data/en_us/bpstudio/2020-07-10/api-docs.php
blob: d3f968f7a3b6853b3a911bbb0486282f2c0fde6a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
<?php return [
    'version' => '1.0',
    'info' => ['style' => 'RPC', 'product' => 'BPStudio', 'version' => '2020-07-10'],
    'directories' => [
        [
            'id' => 0,
            'title' => '其它',
            'type' => 'directory',
            'children' => ['GetDeployDetail'],
        ],
    ],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'GetDeployDetail' => [
            'summary' => '分页查询部署清单',
            'methods' => ['post', 'get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'readAndWrite',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'get',
                'abilityTreeCode' => '104355',
                'abilityTreeNodes' => ['FEATUREbpstudioJLICAE'],
            ],
            'parameters' => [
                [
                    'name' => 'AppId',
                    'in' => 'formData',
                    'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '30GRJUY95TMYWBYJ'],
                ],
                [
                    'name' => 'ResourceGroupId',
                    'in' => 'formData',
                    'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'rg-aekz44tg3bnpyba'],
                ],
                [
                    'name' => 'NextToken',
                    'in' => 'formData',
                    'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
                ],
                [
                    'name' => 'MaxResults',
                    'in' => 'formData',
                    'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '40'],
                ],
                [
                    'name' => 'ResourceId',
                    'in' => 'formData',
                    'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'vsw-xxxxxxxxxxxx'],
                ],
                [
                    'name' => 'ResourceType',
                    'in' => 'formData',
                    'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'ecs'],
                ],
                [
                    'name' => 'ResourceName',
                    'in' => 'formData',
                    'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'rgm-ecs'],
                ],
                [
                    'name' => 'RefId',
                    'in' => 'formData',
                    'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '1713597738'],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'Message' => ['description' => '', 'type' => 'string', 'example' => 'Success'],
                            'RequestId' => ['description' => '', 'type' => 'string', 'example' => 'E15B71B4-5D8F-5484-BC07-989E2987EE7C'],
                            'Data' => [
                                'description' => '',
                                'type' => 'array',
                                'items' => [
                                    'description' => '',
                                    'type' => 'object',
                                    'properties' => [
                                        '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'],
                                        'ResourceList' => [
                                            'description' => '',
                                            'type' => 'array',
                                            'items' => [
                                                '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'],
                                                    'Operation' => [
                                                        'description' => '',
                                                        'type' => 'object',
                                                        'properties' => [
                                                            'Name' => ['description' => '', 'type' => 'string', 'example' => 'ecsDelete'],
                                                            'Operations' => ['description' => '', 'type' => 'object', 'example' => ''],
                                                        ],
                                                    ],
                                                    'ResourceTimeList' => [
                                                        'type' => 'array',
                                                        'items' => [
                                                            'type' => 'object',
                                                            'properties' => [
                                                                'id' => ['type' => 'integer', 'format' => 'int64'],
                                                                'BizId' => ['type' => 'string'],
                                                                'CreationStartTime' => ['type' => 'integer', 'format' => 'int64'],
                                                                'CreationEndTime' => ['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'],
                                        'DeployingNodeList' => [
                                            'description' => '',
                                            'type' => 'array',
                                            '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"}]'],
                                        ],
                                        'DeletingNodeList' => [
                                            'description' => '',
                                            'type' => 'array',
                                            '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'],
                        ],
                    ],
                ],
            ],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"Message\\": \\"Success\\",\\n  \\"RequestId\\": \\"E15B71B4-5D8F-5484-BC07-989E2987EE7C\\",\\n  \\"Data\\": [\\n    {\\n      \\"Status\\": \\"Revised\\",\\n      \\"OrderIdList\\": [\\n        \\"[11396641]\\"\\n      ],\\n      \\"AppId\\": \\"EQ4W772D0VJ33IV1\\",\\n      \\"CreateTime\\": 1645516991000,\\n      \\"ResourceList\\": [\\n        {\\n          \\"Status\\": \\"Finish\\",\\n          \\"ResourceType\\": \\"vpc\\",\\n          \\"ModifiedTime\\": 1714031840000,\\n          \\"Remark\\": \\"{\\\\\\\\\\\\\\"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\\\\\\\\\\\\\\":[]}\\",\\n          \\"NodeName\\": \\"vpc\\",\\n          \\"ChargeType\\": \\"Free\\",\\n          \\"BuyDuration\\": \\"1=新购,0=已保有\\",\\n          \\"ResourceId\\": \\"i-2zehnzxqixu1pywsfbx1\\",\\n          \\"ResourceCode\\": \\"ecs\\",\\n          \\"RefId\\": 1716049421,\\n          \\"MonitorURL\\": \\"https://cloudmonitor.console.aliyun.com/?#/generalcharts/product=vpc&group=&type=&return&region=cn-hangzhou&dimension=instanceId:vpc-bp1n6uc5jqxtff2euhnx5\\",\\n          \\"ExecutionStrategy\\": \\"OpenApi\\",\\n          \\"Operation\\": {\\n            \\"Name\\": \\"ecsDelete\\",\\n            \\"Operations\\": {\\n              \\"mode\\": \\"sync\\",\\n              \\"display\\": \\"修改实例名\\",\\n              \\"show\\": {},\\n              \\"attributes\\": {\\n                \\"instance_name\\": {\\n                  \\"controlType\\": \\"Input\\",\\n                  \\"display\\": \\"VSWITCH名\\",\\n                  \\"format\\": \\"^[\\\\\\\\u4e00-\\\\\\\\u9fa5A-Za-z]{1}[\\\\\\\\u4e00-\\\\\\\\u9fa5\\\\\\\\w\\\\\\\\-\\\\\\\\_]{1,127}$\\",\\n                  \\"orderBy\\": 0,\\n                  \\"tip\\": \\"长度为2~128个字符,以英文大小字母或中文开头,可包含数字、下划线(_)和连字符(-)。\\",\\n                  \\"required\\": true\\n                }\\n              },\\n              \\"type\\": \\"window\\",\\n              \\"properties\\": {\\n                \\"instanceId\\": \\"ResourceId\\",\\n                \\"regionId\\": \\"region\\",\\n                \\"appId\\": \\"appId\\"\\n              }\\n            }\\n          },\\n          \\"ResourceTimeList\\": [\\n            {\\n              \\"id\\": 0,\\n              \\"BizId\\": \\"\\",\\n              \\"CreationStartTime\\": 0,\\n              \\"CreationEndTime\\": 0\\n            }\\n          ],\\n          \\"ExpiredTime\\": 0\\n        }\\n      ],\\n      \\"Error\\": \\"OperationNotSupport.SubscriptionCommodityCanNotDelete\\",\\n      \\"FailStatus\\": 0,\\n      \\"TerraformScriptUrl\\": \\"https://cadt-studio-publish.oss-cn-hangzhou.aliyuncs.com/1986207497633020/app_EXN4FNUR12M35KJM.tf?Expires=1716967763&OSSAccessKeyId=*******nw4rvYAweFuQc3&Signature=%2********lYROqJLNvyA8g6qD9U%3D\\",\\n      \\"ExecutionTime\\": 0,\\n      \\"PdfUrl\\": \\"https://cadt-studio-publish.oss-cn-hangzhou.aliyuncs.com/1986207497633020/deployReport-EXN4FNUR12M35KJM.pdf?Expires=1716967763&OSSAccessKeyId=********nw4rvYAweFuQc3&Signature=*******fKo6164wykT9jBOsSGeQ%3D\\",\\n      \\"ResourceGroupId\\": \\"rg-aekzhfgmw4e6fwq\\",\\n      \\"CurrentProcess\\": \\"DEPLOY\\",\\n      \\"DeployPercent\\": 0,\\n      \\"DeployingNodeList\\": [\\n        [\\n          {\\n            \\"nodeNameList\\": \\"vpc\\",\\n            \\"nodeType\\": \\"vpc\\"\\n          },\\n          {\\n            \\"nodeNameList\\": \\"vswitch\\",\\n            \\"nodeType\\": \\"vswitch\\"\\n          }\\n        ]\\n      ],\\n      \\"DeployedNodeList\\": [\\n        [\\n          {\\n            \\"nodeNameList\\": \\"vpc\\",\\n            \\"nodeType\\": \\"vpc\\"\\n          },\\n          {\\n            \\"nodeNameList\\": \\"vswitch\\",\\n            \\"nodeType\\": \\"vswitch\\"\\n          }\\n        ]\\n      ],\\n      \\"DeletingNodeList\\": [\\n        [\\n          {\\n            \\"nodeNameList\\": \\"vpc\\",\\n            \\"nodeType\\": \\"vpc\\"\\n          },\\n          {\\n            \\"nodeNameList\\": \\"vswitch\\",\\n            \\"nodeType\\": \\"vswitch\\"\\n          }\\n        ]\\n      ]\\n    }\\n  ],\\n  \\"Code\\": 200,\\n  \\"TotalCount\\": 10,\\n  \\"NextToken\\": 0\\n}","type":"json"}]',
        ],
    ],
    'endpoints' => [
        ['regionId' => 'cn-hangzhou', 'endpoint' => 'bpstudio.cn-hangzhou.aliyuncs.com'],
        ['regionId' => 'ap-southeast-1', 'endpoint' => 'bpstudio.ap-southeast-1.aliyuncs.com'],
    ],
];