data/en_us/viapi/2023-01-17/api-docs.php


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
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384

<?php return [
    'version' => '1.0',
    'info' => [
        'style' => 'RPC',
        'product' => 'viapi',
        'version' => '2023-01-17',
    ],
    'directories' => [
        'QueryAsyncJobList',
        'GetAsyncJobResult',
        'CancelWaitingAsyncJob',
    ],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'QueryAsyncJobList' => [
            'summary' => '查询异步任务列表',
            'methods' => [
                'post',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'none',
                'riskType' => 'none',
                'chargeType' => 'free',
                'tenantRelevance' => 'publicInformation',
            ],
            'parameters' => [
                [
                    'name' => 'StartTime',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'example' => '2023-01-04 00:00:00',
                        'required' => false,
                        'type' => 'string',
                    ],
                ],
                [
                    'name' => 'EndTime',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'example' => '2023-01-04 23:00:00',
                        'required' => false,
                        'type' => 'string',
                    ],
                ],
                [
                    'name' => 'JobId',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'example' => 'E75FE679-0303-4DD1-8252-1143B4FA8A27	',
                        'required' => false,
                        'type' => 'string',
                    ],
                ],
                [
                    'name' => 'PopProduct',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'example' => 'ocr',
                        'required' => false,
                        'type' => 'string',
                    ],
                ],
                [
                    'name' => 'PopApiName',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'example' => 'RecognizeIdentityCard	',
                        'required' => false,
                        'type' => 'string',
                    ],
                ],
                [
                    'name' => 'Status',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'example' => 'PROCESS_SUCCESS',
                        'required' => false,
                        'type' => 'string',
                    ],
                ],
                [
                    'name' => 'PageNum',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'example' => '1',
                        'required' => false,
                        'type' => 'string',
                    ],
                ],
                [
                    'name' => 'PageSize',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'example' => '20',
                        'required' => false,
                        'type' => 'string',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'description' => 'Schema of Response',
                        'properties' => [
                            'RequestId' => [
                                'description' => '',
                                'example' => '43A0AEB6-45F4-4138-8E89-E1A5D63200E3',
                                'title' => 'Id of the request',
                                'type' => 'string',
                            ],
                            'Data' => [
                                'description' => '',
                                'properties' => [
                                    'CurrentPage' => [
                                        'description' => '',
                                        'example' => '1',
                                        'format' => 'int32',
                                        'type' => 'integer',
                                    ],
                                    'PageSize' => [
                                        'description' => '',
                                        'example' => '20',
                                        'format' => 'int32',
                                        'type' => 'integer',
                                    ],
                                    'TotalPage' => [
                                        'description' => '',
                                        'example' => '2',
                                        'format' => 'int32',
                                        'type' => 'integer',
                                    ],
                                    'TotalRecord' => [
                                        'description' => '',
                                        'example' => '22',
                                        'format' => 'int32',
                                        'type' => 'integer',
                                    ],
                                    'Result' => [
                                        'description' => '',
                                        'items' => [
                                            'properties' => [
                                                'CallerParentId' => [
                                                    'description' => '',
                                                    'example' => '1850343078585779',
                                                    'type' => 'string',
                                                ],
                                                'EndTime' => [
                                                    'description' => '',
                                                    'example' => '2023-01-04 17:18:44',
                                                    'type' => 'string',
                                                ],
                                                'GmtCreate' => [
                                                    'description' => '',
                                                    'example' => '2023-01-04 17:18:44',
                                                    'type' => 'string',
                                                ],
                                                'JobId' => [
                                                    'description' => '',
                                                    'example' => '49E2CC28-ED1D-4CC5-854D-7D0AE2B20976',
                                                    'type' => 'string',
                                                ],
                                                'PopApiName' => [
                                                    'description' => '',
                                                    'example' => 'DetectVideoShot',
                                                    'type' => 'string',
                                                ],
                                                'PopProduct' => [
                                                    'description' => '',
                                                    'example' => 'videorecog',
                                                    'type' => 'string',
                                                ],
                                                'StartTime' => [
                                                    'description' => '',
                                                    'example' => '2023-01-04 17:18:44',
                                                    'type' => 'string',
                                                ],
                                                'Status' => [
                                                    'description' => '',
                                                    'example' => 'PROCESS_SUCCESS',
                                                    'type' => 'string',
                                                ],
                                            ],
                                            'type' => 'object',
                                        ],
                                        'type' => 'array',
                                    ],
                                ],
                                'type' => 'object',
                            ],
                            'Message' => [
                                'description' => '',
                                'example' => 'success',
                                'type' => 'string',
                            ],
                            'Success' => [
                                'description' => '',
                                'example' => 'true',
                                'type' => 'boolean',
                            ],
                            'HttpCode' => [
                                'description' => '',
                                'example' => '200',
                                'type' => 'string',
                            ],
                        ],
                        'title' => 'Schema of Response',
                        'type' => 'object',
                    ],
                ],
            ],
            'staticInfo' => [
                'returnType' => 'synchronous',
            ],
            'responseDemo' => '[{"type":"json","example":"{\\n  \\"RequestId\\": \\"43A0AEB6-45F4-4138-8E89-E1A5D63200E3\\",\\n  \\"Data\\": {\\n    \\"CurrentPage\\": 1,\\n    \\"PageSize\\": 20,\\n    \\"TotalPage\\": 2,\\n    \\"TotalRecord\\": 22,\\n    \\"Result\\": [\\n      {\\n        \\"CallerParentId\\": \\"1850343078585779\\",\\n        \\"EndTime\\": \\"2023-01-04 17:18:44\\",\\n        \\"GmtCreate\\": \\"2023-01-04 17:18:44\\",\\n        \\"JobId\\": \\"49E2CC28-ED1D-4CC5-854D-7D0AE2B20976\\",\\n        \\"PopApiName\\": \\"DetectVideoShot\\",\\n        \\"PopProduct\\": \\"videorecog\\",\\n        \\"StartTime\\": \\"2023-01-04 17:18:44\\",\\n        \\"Status\\": \\"PROCESS_SUCCESS\\"\\n      }\\n    ]\\n  },\\n  \\"Message\\": \\"paramsIllegal\\",\\n  \\"Success\\": true,\\n  \\"HttpCode\\": \\"InvalidParameter\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryAsyncJobListResponse>\\n    <RequestId>43A0AEB6-45F4-4138-8E89-E1A5D63200E3</RequestId>\\n    <Data>\\n        <CurrentPage>1</CurrentPage>\\n        <PageSize>20</PageSize>\\n        <TotalPage>2</TotalPage>\\n        <TotalRecord>22</TotalRecord>\\n        <Result>\\n            <CallerParentId>1850343078585779</CallerParentId>\\n            <EndTime>2023-01-04 17:18:44</EndTime>\\n            <GmtCreate>2023-01-04 17:18:44</GmtCreate>\\n            <JobId>49E2CC28-ED1D-4CC5-854D-7D0AE2B20976</JobId>\\n            <PopApiName>DetectVideoShot</PopApiName>\\n            <PopProduct>videorecog</PopProduct>\\n            <StartTime>2023-01-04 17:18:44</StartTime>\\n            <Status>PROCESS_SUCCESS</Status>\\n        </Result>\\n    </Data>\\n    <Message>paramsIllegal</Message>\\n    <Success>true</Success>\\n    <HttpCode>InvalidParameter</HttpCode>\\n</QueryAsyncJobListResponse>","errorExample":""}]',
        ],
        'GetAsyncJobResult' => [
            'methods' => [
                'post',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'deprecated' => false,
            'systemTags' => [],
            'parameters' => [
                [
                    'name' => 'JobId',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'example' => 'E75FE679-0303-4DD1-8252-1143B4FA8A27	',
                        'required' => true,
                        'type' => 'string',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'properties' => [
                            'RequestId' => [
                                'description' => '',
                                'example' => 'E335106F-9F96-491D-AEB3-1610F8545968',
                                'type' => 'string',
                            ],
                            'Data' => [
                                'description' => '',
                                'properties' => [
                                    'Status' => [
                                        'description' => '',
                                        'example' => 'PROCESS_SUCCESS',
                                        'type' => 'string',
                                    ],
                                    'ErrorMessage' => [
                                        'description' => '',
                                        'example' => 'product is not active',
                                        'type' => 'string',
                                    ],
                                    'Result' => [
                                        'description' => '',
                                        'example' => '{\\"pointCloudUrl\\":\\"http://virutalbuy-public.oss-cn-hangzhou.aliyuncs.com/MultiviewStereo/83e2fcec-02e1-4522-8680-92f532956e2c/cas_input.ply\\"}',
                                        'type' => 'string',
                                    ],
                                    'ErrorCode' => [
                                        'description' => '',
                                        'example' => 'InvalidParameter',
                                        'type' => 'string',
                                    ],
                                    'JobId' => [
                                        'description' => '',
                                        'example' => 'B6590005-5E7C-4A25-8F97-4479888D8271',
                                        'type' => 'string',
                                    ],
                                ],
                                'type' => 'object',
                            ],
                        ],
                        'type' => 'object',
                    ],
                ],
            ],
            'responseDemo' => '[{"type":"json","example":"{\\n  \\"RequestId\\": \\"0E448D84-1736-1BCD-BEA5-866C413515A1\\",\\n  \\"Data\\": {\\n    \\"Status\\": \\"PROCESS_SUCCESS\\",\\n    \\"ErrorMessage\\": \\"paramsIllegal\\",\\n    \\"Result\\": \\"\\\\\\"{\\\\\\\\\\\\\\"jsonUrl\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"http://vibktprfx-prod-prod-damo-eas-cn-shanghai.oss-cn-shanghai.aliyuncs.com/eas-video-quality-assessment/2023-01-11-16/01%3A52-crxCR763VXTeY0bP.json?Expires=1673425915&OSSAccessKeyId=LTAI****************&Signature=iW07EIZaqaiMNoF3RJZwsLVxOx****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"pdfUrl\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"http://vibktprfx-prod-prod-damo-eas-cn-shanghai.oss-cn-shanghai.aliyuncs.com/eas-video-quality-assessment/2023-01-11-16/01%3A52-crxCR763VXTeY0bP.pdf?Expires=1673425916&OSSAccessKeyId=LTAI****************&Signature=BvZ3ayeTTxaR65ZvQ2%2FoE8W8Lr****\\\\\\\\\\\\\\"}\\\\\\"\\",\\n    \\"ErrorCode\\": \\"InvalidParameter\\",\\n    \\"JobId\\": \\"A421D5F0-4F73-19F5-8D92-D509FAD281D2\\"\\n  }\\n}","errorExample":""},{"type":"xml","example":"<GetAsyncJobResultResponse>\\n    <RequestId>0E448D84-1736-1BCD-BEA5-866C413515A1</RequestId>\\n    <Data>\\n        <Status>PROCESS_SUCCESS</Status>\\n        <JobId>A421D5F0-4F73-19F5-8D92-D509FAD281D2</JobId>\\n        <Result>{\\"jsonUrl\\":\\"http://vibktprfx-prod-prod-damo-eas-cn-shanghai.oss-cn-shanghai.aliyuncs.com/eas-video-quality-assessment/2023-01-11-16/01%3A52-crxCR763VXTeY0bP.json?Expires=1673425915&amp;OSSAccessKeyId=LTAI****************&amp;Signature=iW07EIZaqaiMNoF3RJZwsLVxOx****\\",\\"pdfUrl\\":\\"http://vibktprfx-prod-prod-damo-eas-cn-shanghai.oss-cn-shanghai.aliyuncs.com/eas-video-quality-assessment/2023-01-11-16/01%3A52-crxCR763VXTeY0bP.pdf?Expires=1673425916&amp;OSSAccessKeyId=LTAI****************&amp;Signature=BvZ3ayeTTxaR65ZvQ2%2FoE8W8Lr****\\"}</Result>\\n    </Data>\\n</GetAsyncJobResultResponse>","errorExample":""}]',
        ],
        'CancelWaitingAsyncJob' => [
            'summary' => '取消排队异步任务',
            'methods' => [
                'post',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'systemTags' => [],
            'parameters' => [
                [
                    'name' => 'JobId',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'example' => 'E75FE679-0303-4DD1-8252-1143B4FA8A27	',
                        'required' => true,
                        'type' => 'string',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'description' => 'Schema of Response',
                        'properties' => [
                            'RequestId' => [
                                'description' => '',
                                'example' => '43A0AEB6-45F4-4138-8E89-E1A5D63200E3',
                                'title' => 'Id of the request',
                                'type' => 'string',
                            ],
                            'Message' => [
                                'description' => '',
                                'example' => 'Cancel job success',
                                'type' => 'string',
                            ],
                            'Success' => [
                                'description' => '',
                                'example' => 'true',
                                'type' => 'boolean',
                            ],
                            'HttpCode' => [
                                'description' => '',
                                'example' => '200',
                                'type' => 'string',
                            ],
                        ],
                        'title' => 'Schema of Response',
                        'type' => 'object',
                    ],
                ],
            ],
            'staticInfo' => [
                'returnType' => 'synchronous',
            ],
            'responseDemo' => '[{"type":"json","example":"{\\n  \\"RequestId\\": \\"43A0AEB6-45F4-4138-8E89-E1A5D63200E3\\",\\n  \\"Message\\": \\"Cancel job success\\",\\n  \\"Success\\": true,\\n  \\"HttpCode\\": \\"InvalidParameter\\"\\n}","errorExample":""},{"type":"xml","example":"<CancelWaitingAsyncJobResponse>\\n    <RequestId>43A0AEB6-45F4-4138-8E89-E1A5D63200E3</RequestId>\\n    <Message>Cancel job success</Message>\\n    <Success>true</Success>\\n    <HttpCode>InvalidParameter</HttpCode>\\n</CancelWaitingAsyncJobResponse>","errorExample":""}]',
        ],
    ],
    'endpoints' => [
        [
            'regionId' => 'cn-shanghai',
            'endpoint' => 'viapi.cn-shanghai.aliyuncs.com',
        ],
    ],
];