summaryrefslogtreecommitdiff
path: root/data/pai-dsw/2021-02-26/api-docs.php
blob: b0cbab1cb915b65b06e55fe8a4dcc00c69edcc71 (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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
<?php return [
    'version' => '1.0',
    'info' => ['style' => 'ROA', 'product' => 'pai-dsw', 'version' => '2021-02-26'],
    'components' => [
        'schemas' => [
            'Cluster' => [
                'type' => 'object',
                'properties' => [
                    'ClusterId' => ['type' => 'string'],
                    'Owner' => ['type' => 'string'],
                    'VpcId' => ['type' => 'string'],
                    'VSwitchId' => ['type' => 'string'],
                    'Name' => ['type' => 'string'],
                    'ClusterType' => ['type' => 'string'],
                    'State' => ['type' => 'string'],
                    'Config' => ['type' => 'string'],
                    'Nas' => ['type' => 'string'],
                    'PrivateNasPath' => ['type' => 'string'],
                    'PrivateContainerPath' => ['type' => 'string'],
                    'PublicNasPath' => ['type' => 'string'],
                    'PublicContainerPath' => ['type' => 'string'],
                ],
            ],
            'Config' => [
                'type' => 'object',
                'properties' => [
                    'Name' => ['type' => 'string'],
                    'Value' => ['type' => 'string'],
                ],
            ],
            'Dataset' => [
                'type' => 'object',
                'properties' => [
                    'DatasetId' => ['type' => 'string'],
                    'DefaultMountPath' => ['type' => 'string'],
                    'Name' => ['type' => 'string'],
                    'MountPath' => ['type' => 'string'],
                    'NasPath' => ['type' => 'string'],
                    'FileSystemId' => ['type' => 'string'],
                ],
            ],
            'EcsSpec' => [
                'type' => 'object',
                'properties' => [
                    'InstanceType' => ['type' => 'string'],
                    'Cpu' => ['type' => 'integer', 'format' => 'int64'],
                    'Gpu' => ['type' => 'integer', 'format' => 'int64'],
                    'MemoryInGiB' => ['type' => 'integer', 'format' => 'int64'],
                    'SystemDiskCategory' => ['type' => 'string'],
                    'SystemDiskSizeInGiB' => ['type' => 'integer', 'format' => 'int64'],
                    'GpuType' => ['type' => 'string'],
                ],
            ],
            'Image' => [
                'type' => 'object',
                'properties' => [
                    'ImageId' => ['type' => 'string'],
                    'ImageName' => ['type' => 'string'],
                    'InstanceId' => ['type' => 'string'],
                    'AcceleratorType' => ['type' => 'string'],
                    'Framework' => ['type' => 'string'],
                    'FrameworkVersion' => ['type' => 'string'],
                    'OS' => ['type' => 'string'],
                    'OSVersion' => ['type' => 'string'],
                    'CudaVersion' => ['type' => 'string'],
                    'Type' => ['type' => 'string'],
                    'WorkspaceImageId' => ['type' => 'string'],
                    'Repository' => ['type' => 'string'],
                    'Namespace' => ['type' => 'string'],
                    'Tag' => ['type' => 'string'],
                    'GmtCreateTime' => ['type' => 'string'],
                    'GmtModifiedTime' => ['type' => 'string'],
                    'Author' => ['type' => 'string'],
                    'PythonVersion' => ['type' => 'string'],
                    'Shared' => ['type' => 'boolean'],
                    'ResourceType' => ['type' => 'integer', 'format' => 'int64'],
                    'RootImageId' => ['type' => 'string'],
                    'Description' => ['type' => 'string'],
                    'Stage' => ['type' => 'string'],
                    'StageCode' => ['type' => 'integer', 'format' => 'int64'],
                    'FromImageId' => ['type' => 'string'],
                    'FromImageName' => ['type' => 'string'],
                    'SuggestedName' => ['type' => 'string'],
                    'ImageUrl' => ['type' => 'string'],
                    'Region' => ['type' => 'string'],
                    'EcsImageKey' => ['type' => 'string'],
                    'ShortImageUrl' => ['type' => 'string'],
                    'RepositoryPage' => ['type' => 'string'],
                    'ShortRepository' => ['type' => 'string'],
                ],
            ],
            'ImageNamespace' => [
                'type' => 'object',
                'properties' => [
                    'Namespace' => ['type' => 'string'],
                    'NamespaceStatus' => ['type' => 'string'],
                ],
            ],
            'ImageRepository' => [
                'type' => 'object',
                'properties' => [
                    'RegionId' => ['type' => 'string'],
                    'RepoNamespace' => ['type' => 'string'],
                    'RepoName' => ['type' => 'string'],
                    'RepoStatus' => ['type' => 'string'],
                    'Repository' => ['type' => 'string'],
                    'GmtCreateTime' => ['type' => 'string'],
                    'GmtModifiedTime' => ['type' => 'string'],
                ],
            ],
            'Instance' => [
                'type' => 'object',
                'properties' => [
                    'InstanceId' => ['type' => 'string'],
                    'InstanceName' => ['type' => 'string'],
                    'EcsSpec' => ['type' => 'string'],
                    'InstanceStatus' => ['type' => 'string'],
                    'JupyterlabUrl' => ['type' => 'string'],
                    'WebIdeUrl' => ['type' => 'string'],
                    'TerminalUrl' => ['type' => 'string'],
                    'AccumulativeRunningTimeInMinutes' => ['type' => 'integer', 'format' => 'int64'],
                    'ImageId' => ['type' => 'string'],
                    'ImageUrl' => ['type' => 'string'],
                    'GmtCreateTime' => ['type' => 'string'],
                    'GmtModifiedTime' => ['type' => 'string'],
                    'UserId' => ['type' => 'string'],
                    'NasFileSystemId' => ['type' => 'string'],
                    'UserVpc' => ['$ref' => '#/components/schemas/UserVpc'],
                    'InstanceShutdownTimer' => ['$ref' => '#/components/schemas/InstanceShutdownTimer'],
                    'WorkspaceId' => ['type' => 'string'],
                    'WorkspaceName' => ['type' => 'string'],
                    'InstanceUrl' => ['type' => 'string'],
                    'Message' => ['type' => 'string'],
                    'ShutdownEnabled' => ['type' => 'boolean'],
                    'AccumulativeRunningTimeInMillis' => ['type' => 'integer', 'format' => 'int64'],
                    'ImageName' => ['type' => 'string'],
                    'CreateUser' => ['type' => 'string'],
                    'ImageType' => ['type' => 'string'],
                    'PayType' => ['type' => 'integer', 'format' => 'int64'],
                    'PayTypeName' => ['type' => 'string'],
                    'InstanceVersion' => ['type' => 'string'],
                    'IsPublic' => ['type' => 'integer', 'format' => 'int64'],
                    'Resource' => ['type' => 'string'],
                    'ResourceType' => ['type' => 'integer', 'format' => 'int64'],
                    'UserImageList' => [
                        'type' => 'array',
                        'items' => ['$ref' => '#/components/schemas/Image'],
                    ],
                    'DatasetList' => [
                        'type' => 'array',
                        'items' => ['$ref' => '#/components/schemas/Dataset'],
                    ],
                ],
            ],
            'InstanceShutdownTimer' => [
                'type' => 'object',
                'properties' => [
                    'InstanceId' => ['type' => 'string'],
                    'ScheduleTime' => ['type' => 'string'],
                    'GmtModifiedTime' => ['type' => 'string'],
                    'GmtCreateTime' => ['type' => 'string'],
                    'TtlInMillis' => ['type' => 'integer', 'format' => 'int64'],
                ],
            ],
            'InstanceSnapshot' => [
                'type' => 'object',
                'properties' => [
                    'InstanceId' => ['type' => 'string'],
                    'InstanceSnapshotId' => ['type' => 'string'],
                    'InstanceSnapshotStatus' => ['type' => 'string'],
                    'InstanceSnapshotName' => ['type' => 'string'],
                    'InstanceSnapshotTag' => ['type' => 'string'],
                    'InstanceSnapshotRepoUrl' => ['type' => 'string'],
                    'GmtCreateTime' => ['type' => 'string'],
                    'GmtModifiedTime' => ['type' => 'string'],
                    'InstanceSnapshotDescription' => ['type' => 'string'],
                ],
            ],
            'InstanceStatus' => [
                'type' => 'object',
                'properties' => [
                    'InstanceId' => ['type' => 'string'],
                    'InstanceStatus' => ['type' => 'string'],
                    'Msg' => ['type' => 'string'],
                    'Type' => ['type' => 'string'],
                    'AccumulativeRunningTimeInMinutes' => ['type' => 'integer', 'format' => 'int64'],
                    'InstanceShutdownTimer' => ['$ref' => '#/components/schemas/InstanceShutdownTimer'],
                    'ShutdownEnabled' => ['type' => 'boolean'],
                ],
            ],
            'InstanceType' => [
                'type' => 'object',
                'properties' => [
                    'InstanceTypeId' => ['type' => 'string'],
                    'SystemDiskCategory' => ['type' => 'string'],
                    'SystemDiskSize' => ['type' => 'integer', 'format' => 'int64'],
                    'PriceCNY' => ['type' => 'number', 'format' => 'float'],
                    'PriceUSD' => ['type' => 'number', 'format' => 'float'],
                    'DomesticPrice' => ['type' => 'number', 'format' => 'float'],
                    'Discount' => ['type' => 'number', 'format' => 'float'],
                    'ResourceType' => ['type' => 'string'],
                    'International' => ['type' => 'boolean'],
                    'CpuCoreCount' => ['type' => 'integer', 'format' => 'int64'],
                    'MemorySize' => ['type' => 'number', 'format' => 'float'],
                    'InstanceTypeFamily' => ['type' => 'string'],
                    'LocalStorageCapacity' => ['type' => 'integer', 'format' => 'int64'],
                    'GPUAmount' => ['type' => 'integer', 'format' => 'int64'],
                    'GPUSpec' => ['type' => 'string'],
                    'Price' => ['type' => 'number', 'format' => 'float'],
                    'InstanceBandwidthRx' => ['type' => 'integer', 'format' => 'int64'],
                    'InstanceBandwidthTx' => ['type' => 'integer', 'format' => 'int64'],
                    'InstancePpsRx' => ['type' => 'integer', 'format' => 'int64'],
                    'InstancePpsTx' => ['type' => 'integer', 'format' => 'int64'],
                ],
            ],
            'Nas' => [
                'type' => 'object',
                'properties' => [
                    'FileSystemId' => ['type' => 'string'],
                    'Status' => ['type' => 'string'],
                    'Description' => ['type' => 'string'],
                ],
            ],
            'Region' => [
                'type' => 'object',
                'properties' => [
                    'RegionId' => ['type' => 'string'],
                    'RegionName' => ['type' => 'string'],
                    'RegionCity' => ['type' => 'string'],
                    'RegionState' => ['type' => 'string'],
                    'ServiceUrl' => ['type' => 'string'],
                ],
            ],
            'ResourceInfo' => [
                'type' => 'object',
                'properties' => [
                    'PayType' => ['type' => 'integer', 'format' => 'int64'],
                    'ResourceType' => ['type' => 'integer', 'format' => 'int64'],
                    'Name' => ['type' => 'string'],
                ],
            ],
            'SecurityGroup' => [
                'type' => 'object',
                'properties' => [
                    'SecurityGroupId' => ['type' => 'string'],
                    'VpcId' => ['type' => 'string'],
                    'SecurityGroupName' => ['type' => 'string'],
                    'Description' => ['type' => 'string'],
                    'CreateTime' => ['type' => 'string'],
                ],
            ],
            'Status' => [
                'type' => 'object',
                'properties' => [
                    'InstanceId' => ['type' => 'string'],
                    'InstanceStatus' => ['type' => 'string'],
                    'Msg' => ['type' => 'string'],
                    'Type' => ['type' => 'string'],
                    'AccumulativeRunningTimeInMinutes' => ['type' => 'integer', 'format' => 'int64'],
                    'InstanceShutdownTimer' => ['$ref' => '#/components/schemas/InstanceShutdownTimer'],
                ],
            ],
            'UserVpc' => [
                'type' => 'object',
                'properties' => [
                    'VpcId' => ['type' => 'string'],
                    'VswitchId' => ['type' => 'string'],
                    'RoleArn' => ['type' => 'string'],
                    'SecurityGroupId' => ['type' => 'string'],
                ],
            ],
            'VSwitch' => [
                'type' => 'object',
                'properties' => [
                    'VSwitchId' => ['type' => 'string'],
                    'VpcId' => ['type' => 'string'],
                    'Status' => ['type' => 'string'],
                    'CidrBlock' => ['type' => 'string'],
                    'ZoneId' => ['type' => 'string'],
                    'AvailableIpAddressCount' => ['type' => 'integer', 'format' => 'int64'],
                    'Description' => ['type' => 'string'],
                    'VSwitchName' => ['type' => 'string'],
                    'CreateTime' => ['type' => 'string'],
                    'IsDefault' => ['type' => 'boolean'],
                ],
            ],
            'Vpc' => [
                'type' => 'object',
                'properties' => [
                    'VpcId' => ['type' => 'string'],
                    'Status' => ['type' => 'string'],
                    'VpcName' => ['type' => 'string'],
                    'CreateTime' => ['type' => 'string'],
                    'CidrBlock' => ['type' => 'string'],
                    'VRouterId' => ['type' => 'string'],
                    'Description' => ['type' => 'string'],
                    'IsDefault' => ['type' => 'boolean'],
                ],
            ],
        ],
    ],
    'apis' => [
        'GetInstance' => [
            'path' => '/api/v1/instances/{InstanceId}',
            'methods' => ['get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'InstanceId',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
            ],
        ],
    ],
    'endpoints' => [
        ['regionId' => 'us-west-1', 'endpoint' => 'pai-dsw.us-west-1.aliyuncs.com'],
        ['regionId' => 'cn-hongkong', 'endpoint' => 'pai-dsw.cn-hongkong.aliyuncs.com'],
        ['regionId' => 'ap-southeast-1', 'endpoint' => 'pai-dsw.ap-southeast-1.aliyuncs.com'],
        ['regionId' => 'cn-shanghai', 'endpoint' => 'pai-dsw.cn-shanghai.aliyuncs.com'],
        ['regionId' => 'cn-beijing', 'endpoint' => 'pai-dsw.cn-beijing.aliyuncs.com'],
        ['regionId' => 'cn-hangzhou', 'endpoint' => 'pai-dsw.cn-hangzhou.aliyuncs.com'],
        ['regionId' => 'cn-shanghai-finance-1', 'endpoint' => 'pai-dsw.cn-shanghai-finance-1.aliyuncs.com'],
        ['regionId' => 'ap-northeast-1', 'endpoint' => 'pai-dsw.ap-northeast-1.aliyuncs.com'],
        ['regionId' => 'ap-southeast-5', 'endpoint' => 'pai-dsw.ap-southeast-5.aliyuncs.com'],
        ['regionId' => 'cn-guangzhou', 'endpoint' => 'pai-dsw.cn-guangzhou.aliyuncs.com'],
        ['regionId' => 'ap-northeast-2', 'endpoint' => 'pai-dsw.ap-northeast-2.aliyuncs.com'],
        ['regionId' => 'ap-southeast-7', 'endpoint' => 'pai-dsw.ap-southeast-7.aliyuncs.com'],
        ['regionId' => 'ap-southeast-3', 'endpoint' => 'pai-dsw.ap-southeast-3.aliyuncs.com'],
        ['regionId' => 'cn-chengdu', 'endpoint' => 'pai-dsw.cn-chengdu.aliyuncs.com'],
        ['regionId' => 'cn-shenzhen', 'endpoint' => 'pai-dsw.cn-shenzhen.aliyuncs.com'],
        ['regionId' => 'ap-south-1', 'endpoint' => 'pai-dsw.ap-south-1.aliyuncs.com'],
        ['regionId' => 'us-southeast-1', 'endpoint' => 'pai-dsw.us-southeast-1.aliyuncs.com'],
        ['regionId' => 'me-central-1', 'endpoint' => 'pai-dsw.me-central-1.aliyuncs.com'],
        ['regionId' => 'eu-central-1', 'endpoint' => 'pai-dsw.eu-central-1.aliyuncs.com'],
        ['regionId' => 'me-east-1', 'endpoint' => 'pai-dsw.me-east-1.aliyuncs.com'],
        ['regionId' => 'us-east-1', 'endpoint' => 'pai-dsw.us-east-1.aliyuncs.com'],
        ['regionId' => 'cn-wulanchabu', 'endpoint' => 'pai-dsw.cn-wulanchabu.aliyuncs.com'],
        ['regionId' => 'ap-southeast-8', 'endpoint' => 'pai-dsw.ap-southeast-8.aliyuncs.com'],
    ],
];