summaryrefslogtreecommitdiff
path: root/data/en_us/videoseg/2020-03-20/api-docs.php
blob: 298f745e7dd6db05535f1ae2f2ea2adf9d9f6754 (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
<?php return [
    'version' => '1.0',
    'info' => [
        'style' => 'RPC',
        'product' => 'videoseg',
        'version' => '2020-03-20',
    ],
    'directories' => [
        [
            'id' => 208339,
            'title' => null,
            'type' => 'directory',
            'children' => [
                'SegmentVideoBody',
            ],
        ],
        'GetAsyncJobResult',
    ],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'SegmentVideoBody' => [
            'methods' => [
                'post',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'deprecated' => false,
            'systemTags' => [],
            'parameters' => [
                [
                    'name' => 'VideoUrl',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/videoseg/SegmentVideoBody/SegmentVideoBody1.mp4',
                        'isFileTransferUrl' => true,
                        'required' => true,
                        'type' => 'string',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'properties' => [
                            'RequestId' => [
                                'description' => '',
                                'example' => '49E2CC28-ED1D-4CC5-854D-7D0AE2B20976',
                                'type' => 'string',
                            ],
                            'Data' => [
                                'description' => '',
                                'properties' => [
                                    'VideoUrl' => [
                                        'description' => '',
                                        'example' => 'http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-human-segmentation/D86DDFBC-B8ED-4780-9E6A-E5BA98D7CC9F.mp4?Expires=1584709406&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=Fx5HVxvRjAMIjWL2OvhTlOO4cC****',
                                        'type' => 'string',
                                    ],
                                ],
                                'type' => 'object',
                            ],
                            'Message' => [
                                'description' => '',
                                'example' => '',
                                'type' => 'string',
                            ],
                        ],
                        'type' => 'object',
                    ],
                ],
            ],
            'errorCodes' => [
                400 => [
                    [
                        'errorCode' => 'ParameterError',
                        'errorMessage' => 'The parameter is invalid. Please check again.',
                    ],
                ],
                403 => [
                    [
                        'errorCode' => 'AuthFailed',
                        'errorMessage' => 'An error occurred while performing authorization. Please check your RAM configuration.',
                    ],
                ],
                408 => [
                    [
                        'errorCode' => 'Timeout',
                        'errorMessage' => 'The request has timed out.',
                    ],
                ],
                503 => [
                    [
                        'errorCode' => 'ServiceUnavailable',
                        'errorMessage' => 'The service is unavailable.',
                    ],
                ],
            ],
            'responseDemo' => '[{"type":"json","example":"{\\n  \\"RequestId\\": \\"49E2CC28-ED1D-4CC5-854D-7D0AE2B20976\\",\\n  \\"Data\\": {\\n    \\"VideoUrl\\": \\"http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-human-segmentation/D86DDFBC-B8ED-4780-9E6A-E5BA98D7CC9F.mp4?Expires=1584709406&OSSAccessKeyId=LTAI****************&Signature=Fx5HVxvRjAMIjWL2OvhTlOO4cC****\\"\\n  },\\n  \\"Message\\": \\"该调用为异步调用,任务已提交成功,请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","errorExample":""},{"type":"xml","example":"<SegmentVideoBodyResponse>\\n    <RequestId>49E2CC28-ED1D-4CC5-854D-7D0AE2B20976</RequestId>\\n    <Message>该调用为异步调用,任务已提交成功,请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。</Message>\\n</SegmentVideoBodyResponse>","errorExample":""}]',
            'requestParamsDescription' => ' ',
            'responseParamsDescription' => ' ',
        ],
        'GetAsyncJobResult' => [
            'methods' => [
                'post',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'get',
            ],
            'parameters' => [
                [
                    'name' => 'JobId',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'example' => 'E75FE679-0303-4DD1-8252-1143B4FA8A27',
                        'required' => true,
                        'type' => 'string',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'description' => '1',
                        'properties' => [
                            'RequestId' => [
                                'description' => '',
                                'example' => '6BD843FB-E7B9-45B6-ADE1-9AB1FF450148',
                                'type' => 'string',
                            ],
                            'Data' => [
                                'description' => '',
                                'properties' => [
                                    'Status' => [
                                        'description' => '',
                                        'example' => 'PROCESS_SUCCESS',
                                        'type' => 'string',
                                    ],
                                    'ErrorMessage' => [
                                        'description' => '',
                                        'example' => 'paramsIllegal',
                                        'type' => 'string',
                                    ],
                                    'Result' => [
                                        'description' => '',
                                        'example' => '{\\"VideoUrl\\":\\"http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/film-summary/49E2CC28-ED1D-4CC5-854D-7D0AE2B20976_rf8mv0.mp4?Expires=1585111875&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=7uE0ppt6uwkdwAFz73PPZN4KG7****\\"}',
                                        'type' => 'string',
                                    ],
                                    'ErrorCode' => [
                                        'description' => '',
                                        'example' => 'InvalidParameter',
                                        'type' => 'string',
                                    ],
                                    'JobId' => [
                                        'description' => '',
                                        'example' => '49E2CC28-ED1D-4CC5-854D-7D0AE2B20976',
                                        'type' => 'string',
                                    ],
                                ],
                                'type' => 'object',
                            ],
                        ],
                        'type' => 'object',
                    ],
                ],
            ],
            'errorCodes' => [
                400 => [
                    [
                        'errorCode' => 'ParameterError',
                        'errorMessage' => 'The parameter is invalid. Please check again.',
                    ],
                ],
                403 => [
                    [
                        'errorCode' => 'AuthFailed',
                        'errorMessage' => 'An error occurred while performing authorization. Please check your RAM configuration.',
                    ],
                ],
                408 => [
                    [
                        'errorCode' => 'Timeout',
                        'errorMessage' => 'The request has timed out.',
                    ],
                ],
                503 => [
                    [
                        'errorCode' => 'ServiceUnavailable',
                        'errorMessage' => 'The service is unavailable.',
                    ],
                ],
            ],
            'responseDemo' => '[{"type":"json","example":"{\\n  \\"RequestId\\": \\"6BD843FB-E7B9-45B6-ADE1-9AB1FF450148\\",\\n  \\"Data\\": {\\n    \\"Status\\": \\"PROCESS_SUCCESS\\",\\n    \\"ErrorMessage\\": \\"paramsIllegal\\",\\n    \\"Result\\": \\"{\\\\\\\\\\\\\\"VideoUrl\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/film-summary/49E2CC28-ED1D-4CC5-854D-7D0AE2B20976_rf8mv0.mp4?Expires=1585111875&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=7uE0ppt6uwkdwAFz73PPZN4KG7****\\\\\\\\\\\\\\"}\\",\\n    \\"ErrorCode\\": \\"InvalidParameter\\",\\n    \\"JobId\\": \\"49E2CC28-ED1D-4CC5-854D-7D0AE2B20976\\"\\n  }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>6BD843FB-E7B9-45B6-ADE1-9AB1FF450148</RequestId>\\n<Data>\\n    <Status>PROCESS_SUCCESS</Status>\\n    <JobId>9CDE688A-8FC8-4B8D-8C34-1C3490703F23</JobId>\\n    <Result>{\\"VideoUrl\\":\\"http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-human-segmentation/9CDE688A-8FC8-4B8D-8C34-1C3490703F23.mp4?Expires=1585193584&amp;OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&amp;Signature=z6DQV%2F14CFvammxkgXLcYm0wsW****\\"}</Result>\\n</Data>","errorExample":""}]',
            'requestParamsDescription' => ' ',
            'responseParamsDescription' => ' ',
        ],
    ],
    'endpoints' => [
        [
            'regionId' => 'cn-shanghai',
            'endpoint' => 'videoseg.cn-shanghai.aliyuncs.com',
        ],
    ],
];