diff options
Diffstat (limited to 'data/en_us/viapi')
| -rw-r--r-- | data/en_us/viapi/2021-09-30/api-docs.php | 797 | ||||
| -rw-r--r-- | data/en_us/viapi/2023-01-17/api-docs.php | 638 |
2 files changed, 509 insertions, 926 deletions
diff --git a/data/en_us/viapi/2021-09-30/api-docs.php b/data/en_us/viapi/2021-09-30/api-docs.php index e34c6f2..bb50834 100644 --- a/data/en_us/viapi/2021-09-30/api-docs.php +++ b/data/en_us/viapi/2021-09-30/api-docs.php @@ -1,31 +1,12 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'viapi', - 'version' => '2021-09-30', - ], + 'info' => ['style' => 'RPC', 'product' => 'viapi', 'version' => '2021-09-30'], 'directories' => [ [ 'id' => 0, 'title' => '其它', 'type' => 'directory', - 'children' => [ - 'EnableAiStoreUserTask', - 'ListAiStoreBuckets', - 'QueryAiStoreRegions', - 'UpdateAiStoreUserTask', - 'CreateAiStoreReceiveConfig', - 'CreateAiStoreBucket', - 'GetAiStoreUserTask', - 'CreateAiStoreUserTask', - 'DisableAiStoreUserTask', - 'QueryAiStoreApiTree', - 'DeleteAiStoreUserTask', - 'GetAiStoreReceiveConfig', - 'GetAiStoreUserTaskByName', - 'QueryAiStoreUserTaskPage', - ], + 'children' => ['EnableAiStoreUserTask', 'ListAiStoreBuckets', 'QueryAiStoreRegions', 'UpdateAiStoreUserTask', 'CreateAiStoreReceiveConfig', 'CreateAiStoreBucket', 'GetAiStoreUserTask', 'CreateAiStoreUserTask', 'DisableAiStoreUserTask', 'QueryAiStoreApiTree', 'DeleteAiStoreUserTask', 'GetAiStoreReceiveConfig', 'GetAiStoreUserTaskByName', 'QueryAiStoreUserTaskPage'], ], ], 'components' => [ @@ -34,14 +15,8 @@ 'apis' => [ 'EnableAiStoreUserTask' => [ 'summary' => '启用智能存储任务', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -54,18 +29,12 @@ [ 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true], ], [ 'name' => 'AistoreVersion', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -74,55 +43,32 @@ 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Data' => [ - 'type' => 'string', - ], + 'RequestId' => ['title' => 'Id of the request', 'type' => 'string'], + 'Data' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterError', - 'errorMessage' => 'The parameter is invalid. Please check again.', - ], + ['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.', - ], + ['errorCode' => 'AuthFailed', 'errorMessage' => 'An error occurred while performing authorization. Please check your RAM configuration.'], ], 408 => [ - [ - 'errorCode' => 'Timeout', - 'errorMessage' => 'The request has timed out.', - ], + ['errorCode' => 'Timeout', 'errorMessage' => 'The request has timed out.'], ], 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'The service is unavailable.', - ], + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The service is unavailable.'], ], ], 'responseDemo' => null, ], 'ListAiStoreBuckets' => [ 'summary' => '查询智能存储bucket列表', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -130,23 +76,17 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'Product', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], [ 'name' => 'ApiName', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -155,15 +95,10 @@ 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'type' => 'string', - ], + 'RequestId' => ['title' => 'Id of the request', 'type' => 'string'], 'Data' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], ], ], ], @@ -171,42 +106,24 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterError', - 'errorMessage' => 'The parameter is invalid. Please check again.', - ], + ['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.', - ], + ['errorCode' => 'AuthFailed', 'errorMessage' => 'An error occurred while performing authorization. Please check your RAM configuration.'], ], 408 => [ - [ - 'errorCode' => 'Timeout', - 'errorMessage' => 'The request has timed out.', - ], + ['errorCode' => 'Timeout', 'errorMessage' => 'The request has timed out.'], ], 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'The service is unavailable.', - ], + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The service is unavailable.'], ], ], 'responseDemo' => null, ], 'QueryAiStoreRegions' => [ 'summary' => '查询智能存储region列表', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -214,11 +131,7 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [], 'responses' => [ 200 => [ @@ -226,15 +139,10 @@ 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'type' => 'string', - ], + 'RequestId' => ['title' => 'Id of the request', 'type' => 'string'], 'Data' => [ 'type' => 'array', - 'items' => [ - '$ref' => '#/components/schemas/AiStoreUserTask', - ], + 'items' => ['$ref' => '#/components/schemas/AiStoreUserTask'], ], ], ], @@ -242,41 +150,23 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterError', - 'errorMessage' => 'The parameter is invalid. Please check again.', - ], + ['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.', - ], + ['errorCode' => 'AuthFailed', 'errorMessage' => 'An error occurred while performing authorization. Please check your RAM configuration.'], ], 408 => [ - [ - 'errorCode' => 'Timeout', - 'errorMessage' => 'The request has timed out.', - ], + ['errorCode' => 'Timeout', 'errorMessage' => 'The request has timed out.'], ], 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'The service is unavailable.', - ], + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The service is unavailable.'], ], ], ], 'UpdateAiStoreUserTask' => [ 'summary' => '更新智能存储任务', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -289,79 +179,52 @@ [ 'name' => 'Product', 'in' => 'formData', - 'schema' => [ - 'title' => '弃用', - 'type' => 'string', - ], + 'schema' => ['title' => '弃用', 'type' => 'string'], ], [ 'name' => 'ApiName', 'in' => 'formData', - 'schema' => [ - 'title' => '弃用', - 'type' => 'string', - ], + 'schema' => ['title' => '弃用', 'type' => 'string'], ], [ 'name' => 'BucketName', 'in' => 'formData', - 'schema' => [ - 'title' => '弃用', - 'type' => 'string', - ], + 'schema' => ['title' => '弃用', 'type' => 'string'], ], [ 'name' => 'BucketKeyPrefix', 'in' => 'formData', - 'schema' => [ - 'title' => '弃用', - 'type' => 'string', - ], + 'schema' => ['title' => '弃用', 'type' => 'string'], ], [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], [ 'name' => 'ParamInfo', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], [ 'name' => 'Remark', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], [ 'name' => 'ReceiveConfig', 'in' => 'formData', - 'schema' => [ - 'title' => '弃用', - 'type' => 'string', - ], + 'schema' => ['title' => '弃用', 'type' => 'string'], ], [ 'name' => 'Status', 'in' => 'formData', - 'schema' => [ - 'title' => '弃用', - 'type' => 'string', - ], + 'schema' => ['title' => '弃用', 'type' => 'string'], ], [ 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + 'schema' => ['type' => 'integer', 'format' => 'int64'], ], ], 'responses' => [ @@ -370,54 +233,31 @@ 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Data' => [ - 'type' => 'boolean', - ], + 'RequestId' => ['title' => 'Id of the request', 'type' => 'string'], + 'Data' => ['type' => 'boolean'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterError', - 'errorMessage' => 'The parameter is invalid. Please check again.', - ], + ['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.', - ], + ['errorCode' => 'AuthFailed', 'errorMessage' => 'An error occurred while performing authorization. Please check your RAM configuration.'], ], 408 => [ - [ - 'errorCode' => 'Timeout', - 'errorMessage' => 'The request has timed out.', - ], + ['errorCode' => 'Timeout', 'errorMessage' => 'The request has timed out.'], ], 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'The service is unavailable.', - ], + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The service is unavailable.'], ], ], ], 'CreateAiStoreReceiveConfig' => [ 'summary' => '创建用于接收消息的事件规则和接收目标配置', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -430,16 +270,12 @@ [ 'name' => 'Product', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], [ 'name' => 'ApiName', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -448,55 +284,32 @@ 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Data' => [ - '$ref' => '#/components/schemas/AiStoreReceiveConfig', - ], + 'RequestId' => ['title' => 'Id of the request', 'type' => 'string'], + 'Data' => ['$ref' => '#/components/schemas/AiStoreReceiveConfig'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterError', - 'errorMessage' => 'The parameter is invalid. Please check again.', - ], + ['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.', - ], + ['errorCode' => 'AuthFailed', 'errorMessage' => 'An error occurred while performing authorization. Please check your RAM configuration.'], ], 408 => [ - [ - 'errorCode' => 'Timeout', - 'errorMessage' => 'The request has timed out.', - ], + ['errorCode' => 'Timeout', 'errorMessage' => 'The request has timed out.'], ], 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'The service is unavailable.', - ], + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The service is unavailable.'], ], ], 'responseDemo' => null, ], 'CreateAiStoreBucket' => [ 'summary' => '创建智能存储bucket', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -509,9 +322,7 @@ [ 'name' => 'BucketName', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -520,55 +331,32 @@ 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Data' => [ - 'type' => 'string', - ], + 'RequestId' => ['title' => 'Id of the request', 'type' => 'string'], + 'Data' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterError', - 'errorMessage' => 'The parameter is invalid. Please check again.', - ], + ['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.', - ], + ['errorCode' => 'AuthFailed', 'errorMessage' => 'An error occurred while performing authorization. Please check your RAM configuration.'], ], 408 => [ - [ - 'errorCode' => 'Timeout', - 'errorMessage' => 'The request has timed out.', - ], + ['errorCode' => 'Timeout', 'errorMessage' => 'The request has timed out.'], ], 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'The service is unavailable.', - ], + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The service is unavailable.'], ], ], 'responseDemo' => null, ], 'GetAiStoreUserTask' => [ 'summary' => '获取智能存储任务详请', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -581,11 +369,7 @@ [ 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true], ], ], 'responses' => [ @@ -594,54 +378,31 @@ 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Data' => [ - '$ref' => '#/components/schemas/AiStoreUserTask', - ], + 'RequestId' => ['title' => 'Id of the request', 'type' => 'string'], + 'Data' => ['$ref' => '#/components/schemas/AiStoreUserTask'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterError', - 'errorMessage' => 'The parameter is invalid. Please check again.', - ], + ['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.', - ], + ['errorCode' => 'AuthFailed', 'errorMessage' => 'An error occurred while performing authorization. Please check your RAM configuration.'], ], 408 => [ - [ - 'errorCode' => 'Timeout', - 'errorMessage' => 'The request has timed out.', - ], + ['errorCode' => 'Timeout', 'errorMessage' => 'The request has timed out.'], ], 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'The service is unavailable.', - ], + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The service is unavailable.'], ], ], ], 'CreateAiStoreUserTask' => [ 'summary' => '创建智能存储任务', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -654,72 +415,52 @@ [ 'name' => 'Product', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], [ 'name' => 'ApiName', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], [ 'name' => 'BucketName', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], [ 'name' => 'BucketKeyPrefix', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], [ 'name' => 'ParamInfo', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], [ 'name' => 'Remark', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], [ 'name' => 'Status', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], [ 'name' => 'CreateConfig', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], [ 'name' => 'ReceiveConfig', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -728,56 +469,32 @@ 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Data' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + 'RequestId' => ['title' => 'Id of the request', 'type' => 'string'], + 'Data' => ['type' => 'integer', 'format' => 'int64'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterError', - 'errorMessage' => 'The parameter is invalid. Please check again.', - ], + ['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.', - ], + ['errorCode' => 'AuthFailed', 'errorMessage' => 'An error occurred while performing authorization. Please check your RAM configuration.'], ], 408 => [ - [ - 'errorCode' => 'Timeout', - 'errorMessage' => 'The request has timed out.', - ], + ['errorCode' => 'Timeout', 'errorMessage' => 'The request has timed out.'], ], 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'The service is unavailable.', - ], + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The service is unavailable.'], ], ], 'responseDemo' => null, ], 'DisableAiStoreUserTask' => [ 'summary' => '禁用智能存储任务', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -790,18 +507,12 @@ [ 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true], ], [ 'name' => 'AistoreVersion', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -810,55 +521,32 @@ 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Data' => [ - 'type' => 'boolean', - ], + 'RequestId' => ['title' => 'Id of the request', 'type' => 'string'], + 'Data' => ['type' => 'boolean'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterError', - 'errorMessage' => 'The parameter is invalid. Please check again.', - ], + ['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.', - ], + ['errorCode' => 'AuthFailed', 'errorMessage' => 'An error occurred while performing authorization. Please check your RAM configuration.'], ], 408 => [ - [ - 'errorCode' => 'Timeout', - 'errorMessage' => 'The request has timed out.', - ], + ['errorCode' => 'Timeout', 'errorMessage' => 'The request has timed out.'], ], 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'The service is unavailable.', - ], + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The service is unavailable.'], ], ], 'responseDemo' => null, ], 'QueryAiStoreApiTree' => [ 'summary' => '查询智能存储API树', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -866,11 +554,7 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [], 'responses' => [ 200 => [ @@ -878,15 +562,10 @@ 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'type' => 'string', - ], + 'RequestId' => ['title' => 'Id of the request', 'type' => 'string'], 'Data' => [ 'type' => 'array', - 'items' => [ - '$ref' => '#/components/schemas/AiStoreApiNode', - ], + 'items' => ['$ref' => '#/components/schemas/AiStoreApiNode'], ], ], ], @@ -894,44 +573,24 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterError', - 'errorMessage' => 'The parameter is invalid. Please check again.', - ], + ['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.', - ], + ['errorCode' => 'AuthFailed', 'errorMessage' => 'An error occurred while performing authorization. Please check your RAM configuration.'], ], 408 => [ - [ - 'errorCode' => 'Timeout', - 'errorMessage' => 'The request has timed out.', - ], + ['errorCode' => 'Timeout', 'errorMessage' => 'The request has timed out.'], ], 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'The service is unavailable.', - ], + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The service is unavailable.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], ], 'DeleteAiStoreUserTask' => [ 'summary' => '删除智能存储任务', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -944,18 +603,12 @@ [ 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true], ], [ 'name' => 'AistoreVersion', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -964,55 +617,32 @@ 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Data' => [ - 'type' => 'boolean', - ], + 'RequestId' => ['title' => 'Id of the request', 'type' => 'string'], + 'Data' => ['type' => 'boolean'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterError', - 'errorMessage' => 'The parameter is invalid. Please check again.', - ], + ['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.', - ], + ['errorCode' => 'AuthFailed', 'errorMessage' => 'An error occurred while performing authorization. Please check your RAM configuration.'], ], 408 => [ - [ - 'errorCode' => 'Timeout', - 'errorMessage' => 'The request has timed out.', - ], + ['errorCode' => 'Timeout', 'errorMessage' => 'The request has timed out.'], ], 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'The service is unavailable.', - ], + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The service is unavailable.'], ], ], 'responseDemo' => null, ], 'GetAiStoreReceiveConfig' => [ 'summary' => '获取接收消息配置', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1020,23 +650,17 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Product', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], [ 'name' => 'ApiName', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -1045,54 +669,31 @@ 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Data' => [ - '$ref' => '#/components/schemas/AiStoreReceiveConfig', - ], + 'RequestId' => ['title' => 'Id of the request', 'type' => 'string'], + 'Data' => ['$ref' => '#/components/schemas/AiStoreReceiveConfig'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterError', - 'errorMessage' => 'The parameter is invalid. Please check again.', - ], + ['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.', - ], + ['errorCode' => 'AuthFailed', 'errorMessage' => 'An error occurred while performing authorization. Please check your RAM configuration.'], ], 408 => [ - [ - 'errorCode' => 'Timeout', - 'errorMessage' => 'The request has timed out.', - ], + ['errorCode' => 'Timeout', 'errorMessage' => 'The request has timed out.'], ], 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'The service is unavailable.', - ], + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The service is unavailable.'], ], ], ], 'GetAiStoreUserTaskByName' => [ 'summary' => '根据任务名称获取智能存储任务', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1100,17 +701,12 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], ], 'responses' => [ @@ -1119,54 +715,31 @@ 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Data' => [ - '$ref' => '#/components/schemas/AiStoreUserTask', - ], + 'RequestId' => ['title' => 'Id of the request', 'type' => 'string'], + 'Data' => ['$ref' => '#/components/schemas/AiStoreUserTask'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterError', - 'errorMessage' => 'The parameter is invalid. Please check again.', - ], + ['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.', - ], + ['errorCode' => 'AuthFailed', 'errorMessage' => 'An error occurred while performing authorization. Please check your RAM configuration.'], ], 408 => [ - [ - 'errorCode' => 'Timeout', - 'errorMessage' => 'The request has timed out.', - ], + ['errorCode' => 'Timeout', 'errorMessage' => 'The request has timed out.'], ], 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'The service is unavailable.', - ], + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The service is unavailable.'], ], ], ], 'QueryAiStoreUserTaskPage' => [ 'summary' => '分页查询智能存储任务', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1174,60 +747,42 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Product', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], [ 'name' => 'ApiName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], [ 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], [ 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32'], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], [ 'name' => 'BucketName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -1236,22 +791,15 @@ 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string'], 'Data' => [ 'type' => 'object', 'properties' => [ 'TaskList' => [ 'type' => 'array', - 'items' => [ - '$ref' => '#/components/schemas/AiStoreUserTask', - ], - ], - 'TotalCount' => [ - 'type' => 'integer', - 'format' => 'int32', + 'items' => ['$ref' => '#/components/schemas/AiStoreUserTask'], ], + 'TotalCount' => ['type' => 'integer', 'format' => 'int32'], ], ], ], @@ -1260,36 +808,21 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterError', - 'errorMessage' => 'The parameter is invalid. Please check again.', - ], + ['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.', - ], + ['errorCode' => 'AuthFailed', 'errorMessage' => 'An error occurred while performing authorization. Please check your RAM configuration.'], ], 408 => [ - [ - 'errorCode' => 'Timeout', - 'errorMessage' => 'The request has timed out.', - ], + ['errorCode' => 'Timeout', 'errorMessage' => 'The request has timed out.'], ], 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'The service is unavailable.', - ], + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The service is unavailable.'], ], ], ], ], 'endpoints' => [ - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'viapi.cn-shanghai.aliyuncs.com', - ], + ['regionId' => 'cn-shanghai', 'endpoint' => 'viapi.cn-shanghai.aliyuncs.com'], ], ]; diff --git a/data/en_us/viapi/2023-01-17/api-docs.php b/data/en_us/viapi/2023-01-17/api-docs.php index bbc9cc2..7c1cb1c 100644 --- a/data/en_us/viapi/2023-01-17/api-docs.php +++ b/data/en_us/viapi/2023-01-17/api-docs.php @@ -1,28 +1,93 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'viapi', - 'version' => '2023-01-17', - ], - 'directories' => [ - 'QueryAsyncJobList', - 'GetAsyncJobResult', - 'CancelWaitingAsyncJob', - ], + 'info' => ['style' => 'RPC', 'product' => 'viapi', 'version' => '2023-01-17'], + 'directories' => ['QueryAsyncJobList', 'GetAsyncJobResult', 'CancelWaitingAsyncJob'], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'QueryAsyncJobList' => [ - 'summary' => '查询异步任务列表', - 'methods' => [ - 'post', + 'CancelWaitingAsyncJob' => [ + 'summary' => 'You can use CancelWaitingAsyncJob to cancel async tasks with a status of QUEUING. Tasks with a status of PROCESSING (already being processed) cannot be canceled. After cancellation, the task status changes to JOB_CANCELED, and canceled tasks will not be executed again.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => ['description' => 'The RequestId returned by the asynchronous API.', 'type' => 'string', 'required' => true, 'example' => 'E75FE679-0303-4DD1-8252-1143B4FA8A27 ', 'title' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '43A0AEB6-45F4-4138-8E89-E1A5D63200E3'], + 'Message' => ['description' => 'The returned result message.', 'type' => 'string', 'example' => 'Cancel job success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpCode' => ['description' => 'The error code of the asynchronous task.', 'type' => 'string', 'example' => 'InvalidParameter', 'title' => ''], + ], + 'example' => '', + ], + ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"43A0AEB6-45F4-4138-8E89-E1A5D63200E3\\",\\n \\"Message\\": \\"Cancel job success\\",\\n \\"Success\\": true,\\n \\"HttpCode\\": \\"InvalidParameter\\"\\n}","type":"json"}]', + 'title' => 'Cancel a Queuing Async Task', + 'description' => '## Description'."\n" + .'You can use CancelWaitingAsyncJob to cancel async tasks with a status of QUEUING. Tasks with a status of PROCESSING (already being processed) cannot be canceled. After cancellation, the task status changes to JOB_CANCELED, and canceled tasks will not be executed again.'."\n" + ."\n" + .'> - You can visit [Online Consultation](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) for online assistance.'."\n" + .'- To integrate Alibaba Cloud Visual Intelligence Open Platform Visual AI APIs, learn about API usage, or get consultations, please join the Alibaba Cloud Visual Intelligence Open Platform consultation group via DingTalk group (23109592) to contact us.'."\n" + .'- This API can only cancel async tasks with a status of QUEUING. Tasks in other statuses cannot be canceled.'."\n" + ."\n" + .'## Sample Code'."\n" + .'For sample code in commonly used programming languages to cancel a queuing async task, see [Cancel Queuing Async Task Sample Code](~~607976~~).', + 'requestParamsDescription' => '### Request Example'."\n" + ."\n" + .'```http'."\n" + .'http(s)://viapi.cn-shanghai.aliyuncs.com/?action=CancelWaitingAsyncJob //For more information about the endpoint, see: https://help.aliyun.com/document_detail/143103.html'."\n" + .'&jobId=E75FE679-0303-4DD1-8252-1143B4FA8A27 '."\n" + .'&<Common request parameters>'."\n" + .'```', + 'responseParamsDescription' => '## SDK Reference'."\n" + .'We recommend that you use an SDK to call Alibaba Cloud Visual AI APIs. SDKs are available for multiple programming languages. For more information, see [SDK Overview](~~145033~~).', + 'extraInfo' => '## Error Codes'."\n" + .'For error codes related to canceling a queuing async task, see [Common Error Codes](~~606865~~).', + 'changeSet' => [ + ['createdAt' => '2024-02-27T12:08:08.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelWaitingAsyncJob'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi:CancelWaitingAsyncJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'GetAsyncJobResult' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -30,355 +95,340 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'StartTime', + 'name' => 'JobId', 'in' => 'formData', + 'schema' => ['description' => 'The RequestId returned by the asynchronous API operation. You can use this value to query the actual result of the asynchronous operation.', 'type' => 'string', 'required' => true, 'example' => 'B6590005-5E7C-4A25-8F97-4479888D8271', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0E448D84-1736-1BCD-BEA5-866C413515A1', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the asynchronous task. Valid values:'."\n" + ."\n" + .'- QUEUING: The task is waiting in the queue.'."\n" + .'- PROCESSING: The task is being processed.'."\n" + .'- PROCESS_SUCCESS: The task was processed.'."\n" + .'- PROCESS_FAILED: The task failed to be processed.'."\n" + .'- TIMEOUT_FAILED: The task timed out.'."\n" + .'- LIMIT_RETRY_FAILED: The maximum number of retries was exceeded. If this status is returned, invoke the algorithm API operation again and then invoke GetAsyncJobResult to query the task result.', 'type' => 'string', 'example' => 'PROCESS_SUCCESS', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message of the asynchronous task.', 'type' => 'string', 'example' => 'paramsIllegal', 'title' => ''], + 'Result' => ['description' => 'The actual result of the asynchronous task.', 'type' => 'string', 'example' => '"{\\"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****\\"}"', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code of the asynchronous task.', 'type' => 'string', 'example' => 'InvalidParameter', 'title' => ''], + 'JobId' => ['description' => 'The asynchronous task ID.', 'type' => 'string', 'example' => 'A421D5F0-4F73-19F5-8D92-D509FAD281D2', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'example' => '2023-01-04 00:00:00', - 'required' => false, - 'type' => 'string', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query asynchronous task results', + 'summary' => 'For asynchronous API operations, the initial response does not contain the actual result. Save the RequestId from the response and call GetAsyncJobResult to obtain the actual result.', + 'description' => '## Feature description'."\n" + .'For asynchronous API operations, the initial response does not contain the actual result. Save the RequestId from the response and invoke GetAsyncJobResult to obtain the actual result.'."\n" + ."\n" + .'> - Files generated by asynchronous tasks expire after 30 minutes. To use the files for an extended period, download them to a local server or store them in Object Storage Service (OSS). For more information about OSS operations, see [Upload files](~~31886~~).'."\n" + .'- You can join the [online consultation](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) to get help from online support.'."\n" + .'- For questions about Visual Intelligence API access, usage, or other inquiries, contact us by joining the Visual Intelligence API consultation DingTalk group (23109592).'."\n" + ."\n" + .'## Sample code'."\n" + .'For sample code in commonly used programming languages for querying asynchronous task results, see [Sample code for querying asynchronous task results](~~607974~~).', + 'responseParamsDescription' => '## SDK reference'."\n" + .'We recommend that you use the Alibaba Cloud Visual AI SDK. The SDK supports multiple programming languages. For more information, see [SDK overview](~~145033~~).', + 'extraInfo' => '## Error codes'."\n" + .'For error codes of the query asynchronous task results operation, see [Common error codes](~~606865~~).'."\n" + ."\n" + .'## Security notice'."\n" + .'- Make sure that the images or files you upload comply with applicable laws and regulations.'."\n" + .'- Temporary files uploaded through the debugging feature are valid for 1 hour and are automatically cleaned up and deleted by the system after 24 hours.', + 'changeSet' => [ + ['createdAt' => '2024-02-27T12:08:08.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAsyncJobResult'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi:GetAsyncJobResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'QueryAsyncJobList' => [ + 'summary' => 'Queries the list of submitted asynchronous tasks after you successfully submit an asynchronous task.', + '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' => 'The start time.', 'type' => 'string', 'required' => false, 'example' => '2023-01-04 00:00:00', 'title' => ''], + ], [ 'name' => 'EndTime', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '2023-01-04 23:00:00', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The end time.', 'type' => 'string', 'required' => false, 'example' => '2023-01-04 23:00:00', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'E75FE679-0303-4DD1-8252-1143B4FA8A27 ', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The RequestId returned by the asynchronous API operation.', 'type' => 'string', 'required' => false, 'example' => 'E75FE679-0303-4DD1-8252-1143B4FA8A27 ', 'title' => ''], ], [ 'name' => 'PopProduct', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'ocr', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The category name in English. For more information, see the category name in English in [Activate capabilities](~~465341~~).', 'type' => 'string', 'required' => false, 'example' => 'ocr', 'title' => ''], ], [ 'name' => 'PopApiName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'RecognizeIdentityCard ', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The capability API name. For more information, see the capability API name in [Activate capabilities](~~465341~~).', 'type' => 'string', 'required' => false, 'example' => 'RecognizeIdentityCard ', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'PROCESS_SUCCESS', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The submit status of the asynchronous task. Valid values:'."\n" + ."\n" + .'- QUEUING: The task is queuing.'."\n" + .'- PROCESSING: The task is being processed.'."\n" + .'- PROCESS_SUCCESS: The task is processed.'."\n" + .'- PROCESS_FAILED: The task failed to be processed.'."\n" + .'- TIMEOUT_FAILED: The task timed out.'."\n" + .'- LIMIT_RETRY_FAILED: The maximum number of retries is exceeded.'."\n" + .'- JOB_CANCELED: The task is canceled.', 'type' => 'string', 'required' => false, 'example' => 'PROCESS_SUCCESS', 'title' => ''], ], [ 'name' => 'PageNum', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The start page number.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '20', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The number of entries per page. Maximum value: 500.', 'type' => 'string', 'required' => false, 'example' => '20', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'Schema of Response.', + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => '43A0AEB6-45F4-4138-8E89-E1A5D63200E3', - 'title' => 'Id of the request', - 'type' => 'string', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '43A0AEB6-45F4-4138-8E89-E1A5D63200E3'], 'Data' => [ - 'description' => '', + 'description' => 'The returned data.', + 'type' => 'object', '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', - ], + 'CurrentPage' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'TotalRecord' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '22', 'title' => ''], 'Result' => [ - 'description' => '', + 'description' => 'The query results.', + 'type' => 'array', 'items' => [ + 'type' => 'object', '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', - ], + 'CallerParentId' => ['description' => 'The ID of the task submitter.', 'type' => 'string', 'example' => '1850343078585779', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the task.', 'type' => 'string', 'example' => '2023-01-04 17:18:44', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time of the task.', 'type' => 'string', 'example' => '2023-01-04 17:18:44', 'title' => ''], + 'JobId' => ['description' => 'The asynchronous task ID.', 'type' => 'string', 'example' => '49E2CC28-ED1D-4CC5-854D-7D0AE2B20976', 'title' => ''], + 'PopApiName' => ['description' => 'The capability API name. For more information, see the capability API name in [Activate capabilities](~~465341~~).', 'type' => 'string', 'example' => 'DetectVideoShot', 'title' => ''], + 'PopProduct' => ['description' => 'The category name in English. For more information, see the category name in English in [Activate capabilities](~~465341~~).', 'type' => 'string', 'example' => 'videorecog', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the task.', 'type' => 'string', 'example' => '2023-01-04 17:18:44', 'title' => ''], + 'Status' => ['description' => 'The submit status of the asynchronous task. Valid values:'."\n" + ."\n" + .'- QUEUING: The task is queuing.'."\n" + .'- PROCESSING: The task is being processed.'."\n" + .'- PROCESS_SUCCESS: The task is processed.'."\n" + .'- PROCESS_FAILED: The task failed to be processed.'."\n" + .'- TIMEOUT_FAILED: The task timed out.'."\n" + .'- LIMIT_RETRY_FAILED: The maximum number of retries is exceeded.', 'type' => 'string', 'example' => 'PROCESS_SUCCESS', 'title' => ''], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'type' => 'array', + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', - ], - 'Message' => [ - 'description' => '', - 'example' => 'success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], - 'HttpCode' => [ - 'description' => '', - 'example' => '200', - 'type' => 'string', + 'title' => '', + 'example' => '', ], + 'Message' => ['description' => 'The error message of the asynchronous task.', 'type' => 'string', 'example' => 'paramsIllegal', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values: true and false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpCode' => ['description' => 'The error code of the asynchronous task.', 'type' => 'string', 'example' => 'InvalidParameter', 'title' => ''], ], - 'title' => 'Schema of Response', - 'type' => 'object', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query asynchronous task list', + 'description' => '## Description'."\n" + .'After you successfully submit an asynchronous task, you can call QueryAsyncJobList to query the list of submitted task information.'."\n" + ."\n" + .'> - You can join the [online consultation](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) to get online help.'."\n" + .'- To get help with Visual Intelligence API capability access, API usage, or other issues, join the DingTalk group (23109592) to contact us.'."\n" + ."\n" + .'## Sample code'."\n" + .'For sample code of querying the asynchronous task list in commonly used programming languages, see [Sample code for querying asynchronous task list](~~607975~~).'."\n" + ."\n" + .'## Usage notes'."\n" + ."\n" + .'- You can only query asynchronous tasks submitted by the current account.'."\n" + .'- You can perform a filtered query by category name and capability API name only after you have activated the corresponding capability.'."\n" + .'- You can invoke this API operation only once every 5 seconds. If an error is returned, retry after 5 seconds.'."\n" + .'- You cannot query data older than 24 hours.', + 'requestParamsDescription' => '### Request example'."\n" + .'```http'."\n" + .'http(s)://viapi.cn-shanghai.aliyuncs.com/?action=QueryAsyncJobList //For more information about endpoints, see: https://help.aliyun.com/document_detail/143103.html'."\n" + .'&callerParentId=1850343078585779 '."\n" + .'&startTime=2023-01-04 17:18:44'."\n" + .'&endTime=2023-01-04 17:18:44'."\n" + .'&jobId=49E2CC28-ED1D-4CC5-854D-7D0AE2B20976'."\n" + .'&popProduct=videorecog'."\n" + .'&popApiName=DetectVideoShot'."\n" + .'&status=PROCESS_SUCCESS'."\n" + .'&gmtCreate=2023-01-04 17:18:44 '."\n" + .'&<Common request parameters>'."\n" + .'```.', + 'responseParamsDescription' => '## SDK reference'."\n" + .'We recommend that you use the Visual Intelligence API SDK. SDKs are available for multiple programming languages. For more information, see [SDK overview](~~145033~~).', + 'extraInfo' => '## Error codes'."\n" + .'For error codes related to canceling queued asynchronous tasks, see [Common error codes](~~606865~~).', + 'changeSet' => [ + ['createdAt' => '2024-02-27T12:08:08.000Z', 'description' => 'Response parameters changed'], ], - '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' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 5, 'regionId' => '*', 'api' => 'QueryAsyncJobList'], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ + 'ramActions' => [ [ - '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', - ], + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'viapi:QueryAsyncJobList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], ], - '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&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****\\"}</Result>\\n </Data>\\n</GetAsyncJobResultResponse>","errorExample":""}]', ], - 'CancelWaitingAsyncJob' => [ - 'summary' => '取消排队异步任务', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + ], + 'endpoints' => [ + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'viapi.cn-shanghai.aliyuncs.com', 'endpoint' => 'viapi.cn-shanghai.aliyuncs.com', 'vpc' => 'viapi-vpc.cn-shanghai.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'InvalidParameter', 'message' => 'JobStatusError.', 'http_code' => 400, 'description' => 'JobStatusError'], + ['code' => 'InvalidParameter', 'message' => 'JobCanceled.', 'http_code' => 400, 'description' => 'JobCanceled'."\n"], + ['code' => 'InvalidParameter.BadRequest', 'message' => 'job Id not exists.', 'http_code' => 400, 'description' => 'job Id not exists.'], + ['code' => 'Throttling', 'message' => 'The request was denied due to QPS limits.', 'http_code' => 400, 'description' => 'The request was denied due to QPS limits.'."\n"], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CancelWaitingAsyncJob'], + ['description' => 'Response parameters changed', 'api' => 'GetAsyncJobResult'], + ['description' => 'Response parameters changed', 'api' => 'QueryAsyncJobList'], ], - 'security' => [ - [ - 'AK' => [], + 'createdAt' => '2024-02-27T12:08:17.000Z', + 'description' => '', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelWaitingAsyncJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAsyncJobResult'], + ['threshold' => '1', 'countWindow' => 5, 'regionId' => '*', 'api' => 'QueryAsyncJobList'], + ], + ], + 'ram' => [ + 'productCode' => 'VisualIntelligenceAPI', + 'productName' => 'Visual Intelligence API', + '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' => 'SERVICE', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'CancelWaitingAsyncJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi:CancelWaitingAsyncJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'JobId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'E75FE679-0303-4DD1-8252-1143B4FA8A27 ', - 'required' => true, - 'type' => 'string', + [ + 'apiName' => 'GetAsyncJobResult', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'viapi:GetAsyncJobResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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', + [ + 'apiName' => 'QueryAsyncJobList', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'viapi:QueryAsyncJobList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VisualIntelligenceAPI', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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', ], + 'resourceTypes' => [], ], ]; |