summaryrefslogtreecommitdiff
path: root/data/ecs-workbench/2022-02-20/api-docs.php
blob: 209ff859ebdbe3e4943d94673a057ca85767e1e5 (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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
<?php return [
    'version' => '1.0',
    'info' => ['style' => 'RPC', 'product' => 'ecs-workbench', 'version' => '2022-02-20'],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'GetInstanceRecordConfig' => [
            'methods' => ['post'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'InstanceId',
                    'in' => 'formData',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'RegionId',
                    'in' => 'formData',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
            ],
        ],
        'ListInstanceRecords' => [
            'methods' => ['post'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'InstanceId',
                    'in' => 'formData',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'PageNumber',
                    'in' => 'formData',
                    'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                ],
                [
                    'name' => 'PageSize',
                    'in' => 'formData',
                    'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                ],
                [
                    'name' => 'RegionId',
                    'in' => 'formData',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
            ],
        ],
        'ListTerminalCommands' => [
            'methods' => ['post'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'PageNumber',
                    'in' => 'formData',
                    'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                ],
                [
                    'name' => 'PageSize',
                    'in' => 'formData',
                    'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                ],
                [
                    'name' => 'TerminalSessionToken',
                    'in' => 'formData',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'RegionId',
                    'in' => 'formData',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
            ],
        ],
        'LoginInstance' => [
            'methods' => ['post'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'InstanceLoginInfo',
                    'in' => 'query',
                    'style' => 'flat',
                    'schema' => [
                        'type' => 'object',
                        'required' => false,
                        'properties' => [
                            'InstanceType' => ['type' => 'string', 'required' => false],
                            'RegionId' => ['type' => 'string', 'required' => false],
                            'InstanceId' => ['type' => 'string', 'required' => false],
                            'VpcId' => ['type' => 'string', 'required' => false],
                            'NetworkAccessMode' => ['type' => 'string', 'required' => false],
                            'Host' => ['type' => 'string', 'required' => false],
                            'Port' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                            'Protocol' => ['type' => 'string', 'required' => false],
                            'Username' => ['type' => 'string', 'required' => false],
                            'AuthenticationType' => ['type' => 'string', 'required' => false],
                            'Password' => ['type' => 'string', 'required' => false],
                            'Certificate' => ['type' => 'string', 'required' => false],
                            'PassPhrase' => ['type' => 'string', 'required' => false],
                            'Options' => [
                                'type' => 'object',
                                'required' => false,
                                'properties' => [
                                    'ContainerInfo' => [
                                        'type' => 'object',
                                        'required' => false,
                                        'properties' => [
                                            'ClusterId' => ['type' => 'string', 'required' => false],
                                            'ClusterName' => ['type' => 'string', 'required' => false],
                                            'Namespace' => ['type' => 'string', 'required' => false],
                                            'Deployment' => ['type' => 'string', 'required' => false],
                                            'PodName' => ['type' => 'string', 'required' => false],
                                            'ContainerName' => ['type' => 'string', 'required' => false],
                                            'Headers' => ['type' => 'object', 'required' => false],
                                            'Endpoint' => ['type' => 'string', 'required' => false],
                                        ],
                                    ],
                                    'NotificationRecipientUrl' => ['type' => 'string', 'required' => false],
                                    'NotificationEventTypes' => ['type' => 'string', 'required' => false],
                                    'NotificationRetryLimit' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                                    'NotificationRetryIntervalSeconds' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                                    'SessionControl' => ['type' => 'string', 'required' => false],
                                    'OperationDisableSeconds' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                                    'AudioMuteSeconds' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                                    'VideoFreezeSeconds' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                                    'FixedHeight' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                                    'FixedWidth' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                                ],
                            ],
                            'ExpireTime' => ['type' => 'string', 'required' => false],
                            'DurationSeconds' => ['type' => 'integer', 'format' => 'int64', 'required' => false],
                            'DockerExec' => ['type' => 'string', 'required' => false],
                            'DockerContainerName' => ['type' => 'string', 'required' => false],
                            'ResourceGroupId' => ['type' => 'string', 'required' => false],
                            'CredentialToken' => ['type' => 'string', 'required' => false],
                            'LoginByInstanceCredential' => ['type' => 'boolean', 'required' => false],
                            'LoginByInstanceShortcut' => ['type' => 'boolean', 'required' => false],
                            'ShortcutToken' => ['type' => 'string', 'required' => false],
                            'EncryptionOptions' => [
                                'type' => 'object',
                                'properties' => [
                                    'Enabled' => ['type' => 'boolean'],
                                    'Mode' => ['type' => 'string'],
                                    'KMSKeyId' => ['type' => 'string'],
                                ],
                            ],
                        ],
                    ],
                ],
                [
                    'name' => 'UserAccount',
                    'in' => 'query',
                    'style' => 'flat',
                    'schema' => [
                        'type' => 'object',
                        'required' => false,
                        'properties' => [
                            'ParentId' => ['type' => 'integer', 'format' => 'int64', 'required' => false],
                            'AccountId' => ['type' => 'integer', 'format' => 'int64', 'required' => false],
                            'AccountPlatform' => ['type' => 'string', 'required' => false],
                            'EmpId' => ['type' => 'string', 'required' => false],
                            'Options' => [
                                'type' => 'object',
                                'required' => false,
                                'properties' => [
                                    'LoginLimit' => ['type' => 'integer', 'format' => 'int64', 'required' => false],
                                ],
                            ],
                            'AccountStructure' => ['type' => 'string', 'required' => false],
                            'LoginName' => ['type' => 'string', 'required' => false],
                            'DurationSeconds' => ['type' => 'integer', 'format' => 'int64', 'required' => false],
                            'ExpireTime' => ['type' => 'string', 'required' => false],
                        ],
                    ],
                ],
                [
                    'name' => 'PartnerInfo',
                    'in' => 'query',
                    'style' => 'flat',
                    'schema' => [
                        'type' => 'object',
                        'required' => false,
                        'properties' => [
                            'PartnerId' => ['type' => 'string', 'required' => false],
                            'PartnerName' => ['type' => 'string', 'required' => false],
                        ],
                    ],
                ],
            ],
        ],
        'SetInstanceRecordConfig' => [
            'methods' => ['post'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'Enabled',
                    'in' => 'formData',
                    'schema' => ['type' => 'boolean', 'required' => true],
                ],
                [
                    'name' => 'InstanceId',
                    'in' => 'formData',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'RecordStorageTarget',
                    'in' => 'formData',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'ExpirationDays',
                    'in' => 'formData',
                    'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                ],
                [
                    'name' => 'RegionId',
                    'in' => 'formData',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'ResourceRegionId',
                    'in' => 'formData',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
            ],
        ],
        'ViewInstanceRecords' => [
            'methods' => ['post'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'InstanceId',
                    'in' => 'formData',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'TerminalSessionToken',
                    'in' => 'formData',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'RegionId',
                    'in' => 'formData',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
            ],
        ],
    ],
    'endpoints' => [
        ['regionId' => 'cn-beijing', 'regionName' => '华北2(北京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ecs-workbench.cn-beijing.aliyuncs.com', 'endpoint' => 'ecs-workbench.cn-beijing.aliyuncs.com', 'vpc' => 'ecs-workbench-vpc.cn-beijing.aliyuncs.com'],
        ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ecs-workbench.ap-southeast-1.aliyuncs.com', 'endpoint' => 'ecs-workbench.ap-southeast-1.aliyuncs.com', 'vpc' => 'ecs-workbench-vpc.ap-southeast-1.aliyuncs.com'],
        ['regionId' => 'cn-hangzhou', 'regionName' => '华东1(杭州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ecs-workbench.cn-hangzhou.aliyuncs.com', 'endpoint' => 'ecs-workbench.cn-hangzhou.aliyuncs.com', 'vpc' => 'ecs-workbench-vpc.cn-hangzhou.aliyuncs.com'],
    ],
];