diff options
Diffstat (limited to 'data/zh_cn/videoseg')
| -rw-r--r-- | data/zh_cn/videoseg/2020-03-20/api-docs.php | 440 |
1 files changed, 250 insertions, 190 deletions
diff --git a/data/zh_cn/videoseg/2020-03-20/api-docs.php b/data/zh_cn/videoseg/2020-03-20/api-docs.php index 127bafb..f5385fd 100644 --- a/data/zh_cn/videoseg/2020-03-20/api-docs.php +++ b/data/zh_cn/videoseg/2020-03-20/api-docs.php @@ -1,18 +1,12 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'videoseg', - 'version' => '2020-03-20', - ], + 'info' => ['style' => 'RPC', 'product' => 'videoseg', 'version' => '2020-03-20'], 'directories' => [ [ - 'id' => 208339, - 'title' => 'API操作', + 'children' => ['SegmentVideoBody'], 'type' => 'directory', - 'children' => [ - 'SegmentVideoBody', - ], + 'title' => 'API操作', + 'id' => 434491, ], 'GetAsyncJobResult', ], @@ -20,14 +14,106 @@ 'schemas' => [], ], 'apis' => [ - 'SegmentVideoBody' => [ - 'methods' => [ - 'post', + 'GetAsyncJobResult' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => ['description' => '异步接口返回的RequestId，输入后可以查询异步接口的真实请求结果。', 'type' => 'string', 'required' => true, 'example' => 'E75FE679-0303-4DD1-8252-1143B4FA8A27'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '1', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6BD843FB-E7B9-45B6-ADE1-9AB1FF450148'], + 'Data' => [ + 'description' => '返回的数据内容。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '异步任务状态。包括：'."\n" + ."\n" + .'- QUEUING：任务排队中'."\n" + ."\n" + .'- PROCESSING：异步处理中'."\n" + ."\n" + .'- PROCESS_SUCCESS：处理成功'."\n" + ."\n" + .'- PROCESS_FAILED：处理失败'."\n" + ."\n" + .'- TIMEOUT_FAILED：任务超时未处理完成'."\n" + ."\n" + .'- LIMIT_RETRY_FAILED：超过最大重试次数', 'type' => 'string', 'example' => 'PROCESS_SUCCESS'], + 'ErrorMessage' => ['description' => '异步任务错误码信息。', 'type' => 'string', 'example' => 'paramsIllegal'], + 'Result' => ['description' => '异步任务返回的真实请求结果。', 'type' => 'string', '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****\\"}'], + 'ErrorCode' => ['description' => '异步任务错误码。', 'type' => 'string', 'example' => 'InvalidParameter'], + 'JobId' => ['description' => '异步任务ID。', 'type' => 'string', 'example' => '49E2CC28-ED1D-4CC5-854D-7D0AE2B20976'], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterError', 'errorMessage' => 'The parameter is invalid. Please check again.', 'description' => '参数错误，请检查参数值'], + ], + 403 => [ + ['errorCode' => 'AuthFailed', 'errorMessage' => 'An error occurred while performing authorization. Please check your RAM configuration.', 'description' => '授权失败，请检查RAM权限配置，操作流程可参考https://help.aliyun.com/document_detail/145025.htm。'], + ], + 408 => [ + ['errorCode' => 'Timeout', 'errorMessage' => 'The request has timed out.', 'description' => '请求超时，请稍后重试。如重试后还报错请通过钉钉搜索群号23109592，加入阿里云视觉智能开放平台咨询群，与平台取得联系。'], + ], + 503 => [ + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The service is unavailable.', 'description' => '算法服务报错，请稍后重试。如重试后还报错请通过钉钉搜索群号23109592，加入阿里云视觉智能开放平台咨询群，与平台取得联系。 '], + ], ], - 'schemes' => [ - 'http', - 'https', + '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&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=z6DQV%2F14CFvammxkgXLcYm0wsW****\\"}</Result>\\n</Data>","errorExample":""}]', + 'title' => '查询异步任务结果', + 'summary' => '本文介绍查询异步任务结果GetAsyncJobResult的语法及示例。', + 'description' => '## 功能描述'."\n" + .'异步接口调用API接口后，返回的并不是真正的请求结果，您需要保存返回结果中的RequestId，然后调用GetAsyncJobResult来获取真正的请求结果。'."\n" + ."\n" + .'> - 异步任务的文件有过期时间，有效期是30分钟。如需长期使用，需及时将文件下载到本地服务器或存储在OSS中。有关OSS更多操作信息，请参见[上传文件](~~31886~~)。'."\n" + .'- 阿里云视觉智能开放平台视觉AI能力API接入、接口使用或问题咨询等，请通过钉钉群（23109592）加入阿里云视觉智能开放平台咨询群联系我们。'."\n" + ."\n\n" + .'当前视频分割类目所有接口均为异步接口，均需要调用GetAsyncJobResult来获取真实的请求结果。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '## SDK参考'."\n" + .'阿里云视觉AI能力推荐使用SDK调用，支持多种编程语言，文件参数通过SDK调用可支持本地文件及任意URL，具体可参见[SDK总览](~~145033~~)。', + 'extraInfo' => '## Result反序列化'."\n" + .'将上面Result反序列化展示如下。'."\n" + .'```'."\n" + .'{'."\n" + .' "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&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=z6DQV%2F14CFvammxkgXLcYm0wsW****"'."\n" + .'}'."\n" + .'```'."\n" + ."\n\n" + .'## 错误码'."\n" + .'关于查询异步任务结果的错误码，详情请参见[常见错误码](~~159108~~)。'."\n" + ."\n" + .'## 安全声明'."\n" + .'- 请确保上传的图片或文件来源符合相应的法律法规。'."\n" + .'- 通过体验调试上传的临时文件有效期为1小时，在24小时后会被系统自动清理删除。', + 'changeSet' => [ + ['createdAt' => '2022-04-24T08:15:33.000Z', 'description' => '错误码发生变更'], ], + ], + 'SegmentVideoBody' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -40,13 +126,7 @@ [ 'name' => 'VideoUrl', 'in' => 'formData', - 'schema' => [ - 'description' => '视频URL地址。推荐使用上海地域的OSS链接，对于文件在本地或者非上海地域OSS链接的情况，请参见[文件URL处理](~~155645~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/videoseg/SegmentVideoBody/SegmentVideoBody1.mp4', - 'isFileTransferUrl' => true, - ], + 'schema' => ['description' => '视频URL地址。推荐使用上海地域的OSS链接，对于文件在本地或者非上海地域OSS链接的情况，请参见[文件URL处理](~~155645~~)。', 'type' => 'string', 'required' => true, 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/videoseg/SegmentVideoBody/SegmentVideoBody1.mp4', 'isFileTransferUrl' => true], ], ], 'responses' => [ @@ -54,56 +134,33 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '49E2CC28-ED1D-4CC5-854D-7D0AE2B20976', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '49E2CC28-ED1D-4CC5-854D-7D0AE2B20976'], 'Data' => [ 'description' => '返回的数据内容。该数据需要在异步任务执行成功后，通过调用[GetAsyncJobResult](~~607824~~)接口，对其Result字段进行JSON反序列化之后得到。', 'type' => 'object', 'properties' => [ - 'VideoUrl' => [ - 'description' => '输出结果图像URL地址。'."\n" - .'> 该URL地址为临时地址，有效期为30分钟，过期后将无法访问。若需要长时间或者永久保存文件，请在30分钟内访问URL地址，下载文件转存到自己的OSS或者其他存储空间。', - 'type' => 'string', - '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=LTAI****************&Signature=Fx5HVxvRjAMIjWL2OvhTlOO4cC****', - ], + 'VideoUrl' => ['description' => '输出结果图像URL地址。'."\n" + .'> 该URL地址为临时地址，有效期为30分钟，过期后将无法访问。若需要长时间或者永久保存文件，请在30分钟内访问URL地址，下载文件转存到自己的OSS或者其他存储空间。', 'type' => 'string', '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=LTAI****************&Signature=Fx5HVxvRjAMIjWL2OvhTlOO4cC****'], ], ], - 'Message' => [ - 'description' => '提交异步任务后的提示信息。', - 'type' => 'string', - 'example' => '该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。', - ], + 'Message' => ['description' => '提交异步任务后的提示信息。', 'type' => 'string', 'example' => '该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterError', - 'errorMessage' => 'The parameter is invalid. Please check again.', - ], + ['errorCode' => 'ParameterError', 'errorMessage' => 'The parameter is invalid. Please check again.', 'description' => '参数错误，请检查参数值'], ], 403 => [ - [ - 'errorCode' => 'AuthFailed', - 'errorMessage' => 'An error occurred while performing authorization. Please check your RAM configuration.', - ], + ['errorCode' => 'AuthFailed', 'errorMessage' => 'An error occurred while performing authorization. Please check your RAM configuration.', 'description' => '授权失败，请检查RAM权限配置，操作流程可参考https://help.aliyun.com/document_detail/145025.htm。'], ], 408 => [ - [ - 'errorCode' => 'Timeout', - 'errorMessage' => 'The request has timed out.', - ], + ['errorCode' => 'Timeout', 'errorMessage' => 'The request has timed out.', 'description' => '请求超时，请稍后重试。如重试后还报错请通过钉钉搜索群号23109592，加入阿里云视觉智能开放平台咨询群，与平台取得联系。'], ], 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'The service is unavailable.', - ], + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The service is unavailable.', 'description' => '算法服务报错，请稍后重试。如重试后还报错请通过钉钉搜索群号23109592，加入阿里云视觉智能开放平台咨询群，与平台取得联系。 '], ], ], '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":""}]', @@ -163,154 +220,157 @@ ."\n" .'## 示例代码'."\n" .'该能力常用语言的示例代码，请参见[视频人像分割示例代码](~~610206~~)，常用语言查询异步任务结果的示例代码，请参见[查询异步任务结果示例代码](~~607974~~)。', - ], - 'GetAsyncJobResult' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2022-10-17T02:07:53.000Z', 'description' => '响应参数发生变更'], ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SegmentVideoBody'], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'JobId', - 'in' => 'formData', - 'schema' => [ - 'description' => '异步接口返回的RequestId，输入后可以查询异步接口的真实请求结果。', - 'type' => 'string', - 'required' => true, - 'example' => 'E75FE679-0303-4DD1-8252-1143B4FA8A27', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '1', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '6BD843FB-E7B9-45B6-ADE1-9AB1FF450148', - ], - 'Data' => [ - 'description' => '返回的数据内容。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '异步任务状态。包括：'."\n" - ."\n" - .'- QUEUING：任务排队中'."\n" - ."\n" - .'- PROCESSING：异步处理中'."\n" - ."\n" - .'- PROCESS_SUCCESS：处理成功'."\n" - ."\n" - .'- PROCESS_FAILED：处理失败'."\n" - ."\n" - .'- TIMEOUT_FAILED：任务超时未处理完成'."\n" - ."\n" - .'- LIMIT_RETRY_FAILED：超过最大重试次数', - 'type' => 'string', - 'example' => 'PROCESS_SUCCESS', - ], - 'ErrorMessage' => [ - 'description' => '异步任务错误码信息。', - 'type' => 'string', - 'example' => 'paramsIllegal', - ], - 'Result' => [ - 'description' => '异步任务返回的真实请求结果。', - 'type' => 'string', - '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****\\"}', - ], - 'ErrorCode' => [ - 'description' => '异步任务错误码。', - 'type' => 'string', - 'example' => 'InvalidParameter', - ], - 'JobId' => [ - 'description' => '异步任务ID。', - 'type' => 'string', - 'example' => '49E2CC28-ED1D-4CC5-854D-7D0AE2B20976', - ], - ], - ], + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videoseg:SegmentVideoBody', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - '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.', + ], + ], + 'endpoints' => [ + ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'videoseg.cn-shanghai.aliyuncs.com', 'endpoint' => 'videoseg.cn-shanghai.aliyuncs.com', 'vpc' => 'videoseg-vpc.cn-shanghai.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'AuthFailed', 'message' => 'An error occurred while performing authorization. Please check your RAM configuration.', 'http_code' => 403, 'description' => '授权失败，请检查RAM权限配置，操作流程可参考https://help.aliyun.com/document_detail/145025.htm。'], + ['code' => 'EntityNotExist.Role', 'message' => '没有Ram权限，请联系主账号给你添加AliyunVIAPIFullAccess权限，操作流程可参考https://help.aliyun.com/document_detail/145025.htm', 'http_code' => 403, 'description' => '没有Ram权限，请联系主账号给你添加AliyunVIAPIFullAccess权限，操作流程可参考https://help.aliyun.com/document_detail/145025.htm'], + ['code' => 'IllegalUrlParameter', 'message' => 'Url不合法，请检查url能否正常打开', 'http_code' => 400, 'description' => 'Url不合法，请检查url能否正常打开 - 非上海OSS图片链接请参考：https://help.aliyun.com/document\\_detail/155645.html '], + ['code' => 'InternalError', 'message' => 'An error occurred to the algorithm service.', 'http_code' => 500, 'description' => '算法服务报错，请稍后重试。如重试后还报错请通过钉钉搜索群号23109592，加入阿里云视觉智能开放平台咨询群，与平台取得联系。 '], + ['code' => 'InternalError.Algo', 'message' => 'An algorithm error occurred.', 'http_code' => 500, 'description' => '算法服务报错，请稍后重试。如重试后还报错请通过钉钉搜索群号23109592，加入阿里云视觉智能开放平台咨询群，与平台取得联系。 '], + ['code' => 'InternalError.Busy', 'message' => 'Server busy.', 'http_code' => 500, 'description' => '后台服务忙，请稍后重试。如重试后还报错请通过钉钉搜索群号23109592，加入阿里云视觉智能开放平台咨询群，与平台取得联系。'], + ['code' => 'InternalError.Decode', 'message' => 'Failed to decode the image.', 'http_code' => 500, 'description' => '图像解码失败，请通过钉钉搜索群号23109592，加入阿里云视觉智能开放平台咨询群，与平台取得联系。'], + ['code' => 'InternalError.Env', 'message' => 'Failed to initilize the environment.', 'http_code' => 500, 'description' => '初始化环境失败。请稍后重试。如重试后还报错请通过钉钉搜索群号23109592，加入阿里云视觉智能开放平台咨询群，与平台取得联系。'], + ['code' => 'InternalError.Model', 'message' => 'Failed to load the model.', 'http_code' => 500, 'description' => '模型加载错误，请通过钉钉搜索群号23109592，加入阿里云视觉智能开放平台咨询群，与平台取得联系。'], + ['code' => 'InternalError.Process', 'message' => 'An error occurred during inference.', 'http_code' => 500, 'description' => '推理过程异常，请通过钉钉搜索群号23109592，加入阿里云视觉智能开放平台咨询群，与平台取得联系。'], + ['code' => 'InternalError.Remote', 'message' => 'The request processing has failed due to some unknown error.', 'http_code' => 500, 'description' => '远程服务不可用，请稍后重试。如重试后还报错请通过钉钉搜索群号23109592，加入阿里云视觉智能开放平台咨询群，与平台取得联系。'], + ['code' => 'InternalError.Server', 'message' => 'The request processing has failed due to some unknown error.', 'http_code' => 500, 'description' => '系统内部错误，请稍后重试。如重试后还报错请通过钉钉搜索群号23109592，加入阿里云视觉智能开放平台咨询群，与平台取得联系。'], + ['code' => 'InternalError.Timeout', 'message' => '算法服务报错，请稍后重试', 'http_code' => 500, 'description' => '算法服务报错，请稍后重试。如重试后还报错请通过钉钉搜索群号23109592，加入阿里云视觉智能开放平台咨询群，与平台取得联系。 '], + ['code' => 'InternalServerError', 'message' => 'A server error occurred while processing your request.', 'http_code' => 500, 'description' => '系统内部错误，请稍后重试。如重试后还报错请通过钉钉搜索群号23109592，加入阿里云视觉智能开放平台咨询群，与平台取得联系。'], + ['code' => 'InvalidAccessKeyId.Inactive', 'message' => 'AccessKeyId非法，请检查AccessKeyId是否被禁用，或者AccessKeyId和AccessKeySecret是否填写正确。', 'http_code' => 400, 'description' => 'AccessKeyId非法，请检查AccessKeyId是否被禁用，或者AccessKeyId和AccessKeySecret是否填写正确。'], + ['code' => 'InvalidAccessKeyId.NotFound', 'message' => 'AccessKeyId未找到，请检查AccessKeyId和AccessKeySecret是否填写正确。', 'http_code' => 400, 'description' => 'AccessKeyId未找到，请检查AccessKeyId和AccessKeySecret是否填写正确。请参考文档：https://help.aliyun.com/document\\_detail/175144.html，进入控制台，找到对应的AccessKeyId和AccessKeySecret。如果AccessKeySecret未保存，主账号可以通过查看Secret找回，子账号无法找回，可以新建一个AccessKey。'], + ['code' => 'InvalidAccessKeySecret', 'message' => 'AccessKeyId或AccessKeySecret填写错误，请检查AccessKeyId和AccessKeySecret是否填写正确。', 'http_code' => 400, 'description' => 'AccessKeyId或AccessKeySecret填写错误，请检查AccessKeyId和AccessKeySecret是否填写正确。请参考文档：https://help.aliyun.com/document\\_detail/175144.html，进入控制台，找到对应的AccessKeyId和AccessKeySecret。如果AccessKeySecret未保存，主账号可以通过查看Secret找回，子账号无法找回，可以新建一个AccessKey。 '], + ['code' => 'InvalidAction.NotFound', 'message' => '能力未找到，请检查类目与能力是否匹配，检查访问域名与能力是否匹配，关于访问域名可参考：https://help.aliyun.com/document_detail/143103.htm。SDK接入请参考：https://help.aliyun.com/document_detail/145033.html，选择合适编程语言根据实例代码作相关修改进行接入。', 'http_code' => 400, 'description' => '能力未找到，请检查类目与能力是否匹配，检查访问域名与能力是否匹配，关于访问域名可参考：https://help.aliyun.com/document_detail/143103.htm。SDK接入请参考：https://help.aliyun.com/document_detail/145033.html，选择合适编程语言根据实例代码作相关修改进行接入。'], + ['code' => 'InvalidApi.ForbiddenInvoke', 'message' => '调用受限，请检查您调用的能力是否为受限能力，受限能力需要在控制台https://vision.console.aliyun.com/找到相应能力申请经过审批之后才能调用。如非上述情况，请检查账号是否欠费', 'http_code' => 400, 'description' => '调用受限，请检查您调用的能力是否为受限能力，受限能力需要在控制台https://vision.console.aliyun.com/找到相应能力申请经过审批之后才能调用。如非上述情况，请检查账号是否欠费'], + ['code' => 'InvalidApi.NotPurchase', 'message' => '产品未开通，请开通产品：https://common-buy.aliyun.com/?commodityCode=viapi_videoseg_public_cn#/open', 'http_code' => 400, 'description' => '产品未开通，请开通产品：https://common-buy.aliyun.com/?commodityCode=viapi_videoseg_public_cn#/open'], + ['code' => 'InvalidApi.OutOfService', 'message' => '产品未开通，请开通产品：https://common-buy.aliyun.com/?commodityCode=viapi_videoseg_public_cn#/open', 'http_code' => 403, 'description' => '产品未开通，请开通产品：https://common-buy.aliyun.com/?commodityCode=viapi_videoseg_public_cn#/open'], + ['code' => 'InvalidFile.Category', 'message' => 'The file content category does not meet requirements.', 'http_code' => 400, 'description' => '文件内容类目不符合要求。'], + ['code' => 'InvalidFile.Content', 'message' => 'The content format of the image or video is invalid.', 'http_code' => 400, 'description' => '请参考算法文档检查文件内容，更换包含符合算法要求的 '], + ['code' => 'InvalidFile.Decode', 'message' => 'Failed to decode the file.', 'http_code' => 400, 'description' => '请检查文件是否能够正常打开'], + ['code' => 'InvalidFile.Download', 'message' => 'Failed to download the file.', 'http_code' => 400, 'description' => '文件无法下载，请检查链接是否可访问和本地网络情况 - 非上海OSS图片链接请参考：https://help.aliyun.com/document_detail/155645.html。请检查OSS链接是否过期等。'], + ['code' => 'InvalidFile.Region', 'message' => 'The URL format of the file is invalid.', 'http_code' => 400, 'description' => '文件链接地域不对，非上海OSS文件链接请参考：https://help.aliyun.com/document_detail/155645.html'], + ['code' => 'InvalidFile.Resolution', 'message' => 'The resolution of the image or video is invalid.', 'http_code' => 400, 'description' => '文件分辨率超出限制，请检查文件分辨率和内容，修改文件分辨率后重试 '], + ['code' => 'InvalidFile.Type', 'message' => 'The file type of the image or video is invalid.', 'http_code' => 400, 'description' => '文件类型错误，请检查文件类型 - 请参考算法API文档，使用算法支持的文件类型。阿里云视觉智能开放平台能够读取文件并获取真实的文件类型，不是通过文件后缀名进行类型判断，只看文件后缀名是无效的，关于更多文件类型判断和处理信息可参考：https://help.aliyun.com/document_detail/470250.html'], + ['code' => 'InvalidFile.Unsafe', 'message' => 'Risky file URL.', 'http_code' => 400, 'description' => '不安全的文件链接，请确保上传的图片或文件来源符合相应的法律法规。'], + ['code' => 'InvalidFile.URL', 'message' => 'The URL format of the file is invalid.', 'http_code' => 400, 'description' => '文件无法下载，请检查链接是否可访问和本地网络情况 - 非上海OSS图片链接请参考：https://help.aliyun.com/document_detail/155645.html。请检查OSS链接是否过期等。'], + ['code' => 'InvalidImage.Content', 'message' => '请参考算法文档检查图片内容，更换包含符合算法要求的', 'http_code' => 400, 'description' => '请参考算法文档检查图片内容，更换包含符合算法要求的'], + ['code' => 'InvalidImage.Decode', 'message' => '请检查图片是否能够正常打开', 'http_code' => 400, 'description' => '请检查图片是否能够正常打开'], + ['code' => 'InvalidImage.Download', 'message' => '图片无法下载，请检查链接是否可访问和本地网络情况 - 非上海OSS图片链接请参考：https://help.aliyun.com/document_detail/155645.html', 'http_code' => 400, 'description' => '图片无法下载，请检查链接是否可访问和本地网络情况 - 非上海OSS图片链接请参考：https://help.aliyun.com/document_detail/155645.html'], + ['code' => 'InvalidImage.NotFoundFace', 'message' => '图像中没找到人脸，请检查您的图像中是否包含人脸或人脸太小', 'http_code' => 400, 'description' => '图像中没找到人脸，请检查您的图像中是否包含人脸或人脸太小'], + ['code' => 'InvalidImage.REGION', 'message' => '图片链接地域不对，非上海OSS图片链接请参考：https://help.aliyun.com/document_detail/155645.html', 'http_code' => 400, 'description' => '图片链接地域不对，非上海OSS图片链接请参考：https://help.aliyun.com/document_detail/155645.html'], + ['code' => 'InvalidImage.Resolution', 'message' => '文件分辨率超出限制，请检查文件分辨率和内容，修改文件分辨率后重试', 'http_code' => 400, 'description' => '文件分辨率超出限制，请检查文件分辨率和内容，修改文件分辨率后重试'], + ['code' => 'InvalidImage.Timeout', 'message' => '图片下载超时，请检查链接是否可访问和本地网络情况', 'http_code' => 400, 'description' => '图片无下载超时，请检查链接是否可访问和本地网络情况 - 非上海OSS图片链接请参考：https://help.aliyun.com/document\\_detail/155645.html。请检查OSS链接是否过期等。 '], + ['code' => 'InvalidImage.Type', 'message' => '图片类型错误，请检查图片类型 - 请参考算法API文档，使用算法支持的图片类型', 'http_code' => 400, 'description' => '图片类型错误，请检查图片类型 - 请参考算法API文档，使用算法支持的图片类型'], + ['code' => 'InvalidImage.URL', 'message' => 'The image URL is invalid.', 'http_code' => 400, 'description' => '图片链接非法，请检查图片链接是否可访问 - 非上海OSS图片链接请参考：https://help.aliyun.com/document_detail/155645.html。对于上海oss链接请使用标准的oss域名，目前暂不支持绑定cdn域名和自定义域名。'], + ['code' => 'InvalidImageType', 'message' => 'Invalid image type.', 'http_code' => 400, 'description' => '无效的图片类型。请参考调用能力的文档输入文档中支持的图片类型。'], + ['code' => 'InvalidParameter', 'message' => 'Invalid parameter value.', 'http_code' => 400, 'description' => '参数错误，请根据算法API文档和报错Message检查参数值。是否参数值前后多了空格或者其他特殊字符等。 '], + ['code' => 'InvalidParameter.BadRequest', 'message' => 'The request parameter or the data has an error.', 'http_code' => 400, 'description' => '参数错误，请根据算法API文档和报错Message检查参数值。是否参数值前后多了空格或者其他特殊字符等。 '], + ['code' => 'InvalidParameter.Format', 'message' => 'The entry format is incorrect.', 'http_code' => 400, 'description' => '入参格式错误，请参照文档检查入参格式。'], + ['code' => 'InvalidParameter.NotFound', 'message' => '参数错误，请根据算法API文档和报错Message检查参数值。是否参数值前后多了空格或者其他特殊字符等。', 'http_code' => 400, 'description' => '参数错误，请根据算法API文档和报错Message检查参数值。是否参数值前后多了空格或者其他特殊字符等。'], + ['code' => 'InvalidParameter.TooLarge', 'message' => '参数错误，文件大小超出限制，请参考算法API文档调整文件大小', 'http_code' => 400, 'description' => '参数错误，文件大小超出限制，请参考算法API文档调整文件大小'], + ['code' => 'InvalidRamRole', 'message' => '没有Ram权限，请联系主账号给你添加AliyunVIAPIFullAccess权限，操作流程可参考https://help.aliyun.com/document_detail/145025.htm', 'http_code' => 403, 'description' => '没有Ram权限，请联系主账号给你添加AliyunVIAPIFullAccess权限，操作流程可参考https://help.aliyun.com/document_detail/145025.htm'], + ['code' => 'InvalidResult', 'message' => '参数错误，请参考文档检查参数值，检查文件内容。请检查是否图片内容不完整或者太模糊等。', 'http_code' => 400, 'description' => '参数错误，请参考文档检查参数值，检查文件内容。请检查是否图片内容不完整或者太模糊等。'], + ['code' => 'InvalidTimeStamp.Expired', 'message' => 'The timestamp has expired. Please update the timestamp.', 'http_code' => 400, 'description' => '时间戳过期，请更新时间戳。可以参考https://help.aliyun.com/document\\_detail/144904.html文档计算请求签名。如果您的语言比较常用，推荐使用SDK进行调用，详情可参考：https://help.aliyun.com/document\\_detail/145033.html '], + ['code' => 'InvalidVersion', 'message' => 'Specified parameter Version is not valid', 'http_code' => 400, 'description' => '版本未找到，请检查SDK版本是否匹配，检查版本与类目和能力是否匹配，关于SDK版本可参考：https://help.aliyun.com/document_detail/145033.html'], + ['code' => 'MissingAccessKeyId', 'message' => 'AccessKeyId未填写，请检查AccessKeyId和AccessKeySecret是否填写正确。', 'http_code' => 400, 'description' => 'AccessKeyId未填写，请检查AccessKeyId和AccessKeySecret是否填写正确。请参考文档：https://help.aliyun.com/document\\_detail/175144.html，进入控制台，找到对应的AccessKeyId和AccessKeySecret。如果AccessKeySecret未保存，主账号可以通过查看Secret找回，子账号无法找回，可以新建一个AccessKey。 '], + ['code' => 'MissingFileURL', 'message' => 'FileURL is required for this operation.', 'http_code' => 400, 'description' => '缺少文件参数FileURL，该参数为文件URL地址，文件输入推荐使用华东2（上海）区域的OSS链接-非上海OSS文件链接请参考：'."\n" + .'https://help.aliyun.com/document_detail/155645.html'], + ['code' => 'MissingImageURL', 'message' => 'ImageURL is required for this operation.', 'http_code' => 400, 'description' => '缺少图像参数ImageURL，该参数为图片URL地址，文件输入推荐使用华东2（上海）区域的OSS链接-非上海OSS文件链接请参考：'."\n" + .'https://help.aliyun.com/document_detail/155645.html'], + ['code' => 'MissingLimit', 'message' => 'Limit is required for this operation', 'http_code' => 400, 'description' => '缺少Limit参数，该参数是接口必填参数。推荐使用对应类目的SDK进行调用：https://help.aliyun.com/document_detail/145033.html'], + ['code' => 'MissingParameter', 'message' => 'A required parameter is not specified.', 'http_code' => 400, 'description' => '参数缺失，请参考文档检查参数值'], + ['code' => 'MissingTasks', 'message' => 'Tasks is required for this operation.', 'http_code' => 400, 'description' => '缺少Tasks参数，该参数是接口必填参数。推荐使用对应类目的SDK进行调用：https://help.aliyun.com/document_detail/145033.html'], + ['code' => 'ParameterError', 'message' => 'The parameter is invalid. Please check again.', 'http_code' => 400, 'description' => '参数错误，请检查参数值'], + ['code' => 'ServiceUnavailable', 'message' => 'The service is unavailable.', 'http_code' => 503, 'description' => '算法服务报错，请稍后重试。如重试后还报错请通过钉钉搜索群号23109592，加入阿里云视觉智能开放平台咨询群，与平台取得联系。 '], + ['code' => 'SignatureDoesNotMatch', 'message' => '签名不正确，请重新计算签名。关于签名可参考文档：https://help.aliyun.com/document_detail/144904.html', 'http_code' => 400, 'description' => '签名不正确，请重新计算签名。可以参考https://help.aliyun.com/document\\_detail/144904.html文档计算请求签名。如果您的语言比较常用，推荐使用SDK进行调用，详情可参考：https://help.aliyun.com/document\\_detail/145033.html'], + ['code' => 'SignatureNonceUsed', 'message' => '签名已经被使用过，请重新计算签名。关于签名可参考文档：https://help.aliyun.com/document_detail/144904.html', 'http_code' => 400, 'description' => '签名已经被使用过，请重新计算签名。可以参考https://help.aliyun.com/document\\_detail/144904.html文档计算请求签名。如果您的语言比较常用，推荐使用SDK进行调用，详情可参考：https://help.aliyun.com/document\\_detail/145033.html '], + ['code' => 'Throttling', 'message' => 'The request was denied due to QPS limits.', 'http_code' => 400, 'description' => '调用被限流，请稍后再调用，或者购买QPS提升调用限制。关于QPS限制提升流程和处理请参考：https://help.aliyun.com/document_detail/604963.html。如果因业务需求需要更多QPS可通过钉钉搜索群号23109592，加入阿里云视觉智能开放平台咨询群与平台取得联系。'], + ['code' => 'Throttling.User', 'message' => 'The request was denied due to QPS limits.', 'http_code' => 400, 'description' => '调用被限流，请稍后再调用，或者购买QPS提升调用限制。关于QPS限制提升流程和处理请参考：https://help.aliyun.com/document_detail/604963.html。如果因业务需求需要更多QPS可通过钉钉搜索群号23109592，加入阿里云视觉智能开放平台咨询群与平台取得联系。'], + ['code' => 'Timeout', 'message' => 'The request has timed out.', 'http_code' => 408, 'description' => '请求超时，请稍后重试。如重试后还报错请通过钉钉搜索群号23109592，加入阿里云视觉智能开放平台咨询群，与平台取得联系。'], + ['code' => 'Unauthorized', 'message' => '没有Ram权限，请联系主账号给你添加AliyunVIAPIFullAccess权限，操作流程可参考https://help.aliyun.com/document_detail/145025.htm', 'http_code' => 400, 'description' => '没有Ram权限，请联系主账号给你添加AliyunVIAPIFullAccess权限，操作流程可参考https://help.aliyun.com/document_detail/145025.htm'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'SegmentGreenScreenVideo'], + ['description' => '响应参数发生变更', 'api' => 'SegmentHalfBody'], + ['description' => '响应参数发生变更', 'api' => 'SegmentVideoBody'], + ], + 'createdAt' => '2022-10-17T02:08:02.000Z', + 'description' => '修改异步任务Message为可见', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'GetAsyncJobResult'], + ], + 'createdAt' => '2022-04-24T08:16:35.000Z', + 'description' => '调整GetAsyncJobResult单用户调用频率', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAsyncJobResult'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SegmentVideoBody'], + ], + ], + 'ram' => [ + 'productCode' => 'VisualIntelligenceAPI', + 'productName' => '视觉智能开放平台', + 'ramCodes' => ['viapi-imageseg', 'viapi-imageaudit', 'viapi-ocr', 'viapi-objectdet', 'viapi-imageenhan', 'viapi-videorecog', 'viapi-imageprocess', 'viapi', 'viapi-ekyc', 'viapi-imgsearch', 'viapi-goodstech', 'viapi-facebody', 'viapi-threedvision', 'viapi-videoenhan', 'viapi-imagerecog', 'viapi-videoseg', 'viapi-regen', 'viapi-aigen'], + 'ramLevel' => '服务级', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'GetAsyncJobResult', + 'description' => '查询异步任务结果', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'viapi-videoseg:GetAsyncJobResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'The service is unavailable.', + ], + [ + 'apiName' => 'SegmentVideoBody', + 'description' => '视频人像分割', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi-videoseg:SegmentVideoBody', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - '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&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=z6DQV%2F14CFvammxkgXLcYm0wsW****\\"}</Result>\\n</Data>","errorExample":""}]', - 'title' => '查询异步任务结果', - 'summary' => '本文介绍查询异步任务结果GetAsyncJobResult的语法及示例。', - 'description' => '## 功能描述'."\n" - .'异步接口调用API接口后，返回的并不是真正的请求结果，您需要保存返回结果中的RequestId，然后调用GetAsyncJobResult来获取真正的请求结果。'."\n" - ."\n" - .'> - 异步任务的文件有过期时间，有效期是30分钟。如需长期使用，需及时将文件下载到本地服务器或存储在OSS中。有关OSS更多操作信息，请参见[上传文件](~~31886~~)。'."\n" - .'- 阿里云视觉智能开放平台视觉AI能力API接入、接口使用或问题咨询等，请通过钉钉群（23109592）加入阿里云视觉智能开放平台咨询群联系我们。'."\n" - ."\n\n" - .'当前视频分割类目所有接口均为异步接口，均需要调用GetAsyncJobResult来获取真实的请求结果。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => '## SDK参考'."\n" - .'阿里云视觉AI能力推荐使用SDK调用，支持多种编程语言，文件参数通过SDK调用可支持本地文件及任意URL，具体可参见[SDK总览](~~145033~~)。', - 'extraInfo' => '## Result反序列化'."\n" - .'将上面Result反序列化展示如下。'."\n" - .'```'."\n" - .'{'."\n" - .' "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&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=z6DQV%2F14CFvammxkgXLcYm0wsW****"'."\n" - .'}'."\n" - .'```'."\n" - ."\n\n" - .'## 错误码'."\n" - .'关于查询异步任务结果的错误码，详情请参见[常见错误码](~~159108~~)。'."\n" - ."\n" - .'## 安全声明'."\n" - .'- 请确保上传的图片或文件来源符合相应的法律法规。'."\n" - .'- 通过体验调试上传的临时文件有效期为1小时，在24小时后会被系统自动清理删除。', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'videoseg.cn-shanghai.aliyuncs.com', ], + 'resourceTypes' => [], ], ]; |