summaryrefslogtreecommitdiff
path: root/data/zh_cn/idrsservice/2020-06-30
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/zh_cn/idrsservice/2020-06-30
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/zh_cn/idrsservice/2020-06-30')
-rw-r--r--data/zh_cn/idrsservice/2020-06-30/api-docs.php13109
1 files changed, 4720 insertions, 8389 deletions
diff --git a/data/zh_cn/idrsservice/2020-06-30/api-docs.php b/data/zh_cn/idrsservice/2020-06-30/api-docs.php
index b977bad..5b95f70 100644
--- a/data/zh_cn/idrsservice/2020-06-30/api-docs.php
+++ b/data/zh_cn/idrsservice/2020-06-30/api-docs.php
@@ -1,661 +1,155 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'idrsservice',
- 'version' => '2020-06-30',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'idrsservice', 'version' => '2020-06-30'],
'directories' => [
[
- 'id' => 168945,
- 'title' => '签名',
+ 'children' => ['CreateSignature'],
'type' => 'directory',
- 'children' => [
- 'CreateSignature',
- ],
+ 'title' => '签名',
+ 'id' => 306512,
],
[
- 'id' => 168947,
- 'title' => '水印',
+ 'children' => ['GetWatermark'],
'type' => 'directory',
- 'children' => [
- 'GetWatermark',
- ],
+ 'title' => '水印',
+ 'id' => 306514,
],
[
- 'id' => 168949,
- 'title' => '检测流程',
+ 'children' => ['GetDetectProcess', 'GetDetectProcessJsonFile'],
'type' => 'directory',
- 'children' => [
- 'GetDetectProcess',
- 'GetDetectProcessJsonFile',
- ],
+ 'title' => '检测流程',
+ 'id' => 306516,
],
[
- 'id' => 168952,
- 'title' => '双录结果',
+ 'children' => ['GetRecordResult'],
'type' => 'directory',
- 'children' => [
- 'GetRecordResult',
- ],
+ 'title' => '双录结果',
+ 'id' => 306519,
],
[
- 'id' => 168954,
- 'title' => '其他',
- 'type' => 'directory',
'children' => [
- 'AssociateRoom',
- 'CreateApp',
- 'CreateDepartment',
- 'CreateDetectProcess',
- 'CreateRule',
- 'CreateTaskGroup',
- 'CreateUserDepartments',
- 'CreateWatermark',
- 'DeleteApp',
- 'DeleteDepartment',
- 'DeleteDetectProcess',
- 'DeleteRule',
- 'DeleteUser',
- 'DeleteUserDepartments',
- 'DeleteWatermark',
- 'GetApp',
- 'GetDepartment',
- 'GetDetection',
- 'GetPreSignedUrl',
- 'GetRule',
- 'GetTask',
- 'GetTaskGroup',
- 'GetUser',
- 'ListApps',
- 'ListDepartments',
- 'ListDetections',
- 'ListDetectProcesses',
- 'ListFiles',
- 'ListRecordResults',
- 'ListRules',
- 'ListTaskGroups',
- 'ListTaskItems',
- 'ListTasks',
- 'ListUsers',
- 'ListWatermarks',
- 'RenameDetectProcess',
- 'UpdateApp',
- 'UpdateDepartment',
- 'UpdateDetectProcess',
- 'UpdateRule',
- 'UpdateUser',
- 'UpdateWatermark',
- 'UploadReport',
- 'GetRecordsByFeeId',
- 'GetStatisticsRecordsByFeeId',
- 'AsrSentence',
- 'FaceCompare',
- 'TtsCommon',
- 'TtsTask',
- 'LeaveRoom',
- 'FaceRecognize',
- 'FaceLiveness',
- 'CreateTtsQuestionGroup',
- 'GetAsrResult',
- 'JoinRoom',
- 'CreateTtsQuestion',
- 'AsrTask',
- 'GetTtsQuestionByGroupId',
- 'GetRecordsByOuterBusinessId',
+ 'AssociateRoom', 'CreateDetectProcess', 'CreateTaskGroup', 'CreateUserDepartments', 'CreateWatermark', 'DeleteApp', 'DeleteDetectProcess', 'DeleteUserDepartments', 'DeleteWatermark', 'GetApp', 'GetDepartment', 'GetDetection', 'GetPreSignedUrl', 'GetTaskGroup', 'ListApps', 'ListDepartments', 'ListDetections', 'ListDetectProcesses', 'ListRecordResults', 'ListTaskGroups',
+ 'ListTaskItems', 'ListWatermarks', 'RenameDetectProcess', 'UpdateApp', 'UpdateDetectProcess', 'UpdateRule', 'UpdateWatermark', 'UploadReport', 'GetRecordsByFeeId', 'GetStatisticsRecordsByFeeId', 'AsrSentence', 'TtsCommon', 'TtsTask', 'LeaveRoom', 'FaceRecognize', 'CreateTtsQuestionGroup', 'GetAsrResult', 'JoinRoom', 'CreateTtsQuestion', 'AsrTask',
+ 'GetTtsQuestionByGroupId', 'GetRecordsByOuterBusinessId', 'CreateApp', 'CreateDepartment', 'CreateRule', 'DeleteDepartment', 'DeleteRule', 'DeleteUser', 'FaceCompare', 'FaceLiveness', 'GetRule', 'GetTask', 'GetUser', 'ListFiles', 'ListRules', 'ListTasks', 'ListUsers', 'UpdateDepartment', 'UpdateUser',
],
+ 'type' => 'directory',
+ 'title' => '其他',
+ 'id' => 306521,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'CreateSignature' => [
- 'summary' => '创建rtc签名',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AsrSentence' => [
+ 'summary' => '一句话识别',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
- 'name' => 'AppId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '质检应用Id',
- 'description' => '质检应用 ID',
- 'type' => 'string',
- 'required' => true,
- 'maximum' => '9223372036854775807',
- 'exclusiveMaximum' => true,
- 'minimum' => '0',
- 'exclusiveMinimum' => true,
- 'example' => '5bbfb884-1186-4d48-906b-88d586770f6b',
- ],
- ],
- [
- 'name' => 'ExpireTime',
- 'in' => 'query',
- 'schema' => [
- 'title' => '过期时间,单位秒,默认时间300s',
- 'description' => '过期时间,单位秒,默认时间 300s',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '300',
- ],
- ],
- [
- 'name' => 'Uid',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'rtc用户id',
- 'description' => 'rtc 用户 ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '550070734466****',
- ],
- ],
- [
- 'name' => 'ClientVersion',
- 'in' => 'query',
- 'schema' => [
- 'description' => '客户端版本',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1.0.001',
- ],
- ],
- [
- 'name' => 'ClientBaseParam',
- 'in' => 'query',
- 'schema' => [
- 'description' => '客户端基础参数,记录 SDK 版本号等信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"version":"1.0.0"}',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
+ 'name' => 'AsrRequest',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => 'ApiResult<MrtcSignDTO>',
- 'description' => 'ApiResult<MrtcSignDTO>',
+ 'description' => '任务请求参数',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'requestId',
- 'description' => 'requestId',
- 'type' => 'string',
- 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942',
- ],
- 'Code' => [
- 'title' => 'code',
- 'description' => 'code',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'title' => '提示',
- 'description' => '提示',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'Data' => [
- 'title' => '数据',
- 'description' => '数据',
- 'type' => 'object',
- 'properties' => [
- 'RtcAppId' => [
- 'description' => 'mrtc 应用 ID',
- 'type' => 'string',
- 'example' => '124325213125435',
- ],
- 'RtcWorkspaceId' => [
- 'description' => 'mrtc 工作空间',
- 'type' => 'string',
- 'example' => 'my_workspace',
- ],
- 'RtcBizName' => [
- 'description' => 'mrtc 业务名',
- 'type' => 'string',
- 'example' => '音视频biz',
- ],
- 'RtcSign' => [
- 'description' => 'mrtc 签名',
- 'type' => 'string',
- 'example' => '字符串签名token',
- ],
- 'ExpireTime' => [
- 'description' => '过期时间(单位:毫秒)',
- 'type' => 'string',
- 'example' => '300',
- ],
- ],
- ],
- 'Success' => [
- 'title' => '给 pop 使用的',
- 'description' => '给 pop 使用的',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'HttpCode' => [
- 'description' => 'HTTP 状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Errors' => [
- 'title' => '错误列表',
- 'description' => '错误列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '错误列表',
- 'type' => 'object',
- 'properties' => [
- 'Field' => [
- 'description' => '错误 ID',
- 'type' => 'string',
- 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942',
- ],
- 'Message' => [
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '无',
- ],
- ],
- ],
- ],
+ 'AppId' => ['title' => '应用信息', 'description' => '应用 ID', 'type' => 'string', 'required' => false, 'example' => 'd61be709-49d2-4cf1-b219-cd6181f72db8'],
+ 'FileUrl' => ['title' => '语音文件地址', 'description' => '可访问的文件 URL', 'type' => 'string', 'required' => false, 'example' => 'http://shuanglu-record-finance.oss-cn-shanghai.aliyuncs.com/record/4x5avhil/047730_30307_0/2022-02-12-10-20****'],
+ 'Format' => ['title' => '音频编码格式', 'description' => '音频编码格式,默认值:PCM。'."\n"
+ ."\n"
+ .'支持格式:PCM编码、16bit采样位数、单声道', 'type' => 'string', 'required' => false, 'example' => 'PCM'],
+ 'SampleRate' => ['title' => '音频采样率', 'description' => '音频采样率,默认值:16000 Hz。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '16000'],
+ 'EnablePunctuationPrediction' => ['title' => '是否在后处理中添加标点。取值:true、false。默认:false(不开启)。', 'description' => '是否在后处理中添加标点,默认值:False。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
+ 'EnableInverseTextNormalization' => ['title' => '是否在后处理中执行ITN。取值:true、false。默认:false(不开启)。', 'description' => '是否在后处理中执行ITN(逆文本规整,inverse text normalization)。设置为True时,中文数字将转为阿拉伯数字输出,默认值:False。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
+ 'EnableVoiceDetection' => ['title' => '是否在后处理中执行ITN。取值:true、false。默认:false(不开启)。', 'description' => '是否启动语音检测。默认值:False。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
],
- ],
- ],
- ],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
- ],
- [
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
- ],
- [
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
- ],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A1899517-BB99-5D3E-A71B-97524DCB0942\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"RtcAppId\\": \\"124325213125435\\",\\n \\"RtcWorkspaceId\\": \\"my_workspace\\",\\n \\"RtcBizName\\": \\"音视频biz\\",\\n \\"RtcSign\\": \\"字符串签名token\\",\\n \\"ExpireTime\\": \\"300\\"\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200,\\n \\"Errors\\": [\\n {\\n \\"Field\\": \\"A1899517-BB99-5D3E-A71B-97524DCB0942\\",\\n \\"Message\\": \\"无\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '创建 mrtc 签名',
- ],
- 'GetWatermark' => [
- 'summary' => '根据ID查询水印信息',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
- [
- 'name' => 'WatermarkId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '水印 ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '728fd812a876ec04818858982baebe6f',
- ],
- ],
- [
- 'name' => 'ClientVersion',
- 'in' => 'query',
- 'schema' => [
- 'description' => '客户端版本',
- 'type' => 'string',
'required' => false,
- 'example' => '1.0.003',
- ],
- ],
- [
- 'name' => 'ClientBaseParam',
- 'in' => 'query',
- 'schema' => [
- 'description' => '客户端基础参数,记录 SDK 版本号等信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"version":"1.0.0"}',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'ApiResult<WatermarkDTO>',
- 'description' => 'ApiResult<WatermarkDTO>',
+ 'title' => 'ApiResult<AsrResponseDTO>',
+ 'description' => 'ApiResult<AsrResponseDTO>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'requestId',
- 'description' => 'requestId',
- 'type' => 'string',
- 'example' => '84118BF0-56F7-54D2-8C1A-35BBBBD5016B',
- ],
- 'Code' => [
- 'title' => 'code',
- 'description' => 'code',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'title' => '提示',
- 'description' => '提示',
- 'type' => 'string',
- 'example' => '-',
- ],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
+ 'Code' => ['description' => '返回码', 'type' => 'integer', 'format' => 'int32', 'example' => 'OK'],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '-'],
'Data' => [
- 'title' => '数据',
'description' => '数据',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '水印id',
- 'description' => '水印 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
- 'CreatedAt' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Value' => [
- 'title' => '水印信息',
- 'description' => '水印信息',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'Name' => [
- 'title' => '水印名称',
- 'description' => '水印名称',
- 'type' => 'string',
- 'example' => '名称',
- ],
- ],
- ],
- 'Success' => [
- 'title' => '给 pop 使用的',
- 'description' => '给 pop 使用的',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'HttpCode' => [
- 'description' => 'HTTP 状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Errors' => [
- 'title' => '错误列表',
- 'description' => '错误列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '-',
- 'type' => 'object',
- 'properties' => [
- 'Field' => [
- 'description' => '错误 ID',
- 'type' => 'string',
- 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942',
- ],
- 'Message' => [
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '-',
- ],
- ],
+ 'Id' => ['title' => '双录端处理asr任务ID', 'description' => '双录端处理asr任务ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
+ 'TaskId' => ['title' => '智能语音asr任务ID', 'description' => '智能语音asr任务ID', 'type' => 'string', 'example' => '368cfa55-2364-4d79-aeb4-c0956c4a45cd'],
+ 'Name' => ['title' => '智能语音asr任务名称', 'description' => '智能语音asr任务名称', 'type' => 'string', 'example' => '任务1'],
+ 'Code' => ['title' => '智能语音asr任务code', 'description' => '智能语音asr任务code', 'type' => 'integer', 'format' => 'int32', 'example' => '20000000'],
+ 'Message' => ['title' => '智能语音asr任务message', 'description' => '智能语音asr任务message', 'type' => 'string', 'example' => '-'],
+ 'Result' => ['title' => 'asr识别出的文本', 'description' => 'asr识别出的文本', 'type' => 'string', 'example' => '北京的天气'],
],
],
+ 'Success' => ['title' => '给 pop 使用的', 'description' => '给 pop 使用的', 'type' => 'boolean', 'example' => 'True'],
+ 'HttpCode' => ['description' => 'HTTP 状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"84118BF0-56F7-54D2-8C1A-35BBBBD5016B\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"-\\",\\n \\"Data\\": {\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Value\\": \\"{}\\",\\n \\"Name\\": \\"名称\\"\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200,\\n \\"Errors\\": [\\n {\\n \\"Field\\": \\"A1899517-BB99-5D3E-A71B-97524DCB0942\\",\\n \\"Message\\": \\"-\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '获取水印信息',
- ],
- 'GetDetectProcess' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
- [
- 'name' => 'Id',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '0f1c45cd-3eee-4e60-b505-2e330b87****',
- ],
- ],
- [
- 'name' => 'ClientBaseParam',
- 'in' => 'query',
- 'schema' => [
- 'description' => '客户端基础参数,记录 SDK 版本号等信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"version":"1.0.0"}',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'description' => '无',
- 'type' => 'object',
- 'properties' => [
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '0q1c45cd-3eee-1e60-b505-2e330b8755d3',
- ],
- 'Data' => [
- 'description' => '数据',
- 'type' => 'object',
- 'properties' => [
- 'Draft' => [
- 'description' => ' '."\n"
- .'流程配置草稿内容',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'CreatedAt' => [
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2020-12-04T14:47:59.000+08:00',
- ],
- 'Md5' => [
- 'description' => '流程配置正式内容的 MD5',
- 'type' => 'string',
- 'example' => '987d563d38f5aef27feca8702c689bb1',
- ],
- 'UpdatedAt' => [
- 'description' => '更新时间',
- 'type' => 'string',
- 'example' => '2020-12-04T14:47:59.000+08:00',
- ],
- 'Name' => [
- 'description' => '检测流程名称',
- 'type' => 'string',
- 'example' => 'Android检测流程',
- ],
- 'NewVersion' => [
- 'description' => '是否有新版本',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Content' => [
- 'description' => '流程配置正式内容',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'Id' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'example' => '0f1c45cd-3eee-4e60-b505-2e330b8755d3',
- ],
- ],
- ],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"-\\",\\n \\"Data\\": {\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"TaskId\\": \\"368cfa55-2364-4d79-aeb4-c0956c4a45cd\\",\\n \\"Name\\": \\"任务1\\",\\n \\"Code\\": 20000000,\\n \\"Message\\": \\"-\\",\\n \\"Result\\": \\"北京的天气\\"\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200\\n}","type":"json"}]',
+ 'title' => '一句话识别',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-08T02:21:10.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-07-08T02:03:24.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-07-07T13:28:03.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-07-07T09:05:44.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'idrsservice:AsrSentence',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
- ],
- [
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
- ],
- [
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"0q1c45cd-3eee-1e60-b505-2e330b8755d3\\",\\n \\"Data\\": {\\n \\"Draft\\": \\"{}\\",\\n \\"CreatedAt\\": \\"2020-12-04T14:47:59.000+08:00\\",\\n \\"Md5\\": \\"987d563d38f5aef27feca8702c689bb1\\",\\n \\"UpdatedAt\\": \\"2020-12-04T14:47:59.000+08:00\\",\\n \\"Name\\": \\"Android检测流程\\",\\n \\"NewVersion\\": true,\\n \\"Content\\": \\"{}\\",\\n \\"Id\\": \\"0f1c45cd-3eee-4e60-b505-2e330b8755d3\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId/>\\n<Message/>\\n<Data>\\n <NewVersion>true</NewVersion>\\n <Draft>{}</Draft>\\n <Content>{}</Content>\\n <CreatedAt>2020-12-04T14:47:59.000+08:00</CreatedAt>\\n <Id>0f1c45cd-3eee-4e60-b505-2e330b8755d3</Id>\\n <UpdatedAt>2020-12-04T14:47:59.000+08:00</UpdatedAt>\\n <Md5>987d563d38f5aef27feca8702c689bb1</Md5>\\n <Name>Android检测流程</Name>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
- 'title' => '获取检测流程信息',
- 'summary' => '通过 GetDetectProcess 获取检测流程。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
],
- 'GetDetectProcessJsonFile' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AsrTask' => [
+ 'summary' => '单向视频双录-语音识别任务',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -663,454 +157,119 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
- 'name' => 'Id',
+ 'name' => 'Request',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hpsk3wdo-2020122319',
- ],
- ],
- [
- 'name' => 'ClientBaseParam',
- 'in' => 'query',
- 'schema' => [
- 'description' => '客户端基础参数,记录 SDK 版本号等信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"version":"1.0.0"}',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'description' => '-',
+ 'description' => '请求参数',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => 'B2695011-0604-5557-9E00-B74F58AB3F2B',
- ],
- 'Data' => [
- 'description' => '数据',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'Code' => [
- 'description' => '返回码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'AppId' => ['description' => '双录质检应用ID', 'type' => 'string', 'required' => true, 'example' => 'd9ee5df9-20bf-47bf-987a-76b26984b***'],
+ 'RoomId' => ['description' => 'mrtc 房间 ID', 'type' => 'string', 'required' => true, 'example' => '662027426755***'],
+ 'Timestamp' => ['description' => '时间戳', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1656388156399'],
+ 'Event' => ['description' => '事件类型,开始START,结束END', 'type' => 'string', 'required' => true, 'example' => 'START'],
+ 'AsrTaskId' => ['description' => '任务id', 'type' => 'string', 'required' => false, 'example' => 'd9ee5df9-20bf-47bf-987a-76b26984b***'."\n"],
],
- ],
- ],
- ],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
- ],
- [
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
- ],
- [
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
- ],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"-\\",\\n \\"RequestId\\": \\"B2695011-0604-5557-9E00-B74F58AB3F2B\\",\\n \\"Data\\": \\"-\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]',
- 'title' => '获取检测流程配置的 JSON 文件',
- ],
- 'GetRecordResult' => [
- 'summary' => '根据ID查询录制信息',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
- [
- 'name' => 'RecordId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '双录 ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942',
- ],
- ],
- [
- 'name' => 'ClientBaseParam',
- 'in' => 'query',
- 'schema' => [
- 'description' => '客户端基础参数,记录 SDK 版本号等信息',
- 'type' => 'string',
'required' => false,
- 'example' => '{"version":"1.0.0"}',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'ApiResult<RecordDTO>',
- 'description' => 'ApiResult<RecordDTO>',
+ 'title' => 'ApiResult<IdResponseDTO>',
+ 'description' => 'ApiResult<IdResponseDTO>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'requestId',
- 'description' => 'requestId',
- 'type' => 'string',
- 'example' => '84118BF0-56F7-54D2-8C1A-35BBBBD5016B',
- ],
- 'Code' => [
- 'title' => 'code',
- 'description' => 'code',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'title' => '提示',
- 'description' => '提示',
- 'type' => 'string',
- 'example' => '无',
- ],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'DF4B0162-A5E0-5F85-BEFD-CAC36E876***'],
+ 'Code' => ['description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => 'OK'],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '-'],
'Data' => [
- 'title' => '数据',
'description' => '数据',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '双录记录id',
- 'description' => '双录记录 ID',
- 'type' => 'string',
- 'example' => '0f1c45cd-3eee-4e60-b505-2e330b8755d3',
- ],
- 'CreatedAt' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'DetectProcessName' => [
- 'title' => '业务检测流程名',
- 'description' => '业务检测流程名',
- 'type' => 'string',
- 'example' => 'XX流程',
- ],
- 'DepartmentName' => [
- 'title' => '部门名',
- 'description' => '部门名',
- 'type' => 'string',
- 'example' => 'XX部门',
- ],
- 'AppName' => [
- 'title' => '应用名',
- 'description' => '应用名',
- 'type' => 'string',
- 'example' => 'XX应用',
- ],
- 'VideoUrl' => [
- 'title' => '视频地址',
- 'description' => '视频地址',
- 'type' => 'string',
- 'example' => 'http://oss.aliyuncs.com/1.mp4',
- ],
- 'MetaUrl' => [
- 'title' => 'meta地址',
- 'description' => 'meta 地址',
- 'type' => 'string',
- 'example' => 'http://oss.aliyuncs.com/1.mp4.meta',
- ],
- 'ResultUrl' => [
- 'title' => '结果地址',
- 'description' => '结果地址',
- 'type' => 'string',
- 'example' => 'http://oss.aliyuncs.com/1.mp4.json',
- ],
- 'RecordAt' => [
- 'title' => '录制时间',
- 'description' => '录制时间',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Duration' => [
- 'title' => '时长',
- 'description' => '时长',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '22',
- ],
- 'Status' => [
- 'title' => '检测状态',
- 'description' => '检测状态',
- 'type' => 'string',
- 'example' => 'completed',
- ],
- 'RoomId' => [
- 'title' => 'mrtc房间id',
- 'description' => 'mrtc 房间 ID',
- 'type' => 'string',
- 'example' => '641981583353***',
- ],
- 'RecordRoomList' => [
- 'title' => '远程双录文件地址列表',
- 'description' => '远程双录文件地址列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '房间列表',
- 'type' => 'object',
- 'properties' => [
- 'Role' => [
- 'title' => '角色',
- 'description' => '角色',
- 'type' => 'string',
- 'example' => '21343',
- ],
- 'RoomVideoUrl' => [
- 'title' => '视频地址',
- 'description' => '视频地址',
- 'type' => 'string',
- 'example' => 'http://oss.aliyuncs.com/1.mp4',
- ],
- 'RoomMetaUrl' => [
- 'title' => 'meta地址',
- 'description' => 'meta 地址',
- 'type' => 'string',
- 'example' => 'http://oss.aliyuncs.com/1.mp4.meta',
- ],
- 'RoomResultUrl' => [
- 'title' => '结果地址',
- 'description' => '结果地址',
- 'type' => 'string',
- 'example' => 'http://oss.aliyuncs.com/1.mp4.json',
- ],
- 'RecordType' => [
- 'title' => '录制视频类型',
- 'description' => '录制视频类型',
- 'type' => 'string',
- 'example' => 'Mix',
- ],
- 'RoomRecordAt' => [
- 'title' => '录制时间',
- 'description' => '录制时间',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'RoomStatus' => [
- 'title' => '检测状态',
- 'description' => '检测状态',
- 'type' => 'string',
- 'example' => 'runnable',
- ],
- 'RtcRecordId' => [
- 'description' => 'mrtc录制ID',
- 'type' => 'string',
- 'example' => 'record_65703154805715668342'."\n",
- ],
- 'OuterBusinessId' => [
- 'description' => '业务ID,用户自定义',
- 'type' => 'string',
- 'example' => 'ads32efef43',
- ],
- ],
- ],
- ],
- 'OuterBusinessId' => [
- 'description' => '业务ID,用户自定义',
- 'type' => 'string',
- 'example' => 'ads32efef43',
- ],
- ],
- ],
- 'Success' => [
- 'title' => '给 pop 使用的',
- 'description' => '给 pop 使用的',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'HttpCode' => [
- 'description' => 'HTTP 状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Errors' => [
- 'title' => '错误列表',
- 'description' => '错误列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '异常信息',
- 'type' => 'object',
- 'properties' => [
- 'Field' => [
- 'description' => '错误 ID',
- 'type' => 'string',
- 'example' => '0f1c45cd-3eee-4e60-b505-2e330b8755d3',
- ],
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '无',
- ],
- ],
+ 'Result' => ['description' => '检测结果', 'type' => 'string', 'example' => '北京的天气'],
],
],
+ 'Success' => ['title' => '给 pop 使用的', 'description' => '给 pop 使用的', 'type' => 'boolean', 'example' => 'True'],
+ 'HttpCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DF4B0162-A5E0-5F85-BEFD-CAC36E876***\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"-\\",\\n \\"Data\\": {\\n \\"Result\\": \\"北京的天气\\"\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200\\n}","type":"json"}]',
+ 'title' => '提交ASR任务',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'idrsservice:AsrTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"84118BF0-56F7-54D2-8C1A-35BBBBD5016B\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"Id\\": \\"0f1c45cd-3eee-4e60-b505-2e330b8755d3\\",\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"DetectProcessName\\": \\"XX流程\\",\\n \\"DepartmentName\\": \\"XX部门\\",\\n \\"AppName\\": \\"XX应用\\",\\n \\"VideoUrl\\": \\"http://oss.aliyuncs.com/1.mp4\\",\\n \\"MetaUrl\\": \\"http://oss.aliyuncs.com/1.mp4.meta\\",\\n \\"ResultUrl\\": \\"http://oss.aliyuncs.com/1.mp4.json\\",\\n \\"RecordAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Duration\\": 22,\\n \\"Status\\": \\"completed\\",\\n \\"RoomId\\": \\"641981583353***\\",\\n \\"RecordRoomList\\": [\\n {\\n \\"Role\\": \\"21343\\",\\n \\"RoomVideoUrl\\": \\"http://oss.aliyuncs.com/1.mp4\\",\\n \\"RoomMetaUrl\\": \\"http://oss.aliyuncs.com/1.mp4.meta\\",\\n \\"RoomResultUrl\\": \\"http://oss.aliyuncs.com/1.mp4.json\\",\\n \\"RecordType\\": \\"Mix\\",\\n \\"RoomRecordAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"RoomStatus\\": \\"runnable\\",\\n \\"RtcRecordId\\": \\"record_65703154805715668342\\\\n\\",\\n \\"OuterBusinessId\\": \\"ads32efef43\\"\\n }\\n ],\\n \\"OuterBusinessId\\": \\"ads32efef43\\"\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200,\\n \\"Errors\\": [\\n {\\n \\"Field\\": \\"0f1c45cd-3eee-4e60-b505-2e330b8755d3\\",\\n \\"Message\\": \\"无\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '获取双录结果',
],
'AssociateRoom' => [
'summary' => '关联MRTC房间',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
- 'systemTags' => [
- 'operationType' => 'none',
- ],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
- 'schema' => [
- 'title' => '质检应用id',
- 'description' => '质检应用 ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '5bbfb884-1186-4d48-906b-88d586770f6b',
- ],
+ 'schema' => ['title' => '质检应用id', 'description' => '质检应用 ID', 'type' => 'string', 'required' => true, 'example' => '5bbfb884-1186-4d48-906b-88d586770f6b'],
],
[
'name' => 'DepartmentId',
'in' => 'query',
- 'schema' => [
- 'title' => '部门id',
- 'description' => '部门 ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '5bbfb884-1186-4d48-906b-88d586770f6b',
- ],
+ 'schema' => ['title' => '部门id', 'description' => '部门 ID', 'type' => 'string', 'required' => false, 'example' => '5bbfb884-1186-4d48-906b-88d586770f6b'],
],
[
'name' => 'RoomId',
'in' => 'query',
- 'schema' => [
- 'title' => 'Mrtc房间id',
- 'description' => 'mrtc 房间 ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '5500707344661',
- ],
+ 'schema' => ['title' => 'Mrtc房间id', 'description' => 'mrtc 房间 ID', 'type' => 'string', 'required' => true, 'example' => '5500707344661'],
],
[
'name' => 'ClientVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '客户端版本',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1.0.002',
- ],
+ 'schema' => ['description' => '客户端版本', 'type' => 'string', 'required' => false, 'example' => '1.0.002'],
],
[
'name' => 'ClientBaseParam',
'in' => 'query',
- 'schema' => [
- 'description' => '客户端基础参数,记录 SDK 版本号等信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"version":"1.0.0"}',
- ],
+ 'schema' => ['description' => '客户端基础参数,记录 SDK 版本号等信息', 'type' => 'string', 'required' => false, 'example' => '{"version":"1.0.0"}'],
],
],
'responses' => [
@@ -1120,42 +279,12 @@
'description' => 'ApiResult<String>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'requestId',
- 'description' => 'requestId',
- 'type' => 'string',
- 'example' => '84118BF0-56F7-54D2-8C1A-35BBBBD5016B',
- ],
- 'Code' => [
- 'title' => 'code',
- 'description' => 'code',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'title' => '提示',
- 'description' => '提示',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'Data' => [
- 'title' => '数据',
- 'description' => '数据',
- 'type' => 'string',
- 'example' => '{\'Name\': u\'\\u4ee3\\u7406\\u4eba\', \'CreatedAt\': \'2021-11-11T15:27:39.449+08:00\', \'Channel\': \'063756\', \'Id\': \'5ead2d7f-9e2c-4521-bac4-e37bd44b6a56\'}',
- ],
- 'Success' => [
- 'title' => '给 pop 使用的',
- 'description' => '给 pop 使用的',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'HttpCode' => [
- 'description' => 'HTTP 状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'RequestId' => ['title' => 'requestId', 'description' => 'requestId', 'type' => 'string', 'example' => '84118BF0-56F7-54D2-8C1A-35BBBBD5016B'],
+ 'Code' => ['title' => 'code', 'description' => 'code', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['title' => '提示', 'description' => '提示', 'type' => 'string', 'example' => '-'],
+ 'Data' => ['title' => '数据', 'description' => '数据', 'type' => 'string', 'example' => '{\'Name\': u\'\\u4ee3\\u7406\\u4eba\', \'CreatedAt\': \'2021-11-11T15:27:39.449+08:00\', \'Channel\': \'063756\', \'Id\': \'5ead2d7f-9e2c-4521-bac4-e37bd44b6a56\'}'],
+ 'Success' => ['title' => '给 pop 使用的', 'description' => '给 pop 使用的', 'type' => 'boolean', 'example' => 'True'],
+ 'HttpCode' => ['description' => 'HTTP 状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Errors' => [
'title' => '错误列表',
'description' => '错误列表',
@@ -1164,16 +293,8 @@
'description' => '错误列表',
'type' => 'object',
'properties' => [
- 'Field' => [
- 'description' => '错误 ID',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'Message' => [
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '-',
- ],
+ 'Field' => ['description' => '错误 ID', 'type' => 'string', 'example' => '-'],
+ 'Message' => ['description' => '错误消息', 'type' => 'string', 'example' => '-'],
],
],
],
@@ -1183,47 +304,41 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"84118BF0-56F7-54D2-8C1A-35BBBBD5016B\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"-\\",\\n \\"Data\\": \\"{\'Name\': u\'\\\\\\\\u4ee3\\\\\\\\u7406\\\\\\\\u4eba\', \'CreatedAt\': \'2021-11-11T15:27:39.449+08:00\', \'Channel\': \'063756\', \'Id\': \'5ead2d7f-9e2c-4521-bac4-e37bd44b6a56\'}\\",\\n \\"Success\\": true,\\n \\"HttpCode\\": 200,\\n \\"Errors\\": [\\n {\\n \\"Field\\": \\"-\\",\\n \\"Message\\": \\"-\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'mrtc录制信息上传',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'idrsservice:AssociateRoom',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'CreateApp' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1231,50 +346,27 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '应用名称',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '测试应用',
- ],
+ 'schema' => ['description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '测试应用'],
],
[
'name' => 'PackageName',
'in' => 'query',
- 'schema' => [
- 'description' => '包名',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'com.test.app',
- ],
+ 'schema' => ['description' => '包名', 'type' => 'string', 'required' => false, 'example' => 'com.test.app'],
],
[
'name' => 'DepartmentId',
'in' => 'query',
- 'schema' => [
- 'description' => '部门 ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '4367c30a-c686-4bb2-a45d-5affb87f7aca',
- ],
+ 'schema' => ['description' => '部门 ID', 'type' => 'string', 'required' => false, 'example' => '4367c30a-c686-4bb2-a45d-5affb87f7aca'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大不超过64个ASCII字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '4367c30a-c686-4bb2-a45d-5affb87****',
- ],
+ 'schema' => ['description' => '用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '4367c30a-c686-4bb2-a45d-5affb87****'],
],
],
'responses' => [
@@ -1283,52 +375,20 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '返回信息',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'Message' => ['description' => '返回信息', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
'Data' => [
'description' => '无',
'type' => 'object',
'properties' => [
- 'CreatorName' => [
- 'description' => '创建者名称',
- 'type' => 'string',
- 'example' => '李李',
- ],
- 'Disabled' => [
- 'description' => '是否禁用',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'CreatedAt' => [
- 'description' => '创建日期',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Name' => [
- 'description' => '应用名',
- 'type' => 'string',
- 'example' => '应用1',
- ],
- 'Id' => [
- 'description' => '应用 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'CreatorName' => ['description' => '创建者名称', 'type' => 'string', 'example' => '李李'],
+ 'Disabled' => ['description' => '是否禁用', 'type' => 'boolean', 'example' => 'false'],
+ 'CreatedAt' => ['description' => '创建日期', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Name' => ['description' => '应用名', 'type' => 'string', 'example' => '应用1'],
+ 'Id' => ['description' => '应用 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
],
- 'Code' => [
- 'description' => 'code',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Code' => ['description' => 'code', 'type' => 'string', 'example' => 'OK'],
],
],
],
@@ -1336,66 +396,42 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'code' => [
- 'type' => 'string',
- ],
- 'data' => [
- 'type' => 'object',
- ],
- 'requestId' => [
- 'type' => 'string',
- ],
- 'message' => [
- 'type' => 'string',
- ],
+ 'code' => ['type' => 'string', 'description' => ''],
+ 'data' => ['type' => 'object', 'description' => ''],
+ 'requestId' => ['type' => 'string', 'description' => ''],
+ 'message' => ['type' => 'string', 'description' => ''],
'errors' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'message' => [
- 'type' => 'string',
- ],
- 'field' => [
- 'type' => 'string',
- ],
+ 'message' => ['type' => 'string', 'description' => ''],
+ 'field' => ['type' => 'string', 'description' => ''],
],
+ 'description' => '',
],
+ 'description' => '',
],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Data\\": {\\n \\"CreatorName\\": \\"李李\\",\\n \\"Disabled\\": false,\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Name\\": \\"应用1\\",\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</RequestId>\\n<Message>-</Message>\\n<Data>\\n <CreatedAt>2020-07-14T14:01:41.000+08:00</CreatedAt>\\n <Id>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</Id>\\n <Disabled>false</Disabled>\\n <CreatorName>李李</CreatorName>\\n <Name>应用1</Name>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
@@ -1404,15 +440,27 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'idrsservice:CreateApp',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'CreateDepartment' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1420,50 +468,27 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'description' => '部门描述',
- 'type' => 'string',
- 'required' => false,
- 'example' => '说明',
- ],
+ 'schema' => ['description' => '部门描述', 'type' => 'string', 'required' => false, 'example' => '说明'],
],
[
'name' => 'Label',
'in' => 'query',
- 'schema' => [
- 'description' => '标签',
- 'type' => 'string',
- 'required' => false,
- 'example' => '标签',
- ],
+ 'schema' => ['description' => '标签', 'type' => 'string', 'required' => false, 'example' => '标签'],
],
[
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '部门名称',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '部门名称',
- ],
+ 'schema' => ['description' => '部门名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '部门名称'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '客户端幂等参数',
- 'type' => 'string',
- 'required' => false,
- 'example' => '无',
- ],
+ 'schema' => ['description' => '客户端幂等参数', 'type' => 'string', 'required' => false, 'example' => '无'],
],
],
'responses' => [
@@ -1472,81 +497,38 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '11111111',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '11111111'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
'Data' => [
'description' => '数据',
'type' => 'object',
'properties' => [
- 'Description' => [
- 'description' => '部门描述',
- 'type' => 'string',
- 'example' => '这是一个部门',
- ],
- 'CreatedAt' => [
- 'description' => '测试',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Name' => [
- 'description' => '部门名称',
- 'type' => 'string',
- 'example' => '技术部',
- ],
- 'Id' => [
- 'description' => '部门 ID',
- 'type' => 'string',
- 'example' => '63bb629d-92bf-4cdc-ad0b-3032c926d23f',
- ],
+ 'Description' => ['description' => '部门描述', 'type' => 'string', 'example' => '这是一个部门'],
+ 'CreatedAt' => ['description' => '测试', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Name' => ['description' => '部门名称', 'type' => 'string', 'example' => '技术部'],
+ 'Id' => ['description' => '部门 ID', 'type' => 'string', 'example' => '63bb629d-92bf-4cdc-ad0b-3032c926d23f'],
],
],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"11111111\\",\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Data\\": {\\n \\"Description\\": \\"这是一个部门\\",\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Name\\": \\"技术部\\",\\n \\"Id\\": \\"63bb629d-92bf-4cdc-ad0b-3032c926d23f\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</RequestId>\\n<Message>11111111</Message>\\n<Data>\\n <Description>这是一个部门</Description>\\n <CreatedAt>2020-07-14T14:01:41.000+08:00</CreatedAt>\\n <Id>63bb629d-92bf-4cdc-ad0b-3032c926d23f</Id>\\n <Name>技术部</Name>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
@@ -1555,15 +537,24 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'idrsservice:CreateDepartment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'CreateDetectProcess' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1571,50 +562,27 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '检测流程名称',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'Android检测流程',
- ],
+ 'schema' => ['description' => '检测流程名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Android检测流程'],
],
[
'name' => 'Draft',
'in' => 'query',
- 'schema' => [
- 'description' => '流程配置草稿内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
+ 'schema' => ['description' => '流程配置草稿内容', 'type' => 'string', 'required' => false, 'example' => '{}'],
],
[
'name' => 'Content',
'in' => 'query',
- 'schema' => [
- 'description' => '流程配置正式内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
+ 'schema' => ['description' => '流程配置正式内容', 'type' => 'string', 'required' => false, 'example' => '{}'],
],
[
'name' => 'Type',
'in' => 'query',
- 'schema' => [
- 'description' => '类型:remote(远程双录),local(本地双录)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'LOCAL',
- ],
+ 'schema' => ['description' => '类型:remote(远程双录),local(本地双录)', 'type' => 'string', 'required' => false, 'example' => 'LOCAL'],
],
],
'responses' => [
@@ -1623,96 +591,41 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '0q1c45cd-3eee-1e60-b505-2e330b8755d3',
- ],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '0q1c45cd-3eee-1e60-b505-2e330b8755d3'],
'Data' => [
'description' => '数据',
'type' => 'object',
'properties' => [
- 'Draft' => [
- 'description' => '流程配置草稿内容',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'CreatedAt' => [
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2020-12-04T14:47:59.000+08:00',
- ],
- 'Disabled' => [
- 'description' => '有效状态',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'Md5' => [
- 'description' => '流程配置正式内容的 MD5',
- 'type' => 'string',
- 'example' => '987d563d38f5aef27feca8702c689bb1',
- ],
- 'Name' => [
- 'description' => '检测流程的名称',
- 'type' => 'string',
- 'example' => 'Android检测流程',
- ],
- 'Content' => [
- 'description' => '流程配置正式内容',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'Id' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'example' => '0f1c45cd-3eee-4e60-b505-2e330b8755d3',
- ],
+ 'Draft' => ['description' => '流程配置草稿内容', 'type' => 'string', 'example' => '{}'],
+ 'CreatedAt' => ['description' => '创建时间', 'type' => 'string', 'example' => '2020-12-04T14:47:59.000+08:00'],
+ 'Disabled' => ['description' => '有效状态', 'type' => 'boolean', 'example' => 'false'],
+ 'Md5' => ['description' => '流程配置正式内容的 MD5', 'type' => 'string', 'example' => '987d563d38f5aef27feca8702c689bb1'],
+ 'Name' => ['description' => '检测流程的名称', 'type' => 'string', 'example' => 'Android检测流程'],
+ 'Content' => ['description' => '流程配置正式内容', 'type' => 'string', 'example' => '{}'],
+ 'Id' => ['description' => 'ID', 'type' => 'string', 'example' => '0f1c45cd-3eee-4e60-b505-2e330b8755d3'],
],
],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"0q1c45cd-3eee-1e60-b505-2e330b8755d3\\",\\n \\"Data\\": {\\n \\"Draft\\": \\"{}\\",\\n \\"CreatedAt\\": \\"2020-12-04T14:47:59.000+08:00\\",\\n \\"Disabled\\": false,\\n \\"Md5\\": \\"987d563d38f5aef27feca8702c689bb1\\",\\n \\"Name\\": \\"Android检测流程\\",\\n \\"Content\\": \\"{}\\",\\n \\"Id\\": \\"0f1c45cd-3eee-4e60-b505-2e330b8755d3\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0q1c45cd-3eee-1e60-b505-2e330b8755d3</RequestId>\\n<Message>-</Message>\\n<Data>\\n <Draft>{}</Draft>\\n <Content>{}</Content>\\n <CreatedAt>2020-12-04T14:47:59.000+08:00</CreatedAt>\\n <Id>0f1c45cd-3eee-4e60-b505-2e330b8755d3</Id>\\n <Disabled>false</Disabled>\\n <Md5>987d563d38f5aef27feca8702c689bb1</Md5>\\n <Name>Android检测流程</Name>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
@@ -1763,15 +676,24 @@
.'```'."\n",
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'idrsservice:CreateDetectProcess',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'CreateRule' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1779,41 +701,22 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '规则名称',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => '规则名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default'],
],
[
'name' => 'Content',
'in' => 'query',
- 'schema' => [
- 'description' => '检测规则内容,格式请参考示例值',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '[{"sequence":1,"actions":[{"name":"id_card_recognize"}]},{"sequence":2,"actions":[{"name":"document_title_recognize"},{"name":"flip_action_recognize"},{"name":"sign_action_recognize"}]},{"sequence":3,"actions":[{"name":"sign_recognize"}]},{"sequence":0,"actions":[{"name":"face_track"},{"name":"speech_to_text"}]}]',
- ],
+ 'schema' => ['description' => '检测规则内容,格式请参考示例值', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"sequence":1,"actions":[{"name":"id_card_recognize"}]},{"sequence":2,"actions":[{"name":"document_title_recognize"},{"name":"flip_action_recognize"},{"name":"sign_action_recognize"}]},{"sequence":3,"actions":[{"name":"sign_recognize"}]},{"sequence":0,"actions":[{"name":"face_track"},{"name":"speech_to_text"}]}]'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '幂等校验参数',
- 'type' => 'string',
- 'required' => false,
- 'example' => '无',
- ],
+ 'schema' => ['description' => '幂等校验参数', 'type' => 'string', 'required' => false, 'example' => '无'],
],
],
'responses' => [
@@ -1822,76 +725,37 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
'Data' => [
'description' => '数据',
'type' => 'object',
'properties' => [
- 'Name' => [
- 'description' => '规则名称',
- 'type' => 'string',
- 'example' => 'default',
- ],
- 'Content' => [
- 'description' => '规则内容',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'Id' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'Name' => ['description' => '规则名称', 'type' => 'string', 'example' => 'default'],
+ 'Content' => ['description' => '规则内容', 'type' => 'string', 'example' => '{}'],
+ 'Id' => ['description' => 'ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
],
- 'Code' => [
- 'description' => '返回码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Code' => ['description' => '返回码', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Data\\": {\\n \\"Name\\": \\"default\\",\\n \\"Content\\": \\"{}\\",\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</RequestId>\\n<Message>-</Message>\\n<Data>\\n <Content>{}</Content>\\n <Id>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</Id>\\n <Name>default</Name>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
@@ -1900,15 +764,148 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'idrsservice:CreateRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
- 'CreateTaskGroup' => [
- 'methods' => [
- 'post',
+ 'CreateSignature' => [
+ 'summary' => '创建rtc签名',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'systemTags' => ['operationType' => 'create'],
+ 'parameters' => [
+ [
+ 'name' => 'AppId',
+ 'in' => 'query',
+ 'schema' => ['title' => '质检应用Id', 'description' => '质检应用 ID', 'type' => 'string', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '5bbfb884-1186-4d48-906b-88d586770f6b'],
+ ],
+ [
+ 'name' => 'ExpireTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '过期时间,单位秒,默认时间300s', 'description' => '过期时间,单位秒,默认时间 300s', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300'],
+ ],
+ [
+ 'name' => 'Uid',
+ 'in' => 'query',
+ 'schema' => ['title' => 'rtc用户id', 'description' => 'rtc 用户 ID', 'type' => 'string', 'required' => true, 'example' => '550070734466****'],
+ ],
+ [
+ 'name' => 'ClientVersion',
+ 'in' => 'query',
+ 'schema' => ['description' => '客户端版本', 'type' => 'string', 'required' => false, 'example' => '1.0.001'],
+ ],
+ [
+ 'name' => 'ClientBaseParam',
+ 'in' => 'query',
+ 'schema' => ['description' => '客户端基础参数,记录 SDK 版本号等信息', 'type' => 'string', 'required' => false, 'example' => '{"version":"1.0.0"}'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'ApiResult<MrtcSignDTO>',
+ 'description' => 'ApiResult<MrtcSignDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'requestId', 'description' => 'requestId', 'type' => 'string', 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942'],
+ 'Code' => ['title' => 'code', 'description' => 'code', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['title' => '提示', 'description' => '提示', 'type' => 'string', 'example' => '无'],
+ 'Data' => [
+ 'title' => '数据',
+ 'description' => '数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'RtcAppId' => ['description' => 'mrtc 应用 ID', 'type' => 'string', 'example' => '124325213125435'],
+ 'RtcWorkspaceId' => ['description' => 'mrtc 工作空间', 'type' => 'string', 'example' => 'my_workspace'],
+ 'RtcBizName' => ['description' => 'mrtc 业务名', 'type' => 'string', 'example' => '音视频biz'],
+ 'RtcSign' => ['description' => 'mrtc 签名', 'type' => 'string', 'example' => '字符串签名token'],
+ 'ExpireTime' => ['description' => '过期时间(单位:毫秒)', 'type' => 'string', 'example' => '300'],
+ ],
+ ],
+ 'Success' => ['title' => '给 pop 使用的', 'description' => '给 pop 使用的', 'type' => 'boolean', 'example' => 'True'],
+ 'HttpCode' => ['description' => 'HTTP 状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Errors' => [
+ 'title' => '错误列表',
+ 'description' => '错误列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '错误列表',
+ 'type' => 'object',
+ 'properties' => [
+ 'Field' => ['description' => '错误 ID', 'type' => 'string', 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942'],
+ 'Message' => ['description' => '错误消息', 'type' => 'string', 'example' => '无'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
+ ],
+ [
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
+ ],
+ 403 => [
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A1899517-BB99-5D3E-A71B-97524DCB0942\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"RtcAppId\\": \\"124325213125435\\",\\n \\"RtcWorkspaceId\\": \\"my_workspace\\",\\n \\"RtcBizName\\": \\"音视频biz\\",\\n \\"RtcSign\\": \\"字符串签名token\\",\\n \\"ExpireTime\\": \\"300\\"\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200,\\n \\"Errors\\": [\\n {\\n \\"Field\\": \\"A1899517-BB99-5D3E-A71B-97524DCB0942\\",\\n \\"Message\\": \\"无\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '创建 mrtc 签名',
+ 'changeSet' => [
+ ['createdAt' => '2022-02-21T07:17:01.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-01-24T04:47:39.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-01-06T06:26:11.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-01-05T09:00:07.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'idrsservice:CreateSignature',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CreateTaskGroup' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1916,90 +913,47 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
- 'schema' => [
- 'description' => '所属应用 ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'schema' => ['description' => '所属应用 ID', 'type' => 'string', 'required' => false, 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
[
'name' => 'ExpireAt',
'in' => 'query',
- 'schema' => [
- 'description' => '任务过期时间',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2020-10-10',
- ],
+ 'schema' => ['description' => '任务过期时间', 'type' => 'string', 'required' => false, 'example' => '2020-10-10'],
],
[
'name' => 'GroupName',
'in' => 'query',
- 'schema' => [
- 'description' => '任务组名',
- 'type' => 'string',
- 'required' => false,
- 'example' => '任务组',
- ],
+ 'schema' => ['description' => '任务组名', 'type' => 'string', 'required' => false, 'example' => '任务组'],
],
[
'name' => 'RuleId',
'in' => 'query',
- 'schema' => [
- 'description' => '规则 ID',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'schema' => ['description' => '规则 ID', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
[
'name' => 'RunnableTimeFrom',
'in' => 'query',
- 'schema' => [
- 'description' => '可执行的时间范围',
- 'type' => 'string',
- 'required' => false,
- 'example' => '17:00',
- ],
+ 'schema' => ['description' => '可执行的时间范围', 'type' => 'string', 'required' => false, 'example' => '17:00'],
],
[
'name' => 'RunnableTimeTo',
'in' => 'query',
- 'schema' => [
- 'description' => '可执行的时间范围',
- 'type' => 'string',
- 'required' => false,
- 'example' => '18:00',
- ],
+ 'schema' => ['description' => '可执行的时间范围', 'type' => 'string', 'required' => false, 'example' => '18:00'],
],
[
'name' => 'TriggerPeriod',
'in' => 'query',
- 'schema' => [
- 'description' => '执行周期,immediately-立刻,weekly-每周,monthly-每月',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'immediately',
- ],
+ 'schema' => ['description' => '执行周期,immediately-立刻,weekly-每周,monthly-每月', 'type' => 'string', 'required' => false, 'example' => 'immediately'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '客户端幂等参数',
- 'type' => 'string',
- 'required' => false,
- 'example' => '无',
- ],
+ 'schema' => ['description' => '客户端幂等参数', 'type' => 'string', 'required' => false, 'example' => '无'],
],
[
'name' => 'Day',
@@ -2008,13 +962,7 @@
'schema' => [
'description' => '周期执行,比如每周3执行',
'type' => 'array',
- 'items' => [
- 'description' => '无',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '无',
- ],
+ 'items' => ['description' => '无', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '无'],
'required' => false,
'example' => '3',
'maxItems' => 100,
@@ -2030,26 +978,12 @@
'items' => [
'type' => 'object',
'properties' => [
- 'VideoUrl' => [
- 'description' => '视频地址',
- 'type' => 'string',
- 'required' => false,
- 'example' => '18/mrtc//641905591891464_record_64190559189146412713.mp4',
- ],
- 'VideoMetaUrl' => [
- 'description' => '视频 meta 地址',
- 'type' => 'string',
- 'required' => false,
- 'example' => '18/mrtc//641905591891464_record_64190559189146412713.mp4.meta',
- ],
- 'RuleId' => [
- 'description' => '规则id',
- 'type' => 'string',
- 'required' => false,
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'VideoUrl' => ['description' => '视频地址', 'type' => 'string', 'required' => false, 'example' => '18/mrtc//641905591891464_record_64190559189146412713.mp4'],
+ 'VideoMetaUrl' => ['description' => '视频 meta 地址', 'type' => 'string', 'required' => false, 'example' => '18/mrtc//641905591891464_record_64190559189146412713.mp4.meta'],
+ 'RuleId' => ['description' => '规则id', 'type' => 'string', 'required' => false, 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
'required' => false,
+ 'description' => '',
],
'required' => true,
'maxItems' => 1000,
@@ -2062,75 +996,25 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '响应信息',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
'Data' => [
'description' => '无',
'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '状态',
- 'type' => 'string',
- 'example' => 'runnable',
- ],
- 'CompletedTasks' => [
- 'description' => '已完成任务数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'TotalTasks' => [
- 'description' => '总任务数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'CreatedAt' => [
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Name' => [
- 'description' => '任务组名',
- 'type' => 'string',
- 'example' => '任务组',
- ],
- 'Id' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
- 'RuleName' => [
- 'description' => '规则名称',
- 'type' => 'string',
- 'example' => 'default',
- ],
- 'RuleId' => [
- 'description' => '规则 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'Status' => ['description' => '状态', 'type' => 'string', 'example' => 'runnable'],
+ 'CompletedTasks' => ['description' => '已完成任务数', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'TotalTasks' => ['description' => '总任务数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'CreatedAt' => ['description' => '创建时间', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Name' => ['description' => '任务组名', 'type' => 'string', 'example' => '任务组'],
+ 'Id' => ['description' => 'ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
+ 'RuleName' => ['description' => '规则名称', 'type' => 'string', 'example' => 'default'],
+ 'RuleId' => ['description' => '规则 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
'TaskIds' => [
'description' => '任务 ID 列表',
'type' => 'array',
- 'items' => [
- 'description' => '任务组下的任务 ID 列表',
- 'type' => 'string',
- 'example' => '["1"]',
- ],
+ 'items' => ['description' => '任务组下的任务 ID 列表', 'type' => 'string', 'example' => '["1"]'],
],
],
],
@@ -2140,34 +1024,19 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Data\\": {\\n \\"Status\\": \\"runnable\\",\\n \\"CompletedTasks\\": 0,\\n \\"TotalTasks\\": 1,\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Name\\": \\"任务组\\",\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"RuleName\\": \\"default\\",\\n \\"RuleId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"TaskIds\\": [\\n \\"[\\\\\\"1\\\\\\"]\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<Message/>\\n<RequestId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</RequestId>\\n<Data>\\n <Status>runnable</Status>\\n <TaskIds/>\\n <CreatedAt>2020-07-14T14:01:41.000+08:00</CreatedAt>\\n <RuleId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</RuleId>\\n <TotalTasks/>\\n <CompletedTasks>0</CompletedTasks>\\n <Id>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</Id>\\n <RuleName>default</RuleName>\\n <Name>任务组</Name>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
@@ -2176,15 +1045,119 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2022-02-21T07:17:02.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'idrsservice:CreateTaskGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
- 'CreateUserDepartments' => [
- 'methods' => [
- 'post',
+ 'CreateTtsQuestion' => [
+ 'summary' => '单向视频双录-创建TTS问题',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create'],
+ 'parameters' => [
+ [
+ 'name' => 'Request',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '请求参数',
+ 'type' => 'object',
+ 'properties' => [
+ 'QuestionGroupId' => ['description' => 'TTS问题组ID', 'type' => 'string', 'required' => true, 'example' => '47584ba4-9781-496b-8e6f-c8525a213***'."\n"],
+ 'Question' => ['description' => '问题', 'type' => 'string', 'required' => true, 'example' => '您可以根据自己需求填写'],
+ 'Answer' => ['description' => '回复', 'type' => 'string', 'required' => true, 'example' => '您可以根据自己需求填写'],
+ ],
+ 'required' => true,
+ ],
+ ],
],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'ApiResult<IdResponseDTO>',
+ 'description' => 'ApiResult<IdResponseDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D9AA9055-F73D-592C-832B-5AEECB093***'],
+ 'Code' => ['description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => 'OK'],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '-'],
+ 'Data' => [
+ 'description' => '数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => 'ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4ba***'],
+ ],
+ ],
+ 'Success' => ['title' => '给 pop 使用的', 'description' => '给 pop 使用的', 'type' => 'boolean', 'example' => 'True'],
+ 'HttpCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
+ ],
+ [
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
+ ],
+ 403 => [
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D9AA9055-F73D-592C-832B-5AEECB093***\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"-\\",\\n \\"Data\\": {\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4ba***\\"\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200\\n}","type":"json"}]',
+ 'title' => '创建TTS问题',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-29T07:30:49.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-08-26T03:41:52.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'idrsservice:CreateTtsQuestion',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'CreateTtsQuestionGroup' => [
+ 'summary' => '单向视频双录-创建TTS问题组',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2192,9 +1165,100 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
+ 'systemTags' => ['operationType' => 'create'],
+ 'parameters' => [
+ [
+ 'name' => 'Request',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '请求参数',
+ 'type' => 'object',
+ 'properties' => [
+ 'Voice' => ['description' => '发音人', 'type' => 'string', 'required' => false, 'example' => 'xiaoyun'],
+ 'Format' => ['description' => '音频编码格式', 'type' => 'string', 'required' => false, 'example' => 'PCM'],
+ 'Volume' => ['description' => '音量大小,取值范围:0~100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'],
+ 'SampleRate' => ['description' => '音频采样率', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '16000'],
+ 'SpeechRate' => ['description' => '语速,取值范围:-500~500。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'],
+ 'PitchRate' => ['description' => '音调,取值范围:-500~500。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'],
+ ],
+ 'required' => true,
+ ],
+ ],
],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'ApiResult<IdResponseDTO>',
+ 'description' => 'ApiResult<IdResponseDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '为保证一致,建议统一使用requestid', 'type' => 'string', 'example' => 'B2AADC9E-2A58-5918-AE4E-FF59E19D7***'],
+ 'Code' => ['description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => 'OK'],
+ 'Message' => ['description' => '错误消息', 'type' => 'string', 'example' => '-'],
+ 'Data' => [
+ 'description' => '数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => 'TTS任务组唯一ID', 'type' => 'string', 'example' => '63bb629d-92bf-4cdc-ad0b-3032c926d***'],
+ ],
+ ],
+ 'Success' => ['title' => '给 pop 使用的', 'description' => '给 pop 使用的', 'type' => 'boolean', 'example' => 'True'],
+ 'HttpCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
+ ],
+ [
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
+ ],
+ 403 => [
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B2AADC9E-2A58-5918-AE4E-FF59E19D7***\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"-\\",\\n \\"Data\\": {\\n \\"Id\\": \\"63bb629d-92bf-4cdc-ad0b-3032c926d***\\"\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200\\n}","type":"json"}]',
+ 'title' => '创建TTS问题组',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-26T03:41:52.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'idrsservice:CreateTtsQuestionGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'CreateUserDepartments' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'UserId',
@@ -2203,12 +1267,7 @@
'schema' => [
'description' => '用户 ID',
'type' => 'array',
- 'items' => [
- 'description' => '无',
- 'type' => 'string',
- 'required' => false,
- 'example' => '无',
- ],
+ 'items' => ['description' => '无', 'type' => 'string', 'required' => false, 'example' => '无'],
'required' => true,
'maxItems' => 1000,
],
@@ -2220,12 +1279,7 @@
'schema' => [
'description' => '部门 ID',
'type' => 'array',
- 'items' => [
- 'description' => '无',
- 'type' => 'string',
- 'required' => false,
- 'example' => '无',
- ],
+ 'items' => ['description' => '无', 'type' => 'string', 'required' => false, 'example' => '无'],
'required' => true,
'maxItems' => 10000,
],
@@ -2233,12 +1287,7 @@
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '客户端幂等参数',
- 'type' => 'string',
- 'required' => false,
- 'example' => '无',
- ],
+ 'schema' => ['description' => '客户端幂等参数', 'type' => 'string', 'required' => false, 'example' => '无'],
],
],
'responses' => [
@@ -2247,75 +1296,53 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '0B576AAB-A638-5029-9A54-A7C1DB5AC0B3',
- ],
- 'Data' => [
- 'description' => '返回数据',
- 'type' => 'object',
- 'example' => '无',
- ],
- 'Code' => [
- 'description' => '返回码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '0B576AAB-A638-5029-9A54-A7C1DB5AC0B3'],
+ 'Data' => ['description' => '返回数据', 'type' => 'object', 'example' => '无'],
+ 'Code' => ['description' => '返回码', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"0B576AAB-A638-5029-9A54-A7C1DB5AC0B3\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]',
'title' => '创建用户部门关系',
'summary' => '调用 CreateUserDepartments 创建用户部门关系。',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'idrsservice:CreateUserDepartments',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'CreateWatermark' => [
'summary' => '创建水印',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2323,29 +1350,17 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'Value',
'in' => 'query',
- 'schema' => [
- 'description' => '水印配置信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
+ 'schema' => ['description' => '水印配置信息', 'type' => 'string', 'required' => false, 'example' => '{}'],
],
[
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '水印名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文字水印',
- ],
+ 'schema' => ['description' => '水印名称', 'type' => 'string', 'required' => false, 'example' => '文字水印'],
],
],
'responses' => [
@@ -2355,67 +1370,22 @@
'description' => 'ApiResult<WatermarkDTO>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'requestId',
- 'description' => 'requestId',
- 'type' => 'string',
- 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942',
- ],
- 'Code' => [
- 'title' => 'code',
- 'description' => 'code',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'title' => '提示',
- 'description' => '提示',
- 'type' => 'string',
- 'example' => '-',
- ],
+ 'RequestId' => ['title' => 'requestId', 'description' => 'requestId', 'type' => 'string', 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942'],
+ 'Code' => ['title' => 'code', 'description' => 'code', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['title' => '提示', 'description' => '提示', 'type' => 'string', 'example' => '-'],
'Data' => [
'title' => '数据',
'description' => '数据',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '水印id',
- 'description' => '水印 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
- 'CreatedAt' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Value' => [
- 'title' => '水印信息',
- 'description' => '水印信息',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'Name' => [
- 'title' => '水印名称',
- 'description' => '水印名称',
- 'type' => 'string',
- 'example' => '名称',
- ],
+ 'Id' => ['title' => '水印id', 'description' => '水印 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
+ 'CreatedAt' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Value' => ['title' => '水印信息', 'description' => '水印信息', 'type' => 'string', 'example' => '{}'],
+ 'Name' => ['title' => '水印名称', 'description' => '水印名称', 'type' => 'string', 'example' => '名称'],
],
],
- 'Success' => [
- 'title' => '给 pop 使用的',
- 'description' => '给 pop 使用的',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'HttpCode' => [
- 'description' => 'HTTP 状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Success' => ['title' => '给 pop 使用的', 'description' => '给 pop 使用的', 'type' => 'boolean', 'example' => 'True'],
+ 'HttpCode' => ['description' => 'HTTP 状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Errors' => [
'title' => '错误列表',
'description' => '错误列表',
@@ -2424,16 +1394,8 @@
'description' => '-',
'type' => 'object',
'properties' => [
- 'Field' => [
- 'description' => '错误 ID',
- 'type' => 'string',
- 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942',
- ],
- 'Message' => [
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '-',
- ],
+ 'Field' => ['description' => '错误 ID', 'type' => 'string', 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942'],
+ 'Message' => ['description' => '错误消息', 'type' => 'string', 'example' => '-'],
],
],
],
@@ -2443,47 +1405,48 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A1899517-BB99-5D3E-A71B-97524DCB0942\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"-\\",\\n \\"Data\\": {\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Value\\": \\"{}\\",\\n \\"Name\\": \\"名称\\"\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200,\\n \\"Errors\\": [\\n {\\n \\"Field\\": \\"A1899517-BB99-5D3E-A71B-97524DCB0942\\",\\n \\"Message\\": \\"-\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '创建水印信息',
+ 'changeSet' => [
+ ['createdAt' => '2022-01-05T06:05:26.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-01-04T11:03:18.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-01-04T06:28:43.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'idrsservice:CreateWatermark',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'DeleteApp' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2491,20 +1454,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
- 'schema' => [
- 'description' => '应用 ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'schema' => ['description' => '应用 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
],
'responses' => [
@@ -2513,26 +1468,10 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942',
- ],
- 'Data' => [
- 'description' => '数据',
- 'type' => 'object',
- 'example' => '无',
- ],
- 'Code' => [
- 'description' => '返回码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Message' => ['description' => '错误消息', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942'],
+ 'Data' => ['description' => '数据', 'type' => 'object', 'example' => '无'],
+ 'Code' => ['description' => '返回码', 'type' => 'string', 'example' => 'OK'],
],
],
],
@@ -2540,80 +1479,68 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'code' => [
- 'type' => 'string',
- ],
- 'data' => [
- 'type' => 'object',
- ],
- 'requestId' => [
- 'type' => 'string',
- ],
- 'message' => [
- 'type' => 'string',
- ],
+ 'code' => ['type' => 'string', 'description' => ''],
+ 'data' => ['type' => 'object', 'description' => ''],
+ 'requestId' => ['type' => 'string', 'description' => ''],
+ 'message' => ['type' => 'string', 'description' => ''],
'errors' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'message' => [
- 'type' => 'string',
- ],
- 'field' => [
- 'type' => 'string',
- ],
+ 'message' => ['type' => 'string', 'description' => ''],
+ 'field' => ['type' => 'string', 'description' => ''],
],
+ 'description' => '',
],
+ 'description' => '',
],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"A1899517-BB99-5D3E-A71B-97524DCB0942\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]',
'title' => '删除应用',
'summary' => '调用 DeleteApp 删除应用。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'idrsservice:DeleteApp',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'DeleteDepartment' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2621,20 +1548,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
- 'schema' => [
- 'description' => '部门 ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'schema' => ['description' => '部门 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
],
'responses' => [
@@ -2643,74 +1562,55 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942',
- ],
- 'Data' => [
- 'description' => '数据',
- 'type' => 'object',
- 'example' => '无',
- ],
- 'Code' => [
- 'description' => '返回码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942'],
+ 'Data' => ['description' => '数据', 'type' => 'object', 'example' => '无'],
+ 'Code' => ['description' => '返回码', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"A1899517-BB99-5D3E-A71B-97524DCB0942\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]',
'title' => '删除部门',
'summary' => '调用 DeleteDepartment 删除部门。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'idrsservice:DeleteDepartment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'DeleteDetectProcess' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2718,20 +1618,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
- 'schema' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '0f1c45cd-3eee-4e60-b505-2e330b8755d3',
- ],
+ 'schema' => ['description' => 'ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0f1c45cd-3eee-4e60-b505-2e330b8755d3'],
],
],
'responses' => [
@@ -2740,60 +1632,29 @@
'description' => '-',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '1fdc45cd-3eee-4e60-b505-2e330b8755d3',
- ],
- 'Data' => [
- 'description' => '数据',
- 'type' => 'object',
- 'example' => '-',
- ],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '-'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '1fdc45cd-3eee-4e60-b505-2e330b8755d3'],
+ 'Data' => ['description' => '数据', 'type' => 'object', 'example' => '-'],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"-\\",\\n \\"RequestId\\": \\"1fdc45cd-3eee-4e60-b505-2e330b8755d3\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>1fdc45cd-3eee-4e60-b505-2e330b8755d3</RequestId>\\n<Message>-</Message>\\n<Data>-</Data>\\n<Code>OK</Code>","errorExample":""}]',
@@ -2802,15 +1663,27 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'idrsservice:DeleteDetectProcess',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'DeleteRule' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2818,20 +1691,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
- 'schema' => [
- 'description' => '规则 ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'schema' => ['description' => '规则 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
],
'responses' => [
@@ -2840,81 +1705,38 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
'Data' => [
'description' => '无',
'type' => 'object',
'properties' => [
- 'CreatedAt' => [
- 'description' => '创建日期',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Name' => [
- 'description' => '名称',
- 'type' => 'string',
- 'example' => 'default',
- ],
- 'Content' => [
- 'description' => '规则内容',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'Id' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'CreatedAt' => ['description' => '创建日期', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Name' => ['description' => '名称', 'type' => 'string', 'example' => 'default'],
+ 'Content' => ['description' => '规则内容', 'type' => 'string', 'example' => '{}'],
+ 'Id' => ['description' => 'ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Data\\": {\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Name\\": \\"default\\",\\n \\"Content\\": \\"{}\\",\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<Message>-</Message>\\n<RequestId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</RequestId>\\n<Data>\\n <Content>{}</Content>\\n <CreatedAt>2020-07-14T14:01:41.000+08:00</CreatedAt>\\n <Id>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</Id>\\n <Name>default</Name>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
@@ -2923,15 +1745,27 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'idrsservice:DeleteRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'DeleteUser' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2939,20 +1773,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
- 'schema' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'schema' => ['description' => 'ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
],
'responses' => [
@@ -2968,73 +1794,34 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '无',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'Field' => [
- 'description' => '无',
- 'type' => 'string',
- 'example' => '无',
- ],
+ 'Message' => ['description' => '无', 'type' => 'string', 'example' => '无'],
+ 'Field' => ['description' => '无', 'type' => 'string', 'example' => '无'],
],
],
],
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
- 'Data' => [
- 'description' => '数据',
- 'type' => 'object',
- 'example' => '无',
- ],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
+ 'Data' => ['description' => '数据', 'type' => 'object', 'example' => '无'],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Errors\\": [\\n {\\n \\"Message\\": \\"无\\",\\n \\"Field\\": \\"无\\"\\n }\\n ],\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<Errors>\\n <Field>-</Field>\\n <Message>-</Message>\\n</Errors>\\n<Message>-</Message>\\n<RequestId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</RequestId>\\n<Data>-</Data>\\n<Code>OK</Code>","errorExample":""}]',
@@ -3043,15 +1830,27 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'idrsservice:DeleteUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'DeleteUserDepartments' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3059,9 +1858,7 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'UserId',
@@ -3070,12 +1867,7 @@
'schema' => [
'description' => '用户 ID',
'type' => 'array',
- 'items' => [
- 'description' => '无',
- 'type' => 'string',
- 'required' => false,
- 'example' => '无',
- ],
+ 'items' => ['description' => '无', 'type' => 'string', 'required' => false, 'example' => '无'],
'required' => true,
'maxItems' => 1000,
],
@@ -3087,12 +1879,7 @@
'schema' => [
'description' => '部门 ID',
'type' => 'array',
- 'items' => [
- 'description' => '无',
- 'type' => 'string',
- 'required' => false,
- 'example' => '无',
- ],
+ 'items' => ['description' => '无', 'type' => 'string', 'required' => false, 'example' => '无'],
'required' => true,
'maxItems' => 10000,
],
@@ -3104,74 +1891,55 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '48A2B2E2-9995-5220-B77C-871119CB05CC',
- ],
- 'Data' => [
- 'description' => '返回数据',
- 'type' => 'object',
- 'example' => '无',
- ],
- 'Code' => [
- 'description' => '返回码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Message' => ['description' => '错误消息', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '48A2B2E2-9995-5220-B77C-871119CB05CC'],
+ 'Data' => ['description' => '返回数据', 'type' => 'object', 'example' => '无'],
+ 'Code' => ['description' => '返回码', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"48A2B2E2-9995-5220-B77C-871119CB05CC\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]',
'title' => '删除用户部门关系',
'summary' => '调用 DeleteUserDepartments 删除用户部门关系。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'idrsservice:DeleteUserDepartments',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'DeleteWatermark' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3179,19 +1947,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'WatermarkId',
'in' => 'query',
- 'schema' => [
- 'description' => '水印 ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'e5a923e0e727f212813a195e274b02c6',
- ],
+ 'schema' => ['description' => '水印 ID', 'type' => 'string', 'required' => false, 'example' => 'e5a923e0e727f212813a195e274b02c6'],
],
],
'responses' => [
@@ -3201,67 +1962,22 @@
'description' => 'ApiResult<WatermarkDTO>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'requestId',
- 'description' => 'requestId',
- 'type' => 'string',
- 'example' => '84118BF0-56F7-54D2-8C1A-35BBBBD5016B',
- ],
- 'Code' => [
- 'title' => 'code',
- 'description' => 'code',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'title' => '提示',
- 'description' => '提示',
- 'type' => 'string',
- 'example' => '-',
- ],
+ 'RequestId' => ['title' => 'requestId', 'description' => 'requestId', 'type' => 'string', 'example' => '84118BF0-56F7-54D2-8C1A-35BBBBD5016B'],
+ 'Code' => ['title' => 'code', 'description' => 'code', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['title' => '提示', 'description' => '提示', 'type' => 'string', 'example' => '-'],
'Data' => [
'title' => '数据',
'description' => '数据',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '水印id',
- 'description' => '水印 ID',
- 'type' => 'string',
- 'example' => '0f1c45cd-3eee-4e60-b505-2e330b8755d3',
- ],
- 'CreatedAt' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Value' => [
- 'title' => '水印信息',
- 'description' => '水印信息',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'Name' => [
- 'title' => '水印名称',
- 'description' => '水印名称',
- 'type' => 'string',
- 'example' => '名称',
- ],
+ 'Id' => ['title' => '水印id', 'description' => '水印 ID', 'type' => 'string', 'example' => '0f1c45cd-3eee-4e60-b505-2e330b8755d3'],
+ 'CreatedAt' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Value' => ['title' => '水印信息', 'description' => '水印信息', 'type' => 'string', 'example' => '{}'],
+ 'Name' => ['title' => '水印名称', 'description' => '水印名称', 'type' => 'string', 'example' => '名称'],
],
],
- 'Success' => [
- 'title' => '给 pop 使用的',
- 'description' => '给 pop 使用的',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'HttpCode' => [
- 'description' => 'HTTP 状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Success' => ['title' => '给 pop 使用的', 'description' => '给 pop 使用的', 'type' => 'boolean', 'example' => 'True'],
+ 'HttpCode' => ['description' => 'HTTP 状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Errors' => [
'title' => '错误列表',
'description' => '错误列表',
@@ -3270,16 +1986,8 @@
'description' => '-',
'type' => 'object',
'properties' => [
- 'Field' => [
- 'description' => '错误 ID',
- 'type' => 'string',
- 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942',
- ],
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '-',
- ],
+ 'Field' => ['description' => '错误 ID', 'type' => 'string', 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942'],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '-'],
],
],
],
@@ -3289,47 +1997,339 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
+ ],
+ [
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
+ ],
+ 403 => [
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"84118BF0-56F7-54D2-8C1A-35BBBBD5016B\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"-\\",\\n \\"Data\\": {\\n \\"Id\\": \\"0f1c45cd-3eee-4e60-b505-2e330b8755d3\\",\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Value\\": \\"{}\\",\\n \\"Name\\": \\"名称\\"\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200,\\n \\"Errors\\": [\\n {\\n \\"Field\\": \\"A1899517-BB99-5D3E-A71B-97524DCB0942\\",\\n \\"Message\\": \\"-\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '删除水印信息',
+ 'changeSet' => [
+ ['createdAt' => '2022-01-04T11:03:19.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'idrsservice:DeleteWatermark',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'FaceCompare' => [
+ 'summary' => '人脸对比',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none'],
+ 'parameters' => [
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
+ 'name' => 'FaceRequest',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '请求参数',
+ 'type' => 'object',
+ 'properties' => [
+ 'AppId' => ['title' => '应用信息', 'description' => '应用id', 'type' => 'string', 'required' => false, 'example' => 'd61be709-49d2-4cf1-b219-cd6181f72***'],
+ 'SourceImage' => ['title' => '人脸照片 base64', 'description' => '照片Base64编码。', 'type' => 'string', 'required' => false, 'example' => '/9j/4AAQSkZJRgABAQAASxxxxxxx'],
+ 'TargetImage' => ['title' => '底库照片 base64', 'description' => '底库照片Base64编码。', 'type' => 'string', 'required' => false, 'example' => '/9j/4AAQSkZJRgABAQAASxxxxxxx'],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'ApiResult<FaceResponseDTO>',
+ 'description' => 'ApiResult<FaceResponseDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4ba***'],
+ 'Code' => ['description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => 'OK'],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '-'],
+ 'Data' => [
+ 'description' => '数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => 'ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => '-'],
+ 'Passed' => ['description' => '认证是否通过。'."\n"
+ ."\n"
+ .'- T:通过。'."\n"
+ .'- F:不通过。', 'type' => 'string', 'example' => 'T'],
+ 'VerifyScore' => ['description' => '人脸比对分。', 'type' => 'number', 'format' => 'float', 'example' => '60.86'],
+ 'Status' => ['description' => '状态', 'type' => 'string', 'example' => 'completed'],
+ ],
+ ],
+ 'Success' => ['title' => '给 pop 使用的', 'description' => '给 pop 使用的', 'type' => 'boolean', 'example' => 'True'],
+ 'HttpCode' => ['description' => 'HTTP 状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ ],
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
+ ],
+ [
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
+ ],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4ba***\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"-\\",\\n \\"Data\\": {\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"-\\",\\n \\"Passed\\": \\"T\\",\\n \\"VerifyScore\\": 60.86,\\n \\"Status\\": \\"completed\\"\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200\\n}","type":"json"}]',
+ 'title' => '人脸对比',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-08T02:21:10.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-07-08T02:03:24.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-07-07T13:28:03.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-07-07T09:05:44.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'idrsservice:FaceCompare',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'FaceLiveness' => [
+ 'summary' => '单向视频双录-静默活体',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none'],
+ 'parameters' => [
+ [
+ 'name' => 'FaceRequest',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '请求参数',
+ 'type' => 'object',
+ 'properties' => [
+ 'AppId' => ['description' => '双录质检应用ID', 'type' => 'string', 'required' => true, 'example' => 'd61be709-49d2-4cf1-b219-cd6181f72***'],
+ 'SourceImage' => ['description' => '照片Base64编码。', 'type' => 'string', 'required' => true, 'example' => '/9j/4AAQSkZJRgABAQAASxxxxxxx'],
+ ],
+ 'required' => true,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'ApiResult<FaceLivenessResponseDTO>',
+ 'description' => 'ApiResult<FaceLivenessResponseDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => '7AC54DAF-38F8-58C7-8383-3131FEDDA***'],
+ 'Code' => ['description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => 'OK'],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '-'],
+ 'Data' => [
+ 'description' => '数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'PublicId' => ['title' => '人脸任务ID', 'description' => '人脸任务ID', 'type' => 'string', 'example' => 'd61be709-49d2-4cf1-b219-cd6181f72***'."\n"],
+ 'Code' => ['title' => '人脸接口返回的code', 'description' => '人脸接口返回的code', 'type' => 'string', 'example' => '2000000'],
+ 'Message' => ['title' => '人脸接口返回的错误信息', 'description' => '人脸接口返回的错误信息', 'type' => 'string', 'example' => 'success'],
+ 'Passed' => ['title' => '识别是否通过', 'description' => '识别是否通过', 'type' => 'string', 'example' => 'T'],
+ 'Score' => ['title' => '分值', 'description' => '分值', 'type' => 'number', 'format' => 'float', 'example' => '3.24324324324'],
+ 'Status' => ['title' => '任务状态', 'description' => '任务状态', 'type' => 'string', 'example' => 'COMPLETED'],
+ ],
+ ],
+ 'Success' => ['title' => '给 pop 使用的', 'description' => '给 pop 使用的', 'type' => 'boolean', 'example' => 'True'],
+ 'HttpCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ ],
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
+ ],
+ [
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
+ ],
+ 403 => [
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
+ ],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7AC54DAF-38F8-58C7-8383-3131FEDDA***\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"-\\",\\n \\"Data\\": {\\n \\"PublicId\\": \\"d61be709-49d2-4cf1-b219-cd6181f72***\\\\n\\",\\n \\"Code\\": \\"2000000\\",\\n \\"Message\\": \\"success\\",\\n \\"Passed\\": \\"T\\",\\n \\"Score\\": 3.24324324324,\\n \\"Status\\": \\"COMPLETED\\"\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200\\n}","type":"json"}]',
+ 'title' => '静默活体检测',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-26T03:41:52.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'idrsservice:FaceLiveness',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"84118BF0-56F7-54D2-8C1A-35BBBBD5016B\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"-\\",\\n \\"Data\\": {\\n \\"Id\\": \\"0f1c45cd-3eee-4e60-b505-2e330b8755d3\\",\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Value\\": \\"{}\\",\\n \\"Name\\": \\"名称\\"\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200,\\n \\"Errors\\": [\\n {\\n \\"Field\\": \\"A1899517-BB99-5D3E-A71B-97524DCB0942\\",\\n \\"Message\\": \\"-\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '删除水印信息',
],
- 'GetApp' => [
- 'methods' => [
- 'post',
+ 'FaceRecognize' => [
+ 'summary' => '单向视频双录-人脸识别静默活体',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none'],
+ 'parameters' => [
+ [
+ 'name' => 'FaceRequest',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '请求参数',
+ 'type' => 'object',
+ 'properties' => [
+ 'AppId' => ['description' => '双录质检应用ID', 'type' => 'string', 'required' => true, 'example' => 'd61be709-49d2-4cf1-b219-cd6181f72***'],
+ 'SourceImage' => ['description' => '照片Base64编码。', 'type' => 'string', 'required' => true, 'example' => '/9j/4AAQSkZJRgABAQAASxxxxxxx'],
+ 'TargetImage' => ['description' => '底库照片Base64编码。', 'type' => 'string', 'required' => true, 'example' => '/9j/4AAQSkZJRgABAQAASxxxxxxx'],
+ 'Liveness' => ['description' => '是否检测真人', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ 'required' => true,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'ApiResult<FaceRecognizeResponseDTO>',
+ 'description' => 'ApiResult<FaceRecognizeResponseDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4ba***'],
+ 'Code' => ['description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => 'OK'],
+ 'Message' => ['description' => '错误消息', 'type' => 'string', 'example' => '-'],
+ 'Data' => [
+ 'description' => '数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'ComparePassed' => ['title' => '识别是否通过', 'description' => '识别是否通过', 'type' => 'string', 'example' => 'T '],
+ 'CompareScore' => ['title' => '分值', 'description' => '分值', 'type' => 'number', 'format' => 'float', 'example' => '32.435'],
+ 'LivenessPassed' => ['title' => '识别是否通过', 'description' => '识别是否通过', 'type' => 'string', 'example' => 'T'],
+ 'LivenessScore' => ['title' => '分值', 'description' => '分值', 'type' => 'number', 'format' => 'float', 'example' => '56.34'],
+ ],
+ ],
+ 'Success' => ['title' => '给 pop 使用的', 'description' => '给 pop 使用的', 'type' => 'boolean', 'example' => 'True'],
+ 'HttpCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
+ ],
+ [
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
+ ],
+ 403 => [
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4ba***\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"-\\",\\n \\"Data\\": {\\n \\"ComparePassed\\": \\"T \\",\\n \\"CompareScore\\": 32.435,\\n \\"LivenessPassed\\": \\"T\\",\\n \\"LivenessScore\\": 56.34\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200\\n}","type":"json"}]',
+ 'title' => '人脸识别',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-26T03:41:52.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'idrsservice:FaceRecognize',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetApp' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3337,62 +2337,32 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
- 'schema' => [
- 'description' => '应用 ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'schema' => ['description' => '应用 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
[
'name' => 'PackageName',
'in' => 'query',
- 'schema' => [
- 'description' => '包名',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'com.a.test',
- ],
+ 'schema' => ['description' => '包名', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'com.a.test'],
],
[
'name' => 'DeviceId',
'in' => 'query',
- 'schema' => [
- 'description' => '设备 ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'xxx-xxx-xxx',
- ],
+ 'schema' => ['description' => '设备 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'xxx-xxx-xxx'],
],
[
'name' => 'ClientVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '客户端版本',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1.0.002',
- ],
+ 'schema' => ['description' => '客户端版本', 'type' => 'string', 'required' => false, 'example' => '1.0.002'],
],
[
'name' => 'ClientBaseParam',
'in' => 'query',
- 'schema' => [
- 'description' => '客户端基础参数,记录 SDK 版本号等信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"version":"1.0.0"}',
- ],
+ 'schema' => ['description' => '客户端基础参数,记录 SDK 版本号等信息', 'type' => 'string', 'required' => false, 'example' => '{"version":"1.0.0"}'],
],
],
'responses' => [
@@ -3401,86 +2371,39 @@
'description' => '返回数据',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
'Data' => [
'description' => '无',
'type' => 'object',
'properties' => [
- 'CreatedAt' => [
- 'description' => '创建日期',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'Disabled' => [
- 'description' => '关闭状态',
- 'type' => 'string',
- 'example' => 'false',
- ],
- 'Name' => [
- 'description' => '应用名称',
- 'type' => 'string',
- 'example' => '应用',
- ],
- 'Config' => [
- 'description' => '客户端相关配置',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'FeeId' => [
- 'description' => '对账 ID',
- 'type' => 'string',
- 'example' => 'ff1d7783-e087-4d62-92df-3a163eca7c07',
- ],
+ 'CreatedAt' => ['description' => '创建日期', 'type' => 'string', 'example' => '1'],
+ 'Disabled' => ['description' => '关闭状态', 'type' => 'string', 'example' => 'false'],
+ 'Name' => ['description' => '应用名称', 'type' => 'string', 'example' => '应用'],
+ 'Config' => ['description' => '客户端相关配置', 'type' => 'string', 'example' => '{}'],
+ 'FeeId' => ['description' => '对账 ID', 'type' => 'string', 'example' => 'ff1d7783-e087-4d62-92df-3a163eca7c07'],
],
],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Data\\": {\\n \\"CreatedAt\\": \\"1\\",\\n \\"Disabled\\": \\"false\\",\\n \\"Name\\": \\"应用\\",\\n \\"Config\\": \\"{}\\",\\n \\"FeeId\\": \\"ff1d7783-e087-4d62-92df-3a163eca7c07\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<Message>-</Message>\\n<RequestId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</RequestId>\\n<Data>\\n <CreatedAt>1</CreatedAt>\\n <Disabled>false</Disabled>\\n <Name>应用</Name>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
@@ -3489,15 +2412,112 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2022-02-21T08:32:04.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2022-01-24T04:47:39.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2022-01-14T07:35:14.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetApp',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
- 'GetDepartment' => [
- 'methods' => [
- 'post',
+ 'GetAsrResult' => [
+ 'summary' => '单向视频双录-获取语音识别结果',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
+ [
+ 'name' => 'AsrTaskId',
+ 'in' => 'query',
+ 'schema' => ['description' => '任务id', 'type' => 'string', 'required' => true, 'example' => 'B2AADC9E-2A58-5918-AE4E-FF59E19D7***'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'ApiResult<ResultResponseDTO>',
+ 'description' => 'ApiResult<ResultResponseDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '唯一请求识别码', 'type' => 'string', 'example' => 'C14ED32C-B9E4-54E7-BA85-C2B562C5B***'],
+ 'Code' => ['description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => 'OK'],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '-'],
+ 'Data' => [
+ 'description' => '数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => ['description' => 'asr识别出的文本', 'type' => 'string', 'example' => '北京的天气'],
+ ],
+ ],
+ 'Success' => ['title' => '给 pop 使用的', 'description' => '给 pop 使用的', 'type' => 'boolean', 'example' => 'True'],
+ 'HttpCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
+ ],
+ [
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
+ ],
+ 403 => [
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C14ED32C-B9E4-54E7-BA85-C2B562C5B***\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"-\\",\\n \\"Data\\": {\\n \\"Result\\": \\"北京的天气\\"\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200\\n}","type":"json"}]',
+ 'title' => '获取ASR任务结果',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-26T03:41:52.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetAsrResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetDepartment' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3505,30 +2525,17 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
- 'schema' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'schema' => ['description' => 'ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
[
'name' => 'ClientBaseParam',
'in' => 'query',
- 'schema' => [
- 'description' => '客户端基础参数,记录 SDK 版本号等信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"version":"1.0.0"}',
- ],
+ 'schema' => ['description' => '客户端基础参数,记录 SDK 版本号等信息', 'type' => 'string', 'required' => false, 'example' => '{"version":"1.0.0"}'],
],
],
'responses' => [
@@ -3537,86 +2544,39 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'Message' => ['description' => '错误消息', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
'Data' => [
'description' => '无',
'type' => 'object',
'properties' => [
- 'Description' => [
- 'description' => '描述',
- 'type' => 'string',
- 'example' => '描述',
- ],
- 'CreatedAt' => [
- 'description' => '创建日期',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'UpdatedAt' => [
- 'description' => '更新日期',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Name' => [
- 'description' => '姓名',
- 'type' => 'string',
- 'example' => '名称',
- ],
- 'Id' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'Description' => ['description' => '描述', 'type' => 'string', 'example' => '描述'],
+ 'CreatedAt' => ['description' => '创建日期', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'UpdatedAt' => ['description' => '更新日期', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Name' => ['description' => '姓名', 'type' => 'string', 'example' => '名称'],
+ 'Id' => ['description' => 'ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
],
- 'Code' => [
- 'description' => '请求状态码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Code' => ['description' => '请求状态码', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Data\\": {\\n \\"Description\\": \\"描述\\",\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"UpdatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Name\\": \\"名称\\",\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</RequestId>\\n<Message>-</Message>\\n<Data>\\n <Description>描述</Description>\\n <CreatedAt>2020-07-14T14:01:41.000+08:00</CreatedAt>\\n <Id>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</Id>\\n <UpdatedAt>2020-07-14T14:01:41.000+08:00</UpdatedAt>\\n <Name>名称</Name>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
@@ -3625,15 +2585,29 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'GetDetection' => [
- 'methods' => [
- 'post',
+ 'changeSet' => [
+ ['createdAt' => '2022-02-21T07:17:01.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetDepartment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetDetectProcess' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3641,62 +2615,191 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
+ 'name' => 'Id',
+ 'in' => 'query',
+ 'schema' => ['description' => 'ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0f1c45cd-3eee-4e60-b505-2e330b87****'],
+ ],
+ [
'name' => 'ClientBaseParam',
'in' => 'query',
+ 'schema' => ['description' => '客户端基础参数,记录 SDK 版本号等信息', 'type' => 'string', 'required' => false, 'example' => '{"version":"1.0.0"}'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '客户端基础参数,记录 SDK 版本号等信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"version":"1.0.0"}',
+ 'description' => '无',
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '0q1c45cd-3eee-1e60-b505-2e330b8755d3'],
+ 'Data' => [
+ 'description' => '数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'Draft' => ['description' => ' '."\n"
+ .'流程配置草稿内容', 'type' => 'string', 'example' => '{}'],
+ 'CreatedAt' => ['description' => '创建时间', 'type' => 'string', 'example' => '2020-12-04T14:47:59.000+08:00'],
+ 'Md5' => ['description' => '流程配置正式内容的 MD5', 'type' => 'string', 'example' => '987d563d38f5aef27feca8702c689bb1'],
+ 'UpdatedAt' => ['description' => '更新时间', 'type' => 'string', 'example' => '2020-12-04T14:47:59.000+08:00'],
+ 'Name' => ['description' => '检测流程名称', 'type' => 'string', 'example' => 'Android检测流程'],
+ 'NewVersion' => ['description' => '是否有新版本', 'type' => 'boolean', 'example' => 'true'],
+ 'Content' => ['description' => '流程配置正式内容', 'type' => 'string', 'example' => '{}'],
+ 'Id' => ['description' => 'ID', 'type' => 'string', 'example' => '0f1c45cd-3eee-4e60-b505-2e330b8755d3'],
+ ],
+ ],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'OK'],
+ ],
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
+ ],
+ [
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
+ ],
+ 403 => [
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"0q1c45cd-3eee-1e60-b505-2e330b8755d3\\",\\n \\"Data\\": {\\n \\"Draft\\": \\"{}\\",\\n \\"CreatedAt\\": \\"2020-12-04T14:47:59.000+08:00\\",\\n \\"Md5\\": \\"987d563d38f5aef27feca8702c689bb1\\",\\n \\"UpdatedAt\\": \\"2020-12-04T14:47:59.000+08:00\\",\\n \\"Name\\": \\"Android检测流程\\",\\n \\"NewVersion\\": true,\\n \\"Content\\": \\"{}\\",\\n \\"Id\\": \\"0f1c45cd-3eee-4e60-b505-2e330b8755d3\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId/>\\n<Message/>\\n<Data>\\n <NewVersion>true</NewVersion>\\n <Draft>{}</Draft>\\n <Content>{}</Content>\\n <CreatedAt>2020-12-04T14:47:59.000+08:00</CreatedAt>\\n <Id>0f1c45cd-3eee-4e60-b505-2e330b8755d3</Id>\\n <UpdatedAt>2020-12-04T14:47:59.000+08:00</UpdatedAt>\\n <Md5>987d563d38f5aef27feca8702c689bb1</Md5>\\n <Name>Android检测流程</Name>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
+ 'title' => '获取检测流程信息',
+ 'summary' => '通过 GetDetectProcess 获取检测流程。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2022-02-21T07:17:01.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ ],
+ 'GetDetectProcessJsonFile' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
[
'name' => 'Id',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hpsk3wdo-2020122319'],
+ ],
+ [
+ 'name' => 'ClientBaseParam',
'in' => 'query',
+ 'schema' => ['description' => '客户端基础参数,记录 SDK 版本号等信息', 'type' => 'string', 'required' => false, 'example' => '{"version":"1.0.0"}'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
+ 'description' => '-',
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['description' => '错误消息', 'type' => 'string', 'example' => '-'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => 'B2695011-0604-5557-9E00-B74F58AB3F2B'],
+ 'Data' => ['description' => '数据', 'type' => 'string', 'example' => '-'],
+ 'Code' => ['description' => '返回码', 'type' => 'string', 'example' => 'OK'],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
+ ],
+ [
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
+ ],
+ 403 => [
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"-\\",\\n \\"RequestId\\": \\"B2695011-0604-5557-9E00-B74F58AB3F2B\\",\\n \\"Data\\": \\"-\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]',
+ 'title' => '获取检测流程配置的 JSON 文件',
+ 'changeSet' => [
+ ['createdAt' => '2022-02-21T07:17:01.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetDetectProcessJsonFile',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
+ ],
+ 'GetDetection' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
+ [
+ 'name' => 'ClientBaseParam',
+ 'in' => 'query',
+ 'schema' => ['description' => '客户端基础参数,记录 SDK 版本号等信息', 'type' => 'string', 'required' => false, 'example' => '{"version":"1.0.0"}'],
+ ],
+ [
+ 'name' => 'Id',
+ 'in' => 'query',
+ 'schema' => ['description' => 'ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
'description' => '-',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '-'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
'Data' => [
'description' => '-',
'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '状态',
- 'type' => 'string',
- 'example' => 'runnable',
- ],
- 'DepartmentName' => [
- 'description' => '部门名称',
- 'type' => 'string',
- 'example' => '部门',
- ],
+ 'Status' => ['description' => '状态', 'type' => 'string', 'example' => 'runnable'],
+ 'DepartmentName' => ['description' => '部门名称', 'type' => 'string', 'example' => '部门'],
'Tasks' => [
'description' => '任务列表',
'type' => 'array',
@@ -3704,105 +2807,42 @@
'description' => '-',
'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '任务状态',
- 'type' => 'string',
- 'example' => 'runnable',
- ],
- 'VideoMetaUrl' => [
- 'description' => '视频 meta 地址',
- 'type' => 'string',
- 'example' => 'http://oss.aliyun.com/1.mp4.meta',
- ],
- 'CreatedAt' => [
- 'description' => '创建日期',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Id' => [
- 'description' => '任务 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
- 'VideoUrl' => [
- 'description' => '视频地址',
- 'type' => 'string',
- 'example' => 'http://oss.aliyun.com/1.mp4',
- ],
+ 'Status' => ['description' => '任务状态', 'type' => 'string', 'example' => 'runnable'],
+ 'VideoMetaUrl' => ['description' => '视频 meta 地址', 'type' => 'string', 'example' => 'http://oss.aliyun.com/1.mp4.meta'],
+ 'CreatedAt' => ['description' => '创建日期', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Id' => ['description' => '任务 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
+ 'VideoUrl' => ['description' => '视频地址', 'type' => 'string', 'example' => 'http://oss.aliyun.com/1.mp4'],
],
],
],
- 'RecordingType' => [
- 'description' => '录制类型',
- 'type' => 'string',
- 'example' => 'local',
- ],
- 'CreatedAt' => [
- 'description' => '创建日期',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'DepartmentId' => [
- 'description' => '部门 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
- 'Id' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
- 'RuleName' => [
- 'description' => '规则名称',
- 'type' => 'string',
- 'example' => 'default',
- ],
- 'RuleId' => [
- 'description' => '规则 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'RecordingType' => ['description' => '录制类型', 'type' => 'string', 'example' => 'local'],
+ 'CreatedAt' => ['description' => '创建日期', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'DepartmentId' => ['description' => '部门 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
+ 'Id' => ['description' => 'ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
+ 'RuleName' => ['description' => '规则名称', 'type' => 'string', 'example' => 'default'],
+ 'RuleId' => ['description' => '规则 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
],
- 'Code' => [
- 'description' => '返回码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Code' => ['description' => '返回码', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"-\\",\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Data\\": {\\n \\"Status\\": \\"runnable\\",\\n \\"DepartmentName\\": \\"部门\\",\\n \\"Tasks\\": [\\n {\\n \\"Status\\": \\"runnable\\",\\n \\"VideoMetaUrl\\": \\"http://oss.aliyun.com/1.mp4.meta\\",\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"VideoUrl\\": \\"http://oss.aliyun.com/1.mp4\\"\\n }\\n ],\\n \\"RecordingType\\": \\"local\\",\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"DepartmentId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"RuleName\\": \\"default\\",\\n \\"RuleId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<Message>-</Message>\\n<RequestId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</RequestId>\\n<Data>\\n <Status>runnable</Status>\\n <Tasks>\\n <Status>runnable</Status>\\n <CreatedAt>2020-07-14T14:01:41.000+08:00</CreatedAt>\\n <VideoMetaUrl>http://oss.aliyun.com/1.mp4.meta</VideoMetaUrl>\\n <Id>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</Id>\\n <VideoUrl>http://oss.aliyun.com/1.mp4</VideoUrl>\\n </Tasks>\\n <RecordingType>local</RecordingType>\\n <CreatedAt>2020-07-14T14:01:41.000+08:00</CreatedAt>\\n <RuleId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</RuleId>\\n <DepartmentName>部门</DepartmentName>\\n <DepartmentId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</DepartmentId>\\n <Id>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</Id>\\n <RuleName>default</RuleName>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
@@ -3811,15 +2851,29 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'GetPreSignedUrl' => [
- 'methods' => [
- 'post',
+ 'changeSet' => [
+ ['createdAt' => '2022-02-21T07:17:01.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetDetection',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetPreSignedUrl' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3827,39 +2881,22 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClientVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '客户端版本。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1.0.001',
- ],
+ 'schema' => ['description' => '客户端版本。', 'type' => 'string', 'required' => false, 'example' => '1.0.001'],
],
[
'name' => 'ClientBaseParam',
'in' => 'query',
- 'schema' => [
- 'description' => '客户端基础参数,记录 SDK 版本号等信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"version":"1.0.0"}',
- ],
+ 'schema' => ['description' => '客户端基础参数,记录 SDK 版本号等信息', 'type' => 'string', 'required' => false, 'example' => '{"version":"1.0.0"}'],
],
[
'name' => 'Prefix',
'in' => 'formData',
- 'schema' => [
- 'description' => '前缀',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test.mp4',
- ],
+ 'schema' => ['description' => '前缀', 'type' => 'string', 'required' => false, 'example' => 'test.mp4'],
],
],
'responses' => [
@@ -3868,60 +2905,29 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '无',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
- 'Data' => [
- 'description' => '无',
- 'type' => 'string',
- 'example' => 'http://shuanglu-pre.oss-cn-beijing.aliyuncs.com/13ba4081-84f3-42b0-af93-10a64319f8ef/test.txt',
- ],
- 'Code' => [
- 'description' => '返回码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Message' => ['description' => '无', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
+ 'Data' => ['description' => '无', 'type' => 'string', 'example' => 'http://shuanglu-pre.oss-cn-beijing.aliyuncs.com/13ba4081-84f3-42b0-af93-10a64319f8ef/test.txt'],
+ 'Code' => ['description' => '返回码', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Data\\": \\"http://shuanglu-pre.oss-cn-beijing.aliyuncs.com/13ba4081-84f3-42b0-af93-10a64319f8ef/test.txt\\",\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<Message>-</Message>\\n<RequestId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</RequestId>\\n<Data>-</Data>\\n<Code>OK</Code>","errorExample":""}]',
@@ -3934,15 +2940,31 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'GetRule' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [
+ ['createdAt' => '2022-02-21T07:17:01.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-01-24T04:47:39.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetPreSignedUrl',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetRecordResult' => [
+ 'summary' => '根据ID查询录制信息',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3950,78 +2972,220 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'Id',
+ 'name' => 'RecordId',
'in' => 'query',
- 'schema' => [
- 'description' => '规则 ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'schema' => ['description' => '双录 ID', 'type' => 'string', 'required' => true, 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942'],
],
[
'name' => 'ClientBaseParam',
'in' => 'query',
- 'schema' => [
- 'description' => '客户端基础参数,记录 SDK 版本号等信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"version":"1.0.0"}',
- ],
+ 'schema' => ['description' => '客户端基础参数,记录 SDK 版本号等信息', 'type' => 'string', 'required' => false, 'example' => '{"version":"1.0.0"}'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '无',
+ 'title' => 'ApiResult<RecordDTO>',
+ 'description' => 'ApiResult<RecordDTO>',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'RequestId' => ['title' => 'requestId', 'description' => 'requestId', 'type' => 'string', 'example' => '84118BF0-56F7-54D2-8C1A-35BBBBD5016B'],
+ 'Code' => ['title' => 'code', 'description' => 'code', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['title' => '提示', 'description' => '提示', 'type' => 'string', 'example' => '无'],
'Data' => [
- 'description' => '无',
+ 'title' => '数据',
+ 'description' => '数据',
'type' => 'object',
'properties' => [
- 'CreatedAt' => [
- 'description' => '创建日期',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Name' => [
- 'description' => '名称',
- 'type' => 'string',
- 'example' => 'default',
+ 'Id' => ['title' => '双录记录id', 'description' => '双录记录 ID', 'type' => 'string', 'example' => '0f1c45cd-3eee-4e60-b505-2e330b8755d3'],
+ 'CreatedAt' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'DetectProcessName' => ['title' => '业务检测流程名', 'description' => '业务检测流程名', 'type' => 'string', 'example' => 'XX流程'],
+ 'DepartmentName' => ['title' => '部门名', 'description' => '部门名', 'type' => 'string', 'example' => 'XX部门'],
+ 'AppName' => ['title' => '应用名', 'description' => '应用名', 'type' => 'string', 'example' => 'XX应用'],
+ 'VideoUrl' => ['title' => '视频地址', 'description' => '视频地址', 'type' => 'string', 'example' => 'http://oss.aliyuncs.com/1.mp4'],
+ 'MetaUrl' => ['title' => 'meta地址', 'description' => 'meta 地址', 'type' => 'string', 'example' => 'http://oss.aliyuncs.com/1.mp4.meta'],
+ 'ResultUrl' => ['title' => '结果地址', 'description' => '结果地址', 'type' => 'string', 'example' => 'http://oss.aliyuncs.com/1.mp4.json'],
+ 'RecordAt' => ['title' => '录制时间', 'description' => '录制时间', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Duration' => ['title' => '时长', 'description' => '时长', 'type' => 'integer', 'format' => 'int64', 'example' => '22'],
+ 'Status' => ['title' => '检测状态', 'description' => '检测状态', 'type' => 'string', 'example' => 'completed'],
+ 'RoomId' => ['title' => 'mrtc房间id', 'description' => 'mrtc 房间 ID', 'type' => 'string', 'example' => '641981583353***'],
+ 'RecordRoomList' => [
+ 'title' => '远程双录文件地址列表',
+ 'description' => '远程双录文件地址列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '房间列表',
+ 'type' => 'object',
+ 'properties' => [
+ 'Role' => ['title' => '角色', 'description' => '角色', 'type' => 'string', 'example' => '21343'],
+ 'RoomVideoUrl' => ['title' => '视频地址', 'description' => '视频地址', 'type' => 'string', 'example' => 'http://oss.aliyuncs.com/1.mp4'],
+ 'RoomMetaUrl' => ['title' => 'meta地址', 'description' => 'meta 地址', 'type' => 'string', 'example' => 'http://oss.aliyuncs.com/1.mp4.meta'],
+ 'RoomResultUrl' => ['title' => '结果地址', 'description' => '结果地址', 'type' => 'string', 'example' => 'http://oss.aliyuncs.com/1.mp4.json'],
+ 'RecordType' => ['title' => '录制视频类型', 'description' => '录制视频类型', 'type' => 'string', 'example' => 'Mix'],
+ 'RoomRecordAt' => ['title' => '录制时间', 'description' => '录制时间', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'RoomStatus' => ['title' => '检测状态', 'description' => '检测状态', 'type' => 'string', 'example' => 'runnable'],
+ 'RtcRecordId' => ['description' => 'mrtc录制ID', 'type' => 'string', 'example' => 'record_65703154805715668342'."\n"],
+ 'OuterBusinessId' => ['description' => '业务ID,用户自定义', 'type' => 'string', 'example' => 'ads32efef43'],
+ ],
+ ],
],
- 'Content' => [
- 'description' => '规则内容',
- 'type' => 'string',
- 'example' => '{}',
+ 'OuterBusinessId' => ['description' => '业务ID,用户自定义', 'type' => 'string', 'example' => 'ads32efef43'],
+ ],
+ ],
+ 'Success' => ['title' => '给 pop 使用的', 'description' => '给 pop 使用的', 'type' => 'boolean', 'example' => 'True'],
+ 'HttpCode' => ['description' => 'HTTP 状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Errors' => [
+ 'title' => '错误列表',
+ 'description' => '错误列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '异常信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'Field' => ['description' => '错误 ID', 'type' => 'string', 'example' => '0f1c45cd-3eee-4e60-b505-2e330b8755d3'],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '无'],
],
- 'Id' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
+ ],
+ [
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
+ ],
+ 403 => [
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"84118BF0-56F7-54D2-8C1A-35BBBBD5016B\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"Id\\": \\"0f1c45cd-3eee-4e60-b505-2e330b8755d3\\",\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"DetectProcessName\\": \\"XX流程\\",\\n \\"DepartmentName\\": \\"XX部门\\",\\n \\"AppName\\": \\"XX应用\\",\\n \\"VideoUrl\\": \\"http://oss.aliyuncs.com/1.mp4\\",\\n \\"MetaUrl\\": \\"http://oss.aliyuncs.com/1.mp4.meta\\",\\n \\"ResultUrl\\": \\"http://oss.aliyuncs.com/1.mp4.json\\",\\n \\"RecordAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Duration\\": 22,\\n \\"Status\\": \\"completed\\",\\n \\"RoomId\\": \\"641981583353***\\",\\n \\"RecordRoomList\\": [\\n {\\n \\"Role\\": \\"21343\\",\\n \\"RoomVideoUrl\\": \\"http://oss.aliyuncs.com/1.mp4\\",\\n \\"RoomMetaUrl\\": \\"http://oss.aliyuncs.com/1.mp4.meta\\",\\n \\"RoomResultUrl\\": \\"http://oss.aliyuncs.com/1.mp4.json\\",\\n \\"RecordType\\": \\"Mix\\",\\n \\"RoomRecordAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"RoomStatus\\": \\"runnable\\",\\n \\"RtcRecordId\\": \\"record_65703154805715668342\\\\n\\",\\n \\"OuterBusinessId\\": \\"ads32efef43\\"\\n }\\n ],\\n \\"OuterBusinessId\\": \\"ads32efef43\\"\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200,\\n \\"Errors\\": [\\n {\\n \\"Field\\": \\"0f1c45cd-3eee-4e60-b505-2e330b8755d3\\",\\n \\"Message\\": \\"无\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '获取双录结果',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-29T07:30:49.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-07-05T11:05:57.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-02-21T07:17:01.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-01-12T03:08:53.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-01-09T16:48:09.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-01-07T06:08:55.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-01-04T07:08:00.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetRecordResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetRecordsByFeeId' => [
+ 'summary' => '根据feeid查询上报结果信息接口',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
+ [
+ 'name' => 'FeeId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '对账 ID', 'type' => 'string', 'required' => false, 'example' => '6c94f2a7-632d-4ea0-aa06-a97800a9060f'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'ApiResult<List<Record>>',
+ 'description' => 'ApiResult<List<Record>>',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'requestId', 'description' => 'requestId', 'type' => 'string', 'example' => '0B576AAB-A638-5029-9A54-A7C1DB5AC0B3'],
+ 'Code' => ['title' => 'code', 'description' => 'code', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['title' => '提示', 'description' => '提示', 'type' => 'string', 'example' => '-'],
+ 'Data' => [
+ 'title' => '数据',
+ 'description' => '数据',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => '双录记录id', 'description' => '双录记录id', 'type' => 'string', 'example' => '63bb629d-92bf-4cdc-ad0b-3032c926d23f'],
+ 'CreatedAt' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'DetectProcessName' => ['title' => '业务检测流程名', 'description' => '业务检测流程名', 'type' => 'string', 'example' => 'XX流程'],
+ 'DepartmentName' => ['title' => '部门名', 'description' => '部门名', 'type' => 'string', 'example' => '部门'],
+ 'AppName' => ['title' => '应用名', 'description' => '应用名', 'type' => 'string', 'example' => 'XX应用'],
+ 'VideoUrl' => ['title' => '视频地址', 'description' => '视频地址', 'type' => 'string', 'example' => 'http://oss.aliyuncs.com/1.mp4'],
+ 'MetaUrl' => ['title' => 'meta地址', 'description' => 'meta地址', 'type' => 'string', 'example' => 'http://oss.aliyuncs.com/1.mp4.meta'],
+ 'ResultUrl' => ['title' => '结果地址', 'description' => '结果地址', 'type' => 'string', 'example' => 'http://oss.aliyuncs.com/1.mp4.json'],
+ 'RecordAt' => ['title' => '录制时间', 'description' => '录制时间', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Duration' => ['title' => '时长', 'description' => '时长', 'type' => 'integer', 'format' => 'int64', 'example' => '22'],
+ 'Status' => ['title' => '检测状态', 'description' => '检测状态', 'type' => 'string', 'example' => 'completed'],
+ 'RoomId' => ['title' => 'mrtc房间id', 'description' => 'mrtc房间id', 'type' => 'string', 'example' => '654078150345590'],
+ 'RecordRoomList' => [
+ 'title' => '远程双录文件地址列表',
+ 'description' => '远程双录文件地址列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '远程双录文件地址列表',
+ 'type' => 'object',
+ 'properties' => [
+ 'Role' => ['title' => '角色', 'description' => '角色', 'type' => 'string', 'example' => '21343'],
+ 'RecordType' => ['title' => '录制视频类型', 'description' => '录制视频类型', 'type' => 'string', 'example' => 'Mix'],
+ 'RoomVideoUrl' => ['title' => '视频地址', 'description' => '视频地址', 'type' => 'string', 'example' => 'http://oss.aliyuncs.com/1.mp4'],
+ 'RoomMetaUrl' => ['title' => 'meta地址', 'description' => 'meta地址', 'type' => 'string', 'example' => 'http://oss.aliyuncs.com/1.mp4.meta'],
+ 'RoomResultUrl' => ['title' => '结果地址', 'description' => '结果地址', 'type' => 'string', 'example' => 'http://oss.aliyuncs.com/1.mp4.json'],
+ 'RoomRecordAt' => ['title' => '录制时间', 'description' => '录制时间', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'RoomStatus' => ['title' => '检测状态', 'description' => '检测状态', 'type' => 'string', 'example' => 'runnable'],
+ 'RtcRecordId' => ['description' => 'mrtc录制ID', 'type' => 'string', 'example' => 'record_65703154805715668342'],
+ 'OuterBusinessId' => ['description' => '业务ID,用户自定义', 'type' => 'string', 'example' => 'ads32efef43'],
+ ],
+ ],
+ ],
+ 'OuterBusinessId' => ['description' => '业务ID,用户自定义', 'type' => 'string', 'example' => 'ads32efef43'],
],
],
],
- 'Code' => [
- 'description' => '返回码',
- 'type' => 'string',
- 'example' => 'OK',
+ 'Success' => ['title' => '给 pop 使用的', 'description' => '给 pop 使用的', 'type' => 'boolean', 'example' => 'True'],
+ 'HttpCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Errors' => [
+ 'title' => '错误列表',
+ 'description' => '错误列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '错误列表',
+ 'type' => 'object',
+ 'properties' => [
+ 'Field' => ['description' => '错误 ID', 'type' => 'string', 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942'],
+ 'Message' => ['description' => '错误消息', 'type' => 'string', 'example' => '-'],
+ ],
+ ],
],
],
],
@@ -4029,34 +3193,235 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
+ ],
+ [
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
+ ],
+ 403 => [
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0B576AAB-A638-5029-9A54-A7C1DB5AC0B3\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"-\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"63bb629d-92bf-4cdc-ad0b-3032c926d23f\\",\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"DetectProcessName\\": \\"XX流程\\",\\n \\"DepartmentName\\": \\"部门\\",\\n \\"AppName\\": \\"XX应用\\",\\n \\"VideoUrl\\": \\"http://oss.aliyuncs.com/1.mp4\\",\\n \\"MetaUrl\\": \\"http://oss.aliyuncs.com/1.mp4.meta\\",\\n \\"ResultUrl\\": \\"http://oss.aliyuncs.com/1.mp4.json\\",\\n \\"RecordAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Duration\\": 22,\\n \\"Status\\": \\"completed\\",\\n \\"RoomId\\": \\"654078150345590\\",\\n \\"RecordRoomList\\": [\\n {\\n \\"Role\\": \\"21343\\",\\n \\"RecordType\\": \\"Mix\\",\\n \\"RoomVideoUrl\\": \\"http://oss.aliyuncs.com/1.mp4\\",\\n \\"RoomMetaUrl\\": \\"http://oss.aliyuncs.com/1.mp4.meta\\",\\n \\"RoomResultUrl\\": \\"http://oss.aliyuncs.com/1.mp4.json\\",\\n \\"RoomRecordAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"RoomStatus\\": \\"runnable\\",\\n \\"RtcRecordId\\": \\"record_65703154805715668342\\",\\n \\"OuterBusinessId\\": \\"ads32efef43\\"\\n }\\n ],\\n \\"OuterBusinessId\\": \\"ads32efef43\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"HttpCode\\": 200,\\n \\"Errors\\": [\\n {\\n \\"Field\\": \\"A1899517-BB99-5D3E-A71B-97524DCB0942\\",\\n \\"Message\\": \\"-\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '根据feeid获取上报记录',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-29T07:30:49.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetRecordsByFeeId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'GetRecordsByOuterBusinessId' => [
+ 'summary' => '根据OuterBusinessId查询上报结果信息接口',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
+ 'name' => 'OuterBusinessId',
+ 'in' => 'query',
+ 'schema' => ['description' => '业务ID,用户自定义', 'type' => 'string', 'required' => true, 'example' => 'ads32efef43'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'ApiResult<List<Record>>',
+ 'description' => 'ApiResult<List<Record>>',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'requestId', 'description' => 'requestId', 'type' => 'string', 'example' => '0f1c45cd-3eee-4e60-b505-2e330b875***'],
+ 'Code' => ['title' => 'code', 'description' => 'code', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['title' => '提示', 'description' => '提示', 'type' => 'string', 'example' => '-'],
+ 'Data' => [
+ 'title' => '数据',
+ 'description' => '数据',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => '双录记录id', 'description' => '双录记录id', 'type' => 'string', 'example' => '0f1c45cd-3eee-4e60-b505-2e330b875***'],
+ 'CreatedAt' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'DetectProcessName' => ['title' => '业务检测流程名', 'description' => '业务检测流程名', 'type' => 'string', 'example' => 'XX流程'],
+ 'DepartmentName' => ['title' => '部门名', 'description' => '部门名', 'type' => 'string', 'example' => 'XX部门'],
+ 'AppName' => ['title' => '应用名', 'description' => '应用名', 'type' => 'string', 'example' => 'XX应用'],
+ 'VideoUrl' => ['title' => '视频地址', 'description' => '视频地址', 'type' => 'string', 'example' => 'http://oss.aliyuncs.com/1.mp4'],
+ 'MetaUrl' => ['title' => 'meta地址', 'description' => 'meta地址', 'type' => 'string', 'example' => 'http://oss.aliyuncs.com/1.mp4.meta'],
+ 'ResultUrl' => ['title' => '结果地址', 'description' => '结果地址', 'type' => 'string', 'example' => 'http://oss.aliyuncs.com/1.mp4.json'],
+ 'RecordAt' => ['title' => '录制时间', 'description' => '录制时间', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Duration' => ['title' => '时长', 'description' => '时长', 'type' => 'integer', 'format' => 'int64', 'example' => '22'],
+ 'Status' => ['title' => '检测状态', 'description' => '检测状态', 'type' => 'string', 'example' => 'COMPLETED'],
+ 'RoomId' => ['title' => 'mrtc房间id', 'description' => 'mrtc房间id', 'type' => 'string', 'example' => '641981583353***'],
+ 'RecordRoomList' => [
+ 'title' => '远程双录文件地址列表',
+ 'description' => '远程双录文件地址列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '房间列表',
+ 'type' => 'object',
+ 'properties' => [
+ 'Role' => ['title' => '角色', 'description' => '角色', 'type' => 'string', 'example' => 'user'],
+ 'RecordType' => ['title' => '录制视频类型', 'description' => '录制视频类型', 'type' => 'string', 'example' => 'Mix'],
+ 'RoomVideoUrl' => ['title' => '视频地址', 'description' => '视频地址', 'type' => 'string', 'example' => 'http://oss.aliyuncs.com/1.mp4'],
+ 'RoomMetaUrl' => ['title' => 'meta地址', 'description' => 'meta地址', 'type' => 'string', 'example' => 'http://oss.aliyuncs.com/1.mp4.meta'],
+ 'RoomResultUrl' => ['title' => '结果地址', 'description' => '结果地址', 'type' => 'string', 'example' => 'http://oss.aliyuncs.com/1.mp4.json'],
+ 'RoomRecordAt' => ['title' => '录制时间', 'description' => '录制时间', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'RoomStatus' => ['title' => '检测状态', 'description' => '检测状态', 'type' => 'string', 'example' => '1'],
+ 'RtcRecordId' => ['description' => 'mrtc录制ID', 'type' => 'string', 'example' => 'record_65703154805715668342'],
+ 'OuterBusinessId' => ['description' => '业务ID,用户自定义', 'type' => 'string', 'example' => 'ads32efef43'],
+ ],
+ ],
+ ],
+ 'OuterBusinessId' => ['description' => '业务ID,用户自定义', 'type' => 'string', 'example' => 'ads32efef43'],
+ ],
+ ],
+ ],
+ 'Success' => ['title' => '给 pop 使用的', 'description' => '给 pop 使用的', 'type' => 'boolean', 'example' => 'True'],
+ 'HttpCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Errors' => [
+ 'title' => '错误列表',
+ 'description' => '错误列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '错误列表',
+ 'type' => 'object',
+ 'properties' => [
+ 'Field' => ['description' => '错误 ID', 'type' => 'string', 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0***'],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '-'],
+ ],
+ ],
+ ],
+ ],
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
+ ],
+ [
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
+ ],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0f1c45cd-3eee-4e60-b505-2e330b875***\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"-\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"0f1c45cd-3eee-4e60-b505-2e330b875***\\",\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"DetectProcessName\\": \\"XX流程\\",\\n \\"DepartmentName\\": \\"XX部门\\",\\n \\"AppName\\": \\"XX应用\\",\\n \\"VideoUrl\\": \\"http://oss.aliyuncs.com/1.mp4\\",\\n \\"MetaUrl\\": \\"http://oss.aliyuncs.com/1.mp4.meta\\",\\n \\"ResultUrl\\": \\"http://oss.aliyuncs.com/1.mp4.json\\",\\n \\"RecordAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Duration\\": 22,\\n \\"Status\\": \\"COMPLETED\\",\\n \\"RoomId\\": \\"641981583353***\\",\\n \\"RecordRoomList\\": [\\n {\\n \\"Role\\": \\"user\\",\\n \\"RecordType\\": \\"Mix\\",\\n \\"RoomVideoUrl\\": \\"http://oss.aliyuncs.com/1.mp4\\",\\n \\"RoomMetaUrl\\": \\"http://oss.aliyuncs.com/1.mp4.meta\\",\\n \\"RoomResultUrl\\": \\"http://oss.aliyuncs.com/1.mp4.json\\",\\n \\"RoomRecordAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"RoomStatus\\": \\"1\\",\\n \\"RtcRecordId\\": \\"record_65703154805715668342\\",\\n \\"OuterBusinessId\\": \\"ads32efef43\\"\\n }\\n ],\\n \\"OuterBusinessId\\": \\"ads32efef43\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"HttpCode\\": 200,\\n \\"Errors\\": [\\n {\\n \\"Field\\": \\"A1899517-BB99-5D3E-A71B-97524DCB0***\\",\\n \\"Message\\": \\"-\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '根据业务ID获取双录记录',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-29T07:31:02.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetRecordsByOuterBusinessId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'GetRule' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
+ [
+ 'name' => 'Id',
+ 'in' => 'query',
+ 'schema' => ['description' => '规则 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
+ ],
+ [
+ 'name' => 'ClientBaseParam',
+ 'in' => 'query',
+ 'schema' => ['description' => '客户端基础参数,记录 SDK 版本号等信息', 'type' => 'string', 'required' => false, 'example' => '{"version":"1.0.0"}'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '无',
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['description' => '错误消息', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
+ 'Data' => [
+ 'description' => '无',
+ 'type' => 'object',
+ 'properties' => [
+ 'CreatedAt' => ['description' => '创建日期', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Name' => ['description' => '名称', 'type' => 'string', 'example' => 'default'],
+ 'Content' => ['description' => '规则内容', 'type' => 'string', 'example' => '{}'],
+ 'Id' => ['description' => 'ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
+ ],
+ ],
+ 'Code' => ['description' => '返回码', 'type' => 'string', 'example' => 'OK'],
+ ],
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
+ ],
+ [
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
+ ],
+ 403 => [
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
+ ],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Data\\": {\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Name\\": \\"default\\",\\n \\"Content\\": \\"{}\\",\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<Message>-</Message>\\n<RequestId/>\\n<Data>\\n <Content>{}</Content>\\n <CreatedAt>2020-07-14T14:01:41.000+08:00</CreatedAt>\\n <Id>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</Id>\\n <Name>default</Name>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
@@ -4065,15 +3430,30 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'GetTask' => [
- 'methods' => [
- 'post',
+ 'changeSet' => [
+ ['createdAt' => '2022-02-21T07:17:01.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetStatisticsRecordsByFeeId' => [
+ 'summary' => '根据feeid查询上报计量信息接口',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4081,31 +3461,127 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
+ [
+ 'name' => 'FeeId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '对账 ID', 'type' => 'string', 'required' => false, 'example' => 'ab7ce59f-a68a-4a6f-82a6-6460fadc9a70'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'ApiResult<List<StatisticsRecord>>',
+ 'description' => 'ApiResult<List<StatisticsRecord>>',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'requestId', 'description' => 'requestId', 'type' => 'string', 'example' => 'CAD43A24-D34C-5848-BEB0-3D184F6687B1'],
+ 'Code' => ['title' => 'code', 'description' => 'code', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['title' => '提示', 'description' => '提示', 'type' => 'string', 'example' => '-'],
+ 'Data' => [
+ 'title' => '数据',
+ 'description' => '数据',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'DeviceId' => ['description' => '设备id', 'type' => 'string', 'example' => '7f3dfb9aa0dd0261'],
+ 'TenantId' => ['description' => '租户id', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'AppId' => ['description' => 'appid', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
+ 'DepartmentId' => ['description' => '部门id', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
+ 'DeviceType' => ['description' => '终端设备类型,0:Android,1:iOS', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'CreatedAt' => ['description' => '创建时间', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'UpdatedAt' => ['description' => '更新时间', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'BeginAt' => ['description' => '开始检测时间,时间格式yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2022-05-23 10:33:12'],
+ 'EndAt' => ['description' => '结束检测时间,时间格式yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2022-03-24 11:39:46'],
+ 'Hour' => ['title' => '2020050811', 'description' => '时间段', 'type' => 'integer', 'format' => 'int32', 'example' => '2020050811'],
+ 'DetectionDuration' => ['title' => '检测时长,s', 'description' => '检测时长,s', 'type' => 'integer', 'format' => 'int32', 'example' => '1200'],
+ 'ChargeDuration' => ['title' => '计费时长,min', 'description' => '计费时长,min', 'type' => 'integer', 'format' => 'int32', 'example' => '12'],
+ 'Type' => ['description' => '类型:remote(远程双录),local(本地双录)', 'type' => 'string', 'example' => 'REMOTE'],
+ 'FeeId' => ['description' => '对账 ID', 'type' => 'string', 'example' => 'ff1d7783-e087-4d62-92df-3a163eca7c07'],
+ ],
+ ],
+ ],
+ 'Success' => ['title' => '给 pop 使用的', 'description' => '给 pop 使用的', 'type' => 'boolean', 'example' => 'True'],
+ 'HttpCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Errors' => [
+ 'title' => '错误列表',
+ 'description' => '错误列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '无',
+ 'type' => 'object',
+ 'properties' => [
+ 'Field' => ['description' => '错误 ID', 'type' => 'string', 'example' => '-'],
+ 'Message' => ['description' => '错误消息', 'type' => 'string', 'example' => '-'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
+ ],
+ [
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
+ ],
+ 403 => [
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CAD43A24-D34C-5848-BEB0-3D184F6687B1\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"-\\",\\n \\"Data\\": [\\n {\\n \\"DeviceId\\": \\"7f3dfb9aa0dd0261\\",\\n \\"TenantId\\": 1,\\n \\"AppId\\": 12,\\n \\"DepartmentId\\": 12,\\n \\"DeviceType\\": 0,\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"UpdatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"BeginAt\\": \\"2022-05-23 10:33:12\\",\\n \\"EndAt\\": \\"2022-03-24 11:39:46\\",\\n \\"Hour\\": 2020050811,\\n \\"DetectionDuration\\": 1200,\\n \\"ChargeDuration\\": 12,\\n \\"Type\\": \\"REMOTE\\",\\n \\"FeeId\\": \\"ff1d7783-e087-4d62-92df-3a163eca7c07\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"HttpCode\\": 200,\\n \\"Errors\\": [\\n {\\n \\"Field\\": \\"-\\",\\n \\"Message\\": \\"-\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '根据feeid获取计费信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetStatisticsRecordsByFeeId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetTask' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClientBaseParam',
'in' => 'query',
- 'schema' => [
- 'description' => '客户端基础参数,记录 SDK 版本号等信息'."\n"
- ."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => ' {"version":"1.0.0"}',
- ],
+ 'schema' => ['description' => '客户端基础参数,记录 SDK 版本号等信息'."\n"
+ ."\n", 'type' => 'string', 'required' => false, 'example' => ' {"version":"1.0.0"}'],
],
[
'name' => 'TaskId',
'in' => 'query',
- 'schema' => [
- 'description' => '任务 ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'schema' => ['description' => '任务 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
],
'responses' => [
@@ -4114,95 +3590,66 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942',
- ],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942'],
'Data' => [
'description' => '任务数据',
'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '任务状态',
- 'type' => 'string',
- 'example' => 'runnable',
- ],
- 'CreatedAt' => [
- 'description' => '创建日期',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Id' => [
- 'description' => '检测任务 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
- 'VideoUrl' => [
- 'description' => '检测结果视频 URL',
- 'type' => 'string',
- 'example' => 'http://oss.aliyuncs.com/1.mp4',
- ],
+ 'Status' => ['description' => '任务状态', 'type' => 'string', 'example' => 'runnable'],
+ 'CreatedAt' => ['description' => '创建日期', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Id' => ['description' => '检测任务 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
+ 'VideoUrl' => ['description' => '检测结果视频 URL', 'type' => 'string', 'example' => 'http://oss.aliyuncs.com/1.mp4'],
],
],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"A1899517-BB99-5D3E-A71B-97524DCB0942\\",\\n \\"Data\\": {\\n \\"Status\\": \\"runnable\\",\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"VideoUrl\\": \\"http://oss.aliyuncs.com/1.mp4\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]',
'title' => '获取指定任务信息',
'summary' => '调用 GetTask 获取指定任务信息。',
- ],
- 'GetTaskGroup' => [
- 'methods' => [
- 'post',
+ 'changeSet' => [
+ ['createdAt' => '2022-02-21T07:17:01.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetTaskGroup' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4210,30 +3657,17 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClientBaseParam',
'in' => 'query',
- 'schema' => [
- 'description' => '客户端基础参数,记录 SDK 版本号等信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"version":"1.0.0"}',
- ],
+ 'schema' => ['description' => '客户端基础参数,记录 SDK 版本号等信息', 'type' => 'string', 'required' => false, 'example' => '{"version":"1.0.0"}'],
],
[
'name' => 'Id',
'in' => 'query',
- 'schema' => [
- 'description' => '任务组 ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'schema' => ['description' => '任务组 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
],
'responses' => [
@@ -4242,112 +3676,47 @@
'description' => '-',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '-'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
'Data' => [
'description' => '-',
'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '状态',
- 'type' => 'string',
- 'example' => 'runnable',
- ],
- 'CompletedTasks' => [
- 'description' => '已完成任务数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TotalTasks' => [
- 'description' => '总任务数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'CreatedAt' => [
- 'description' => '创建日期',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Name' => [
- 'description' => '名称',
- 'type' => 'string',
- 'example' => '名称',
- ],
+ 'Status' => ['description' => '状态', 'type' => 'string', 'example' => 'runnable'],
+ 'CompletedTasks' => ['description' => '已完成任务数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'TotalTasks' => ['description' => '总任务数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'CreatedAt' => ['description' => '创建日期', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Name' => ['description' => '名称', 'type' => 'string', 'example' => '名称'],
'TaskIds' => [
'description' => '-',
'type' => 'array',
- 'items' => [
- 'description' => '任务 ID 列表',
- 'type' => 'string',
- 'example' => '["1"]',
- ],
- ],
- 'Id' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
- 'RuleId' => [
- 'description' => '规则 ID',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'RuleName' => [
- 'description' => '规则名称',
- 'type' => 'string',
- 'example' => 'default',
+ 'items' => ['description' => '任务 ID 列表', 'type' => 'string', 'example' => '["1"]'],
],
+ 'Id' => ['description' => 'ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
+ 'RuleId' => ['description' => '规则 ID', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'RuleName' => ['description' => '规则名称', 'type' => 'string', 'example' => 'default'],
],
],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"-\\",\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Data\\": {\\n \\"Status\\": \\"runnable\\",\\n \\"CompletedTasks\\": 1,\\n \\"TotalTasks\\": 1,\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Name\\": \\"名称\\",\\n \\"TaskIds\\": [\\n \\"[\\\\\\"1\\\\\\"]\\"\\n ],\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"RuleId\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"RuleName\\": \\"default\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<Message/>\\n<RequestId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</RequestId>\\n<Data>\\n <Status>runnable</Status>\\n <TaskIds>[\\"1\\"]</TaskIds>\\n <CreatedAt>2020-07-14T14:01:41.000+08:00</CreatedAt>\\n <RuleId>2020-07-14T14:01:41.000+08:00</RuleId>\\n <TotalTasks>1</TotalTasks>\\n <CompletedTasks>1</CompletedTasks>\\n <Id>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</Id>\\n <RuleName>default</RuleName>\\n <Name>名称</Name>\\n</Data>\\n<Code/>","errorExample":""}]',
@@ -4357,15 +3726,30 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'GetUser' => [
- 'methods' => [
- 'post',
+ 'changeSet' => [
+ ['createdAt' => '2022-02-21T07:17:01.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetTaskGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetTtsQuestionByGroupId' => [
+ 'summary' => '根据TTS问题组ID获取TTS问题信息',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4373,30 +3757,116 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
+ [
+ 'name' => 'GroupId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'TTS问题组ID', 'type' => 'string', 'required' => true, 'example' => '47584ba4-9781-496b-8e6f-c8525a213***'],
+ ],
],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'ApiResult<GetQuestionsDTO>',
+ 'description' => 'ApiResult<GetQuestionsDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '为公共参数,每个请求的id都是唯一的', 'type' => 'string', 'example' => 'D2DFCDC3-1ECF-599D-8EDA-8F598E5A9***'],
+ 'Code' => ['description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => 'OK'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => '-'],
+ 'Data' => [
+ 'description' => '数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'GroupId' => ['description' => 'TTS问题组ID'."\n"
+ ."\n", 'type' => 'string', 'example' => '47584ba4-9781-496b-8e6f-c8525a213***'],
+ 'Questions' => [
+ 'description' => '问题列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '问题信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => '问题id', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'TenantId' => ['description' => '租户id', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
+ 'QuestionGroupId' => ['description' => '问题组id', 'type' => 'integer', 'format' => 'int64', 'example' => '47584ba4-9781-496b-8e6f-c8525a213***'],
+ 'QuestionKey' => ['description' => '问题key', 'type' => 'string', 'example' => '47584ba4-9781-496b-8e6f-c8525a213***'],
+ 'Question' => ['description' => '问题。', 'type' => 'string', 'example' => '北京的天气如何'],
+ 'Answer' => ['description' => '回复', 'type' => 'string', 'example' => '晴朗'],
+ 'Duration' => ['description' => '合成的音频时长,单位毫秒', 'type' => 'number', 'format' => 'double', 'example' => '674'],
+ 'OssUrl' => ['description' => '下载地址', 'type' => 'string', 'example' => 'https://pts-data-f***.pcm'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'Success' => ['title' => '给 pop 使用的', 'description' => '给 pop 使用的', 'type' => 'boolean', 'example' => 'True'],
+ 'HttpCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
+ ],
+ [
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
+ ],
+ 403 => [
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D2DFCDC3-1ECF-599D-8EDA-8F598E5A9***\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"-\\",\\n \\"Data\\": {\\n \\"GroupId\\": \\"47584ba4-9781-496b-8e6f-c8525a213***\\",\\n \\"Questions\\": [\\n {\\n \\"Id\\": 1,\\n \\"TenantId\\": 2,\\n \\"QuestionGroupId\\": 0,\\n \\"QuestionKey\\": \\"47584ba4-9781-496b-8e6f-c8525a213***\\",\\n \\"Question\\": \\"北京的天气如何\\",\\n \\"Answer\\": \\"晴朗\\",\\n \\"Duration\\": 674,\\n \\"OssUrl\\": \\"https://pts-data-f***.pcm\\"\\n }\\n ]\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200\\n}","type":"json"}]',
+ 'title' => '根据TTS问题组ID获取此ID下所有的TTS信息',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-29T07:31:01.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetTtsQuestionByGroupId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetUser' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
- 'schema' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'schema' => ['description' => 'ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
[
'name' => 'ClientBaseParam',
'in' => 'query',
- 'schema' => [
- 'description' => '客户端基础参数,记录 SDK 版本号等信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"version":"1.0.0"}',
- ],
+ 'schema' => ['description' => '客户端基础参数,记录 SDK 版本号等信息', 'type' => 'string', 'required' => false, 'example' => '{"version":"1.0.0"}'],
],
],
'responses' => [
@@ -4405,30 +3875,14 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '返回信息。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '请求 ID。',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
'Data' => [
'description' => '无',
'type' => 'object',
'properties' => [
- 'Email' => [
- 'description' => '电子邮件地址',
- 'type' => 'string',
- 'example' => 'xxx@aa.com',
- ],
- 'PhoneNumber' => [
- 'description' => '手机号码',
- 'type' => 'string',
- 'example' => '187000023323',
- ],
+ 'Email' => ['description' => '电子邮件地址', 'type' => 'string', 'example' => 'xxx@aa.com'],
+ 'PhoneNumber' => ['description' => '手机号码', 'type' => 'string', 'example' => '187000023323'],
'Departments' => [
'description' => '部门列表',
'type' => 'array',
@@ -4436,110 +3890,43 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'Description' => [
- 'description' => '描述',
- 'type' => 'string',
- 'example' => '描述',
- ],
- 'GmtCreate' => [
- 'description' => '创建日期',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Name' => [
- 'description' => '名称',
- 'type' => 'string',
- 'example' => '名称',
- ],
- 'GmtModified' => [
- 'description' => '更新日期',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Id' => [
- 'description' => '部门 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'Description' => ['description' => '描述', 'type' => 'string', 'example' => '描述'],
+ 'GmtCreate' => ['description' => '创建日期', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Name' => ['description' => '名称', 'type' => 'string', 'example' => '名称'],
+ 'GmtModified' => ['description' => '更新日期', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Id' => ['description' => '部门 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
],
],
- 'CreatedAt' => [
- 'description' => '创建日期',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'UpdatedAt' => [
- 'description' => '更新日期',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Source' => [
- 'description' => '来源',
- 'type' => 'string',
- 'example' => 'ram',
- ],
- 'Role' => [
- 'description' => '角色',
- 'type' => 'string',
- 'example' => 'admin',
- ],
- 'Name' => [
- 'description' => '姓名',
- 'type' => 'string',
- 'example' => '姓名',
- ],
- 'Id' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
- 'Username' => [
- 'description' => '用户名',
- 'type' => 'string',
- 'example' => 'test',
- ],
+ 'CreatedAt' => ['description' => '创建日期', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'UpdatedAt' => ['description' => '更新日期', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Source' => ['description' => '来源', 'type' => 'string', 'example' => 'ram'],
+ 'Role' => ['description' => '角色', 'type' => 'string', 'example' => 'admin'],
+ 'Name' => ['description' => '姓名', 'type' => 'string', 'example' => '姓名'],
+ 'Id' => ['description' => 'ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
+ 'Username' => ['description' => '用户名', 'type' => 'string', 'example' => 'test'],
],
],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Data\\": {\\n \\"Email\\": \\"xxx@aa.com\\",\\n \\"PhoneNumber\\": \\"187000023323\\",\\n \\"Departments\\": [\\n {\\n \\"Description\\": \\"描述\\",\\n \\"GmtCreate\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Name\\": \\"名称\\",\\n \\"GmtModified\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\"\\n }\\n ],\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"UpdatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Source\\": \\"ram\\",\\n \\"Role\\": \\"admin\\",\\n \\"Name\\": \\"姓名\\",\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Username\\": \\"test\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<Message>-</Message>\\n<RequestId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</RequestId>\\n<Data>\\n <Role>admin</Role>\\n <Departments>\\n <GmtCreate>2020-07-14T14:01:41.000+08:00</GmtCreate>\\n <Description>描述</Description>\\n <GmtModified>2020-07-14T14:01:41.000+08:00</GmtModified>\\n <Id>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</Id>\\n <Name>名称</Name>\\n </Departments>\\n <Email>xxx@aa.com</Email>\\n <Username>test</Username>\\n <CreatedAt>2020-07-14T14:01:41.000+08:00</CreatedAt>\\n <PhoneNumber>187000023323</PhoneNumber>\\n <Id>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</Id>\\n <UpdatedAt>2020-07-14T14:01:41.000+08:00</UpdatedAt>\\n <Source>ram</Source>\\n <Name>姓名</Name>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
@@ -4548,15 +3935,30 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ListApps' => [
- 'methods' => [
- 'post',
+ 'changeSet' => [
+ ['createdAt' => '2022-02-21T07:17:01.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetWatermark' => [
+ 'summary' => '根据ID查询水印信息',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4564,59 +3966,310 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
+ [
+ 'name' => 'WatermarkId',
+ 'in' => 'query',
+ 'schema' => ['description' => '水印 ID', 'type' => 'string', 'required' => false, 'example' => '728fd812a876ec04818858982baebe6f'],
+ ],
+ [
+ 'name' => 'ClientVersion',
+ 'in' => 'query',
+ 'schema' => ['description' => '客户端版本', 'type' => 'string', 'required' => false, 'example' => '1.0.003'],
+ ],
+ [
+ 'name' => 'ClientBaseParam',
+ 'in' => 'query',
+ 'schema' => ['description' => '客户端基础参数,记录 SDK 版本号等信息', 'type' => 'string', 'required' => false, 'example' => '{"version":"1.0.0"}'],
+ ],
],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'ApiResult<WatermarkDTO>',
+ 'description' => 'ApiResult<WatermarkDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'requestId', 'description' => 'requestId', 'type' => 'string', 'example' => '84118BF0-56F7-54D2-8C1A-35BBBBD5016B'],
+ 'Code' => ['title' => 'code', 'description' => 'code', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['title' => '提示', 'description' => '提示', 'type' => 'string', 'example' => '-'],
+ 'Data' => [
+ 'title' => '数据',
+ 'description' => '数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => '水印id', 'description' => '水印 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
+ 'CreatedAt' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Value' => ['title' => '水印信息', 'description' => '水印信息', 'type' => 'string', 'example' => '{}'],
+ 'Name' => ['title' => '水印名称', 'description' => '水印名称', 'type' => 'string', 'example' => '名称'],
+ ],
+ ],
+ 'Success' => ['title' => '给 pop 使用的', 'description' => '给 pop 使用的', 'type' => 'boolean', 'example' => 'True'],
+ 'HttpCode' => ['description' => 'HTTP 状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Errors' => [
+ 'title' => '错误列表',
+ 'description' => '错误列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '-',
+ 'type' => 'object',
+ 'properties' => [
+ 'Field' => ['description' => '错误 ID', 'type' => 'string', 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942'],
+ 'Message' => ['description' => '错误消息', 'type' => 'string', 'example' => '-'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
+ ],
+ [
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
+ ],
+ 403 => [
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"84118BF0-56F7-54D2-8C1A-35BBBBD5016B\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"-\\",\\n \\"Data\\": {\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Value\\": \\"{}\\",\\n \\"Name\\": \\"名称\\"\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200,\\n \\"Errors\\": [\\n {\\n \\"Field\\": \\"A1899517-BB99-5D3E-A71B-97524DCB0942\\",\\n \\"Message\\": \\"-\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '获取水印信息',
+ 'changeSet' => [
+ ['createdAt' => '2022-02-21T07:17:01.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-01-24T04:47:39.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-01-04T11:03:18.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-01-04T07:08:00.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetWatermark',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'JoinRoom' => [
+ 'summary' => '单向视频双录-通知加入房间',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
- 'name' => 'PageIndex',
+ 'name' => 'AppId',
+ 'in' => 'query',
+ 'allowEmptyValue' => false,
+ 'schema' => ['description' => '双录质检应用id', 'type' => 'string', 'required' => true, 'example' => '4a29b426-742f-4078-8386-79b440b***'],
+ ],
+ [
+ 'name' => 'RoomId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'mrtc 房间 ID', 'type' => 'string', 'required' => true, 'example' => '66194***681868'],
+ ],
+ [
+ 'name' => 'StreamId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'mrtc 视频流或音频流ID', 'type' => 'string', 'required' => false, 'example' => '12312***2412'],
+ ],
+ [
+ 'name' => 'RoomToken',
'in' => 'query',
+ 'schema' => ['description' => 'mrtc 房间密码', 'type' => 'string', 'required' => false, 'example' => '006f4***b269'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => false,
- 'maximum' => '1000000',
- 'minimum' => '1',
- 'example' => '1',
- 'isFileTransferUrl' => false,
- 'default' => '1',
+ 'title' => 'ApiResult<JoinRoomResponseDTO>',
+ 'description' => 'ApiResult<JoinRoomResponseDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D15744FC-97D2-5D61-A18C-8CC4FA0A3***'],
+ 'Code' => ['description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => 'OK'],
+ 'Message' => ['description' => '错误消息', 'type' => 'string', 'example' => '-'],
+ 'Data' => [
+ 'description' => '数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'RoomId' => ['description' => 'mrtc 房间 ID', 'type' => 'string', 'example' => '641981583353***'],
+ 'StreamId' => ['description' => 'mrtc 视频流或音频流ID', 'type' => 'string', 'example' => '12312***412'],
+ ],
+ ],
+ 'Success' => ['title' => '给 pop 使用的', 'description' => '给 pop 使用的', 'type' => 'boolean', 'example' => 'True'],
+ 'HttpCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ ],
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
+ ],
[
- 'name' => 'PageSize',
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
+ ],
+ 403 => [
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D15744FC-97D2-5D61-A18C-8CC4FA0A3***\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"-\\",\\n \\"Data\\": {\\n \\"RoomId\\": \\"641981583353***\\",\\n \\"StreamId\\": \\"12312***412\\"\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200\\n}","type":"json"}]',
+ 'title' => '加入MRTC房间',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-26T03:41:52.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'idrsservice:JoinRoom',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'LeaveRoom' => [
+ 'summary' => '单向视频双录-通知离开房间',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none'],
+ 'parameters' => [
+ [
+ 'name' => 'RoomId',
'in' => 'query',
+ 'schema' => ['description' => 'mrtc 房间 ID', 'type' => 'string', 'required' => false, 'example' => '661940620884***'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '页大小',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => false,
- 'maximum' => '10000',
- 'minimum' => '10',
- 'example' => '10',
- 'isFileTransferUrl' => false,
- 'default' => '10',
+ 'title' => 'ApiResult<String>',
+ 'description' => 'ApiResult<String>',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求ID,一次请求的唯一标识。'."\n", 'type' => 'string', 'example' => '8F5F961D-07AA-5293-BFFE-32CDC251***'],
+ 'Code' => ['description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => 'OK'],
+ 'Message' => ['description' => '错误消息', 'type' => 'string', 'example' => '无'],
+ 'Data' => ['description' => '数据', 'type' => 'string', 'example' => '无'],
+ 'Success' => ['title' => '给 pop 使用的', 'description' => '给 pop 使用的', 'type' => 'boolean', 'example' => 'True'],
+ 'HttpCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ ],
],
],
],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
+ ],
+ [
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
+ ],
+ 403 => [
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8F5F961D-07AA-5293-BFFE-32CDC251***\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"无\\",\\n \\"Success\\": true,\\n \\"HttpCode\\": 200\\n}","type":"json"}]',
+ 'title' => '离开MRTC房间',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-26T03:41:52.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'idrsservice:LeaveRoom',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListApps' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
+ [
+ 'name' => 'PageIndex',
+ 'in' => 'query',
+ 'schema' => ['description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '1000000', 'minimum' => '1', 'example' => '1', 'isFileTransferUrl' => false, 'default' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '10000', 'minimum' => '10', 'example' => '10', 'isFileTransferUrl' => false, 'default' => '10'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
'description' => '无',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'Message' => ['description' => '错误消息', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
'Data' => [
'description' => '无',
'type' => 'object',
@@ -4628,97 +4281,40 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'DepartmentName' => [
- 'description' => '部门名称',
- 'type' => 'string',
- 'example' => '部门',
- ],
- 'PackageName' => [
- 'description' => '包名',
- 'type' => 'string',
- 'example' => 'com.aaa.test',
- ],
- 'CreatedAt' => [
- 'description' => '创建日期',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'DepartmentId' => [
- 'description' => '部门 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
- 'Disabled' => [
- 'description' => '是否禁用',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'Name' => [
- 'description' => '名称',
- 'type' => 'string',
- 'example' => '应用',
- ],
- 'Id' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'DepartmentName' => ['description' => '部门名称', 'type' => 'string', 'example' => '部门'],
+ 'PackageName' => ['description' => '包名', 'type' => 'string', 'example' => 'com.aaa.test'],
+ 'CreatedAt' => ['description' => '创建日期', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'DepartmentId' => ['description' => '部门 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
+ 'Disabled' => ['description' => '是否禁用', 'type' => 'boolean', 'example' => 'false'],
+ 'Name' => ['description' => '名称', 'type' => 'string', 'example' => '应用'],
+ 'Id' => ['description' => 'ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
],
],
- 'TotalPages' => [
- 'description' => '总页数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '11',
- ],
- 'TotalElements' => [
- 'description' => '总条目数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
+ 'TotalPages' => ['description' => '总页数', 'type' => 'integer', 'format' => 'int32', 'example' => '11'],
+ 'TotalElements' => ['description' => '总条目数', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Data\\": {\\n \\"Items\\": [\\n {\\n \\"DepartmentName\\": \\"部门\\",\\n \\"PackageName\\": \\"com.aaa.test\\",\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"DepartmentId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Disabled\\": false,\\n \\"Name\\": \\"应用\\",\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\"\\n }\\n ],\\n \\"TotalPages\\": 11,\\n \\"TotalElements\\": 1\\n },\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<Message>-</Message>\\n<RequestId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</RequestId>\\n<Data>\\n <TotalElements>1</TotalElements>\\n <TotalPages>11</TotalPages>\\n <Items>\\n <PackageName>com.aaa.test</PackageName>\\n <CreatedAt>2020-07-14T14:01:41.000+08:00</CreatedAt>\\n <DepartmentName>部门</DepartmentName>\\n <DepartmentId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</DepartmentId>\\n <Id>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</Id>\\n <Disabled>false</Disabled>\\n <Name>应用</Name>\\n </Items>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
@@ -4727,15 +4323,27 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:ListApps',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'ListDepartments' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4743,61 +4351,27 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '部门名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '部门名称',
- ],
+ 'schema' => ['description' => '部门名称', 'type' => 'string', 'required' => false, 'example' => '部门名称'],
],
[
'name' => 'PageIndex',
'in' => 'query',
- 'schema' => [
- 'description' => '页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => false,
- 'maximum' => '10000',
- 'minimum' => '1',
- 'example' => '1',
- 'isFileTransferUrl' => false,
- 'default' => '1',
- ],
+ 'schema' => ['description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '10000', 'minimum' => '1', 'example' => '1', 'isFileTransferUrl' => false, 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '页大小',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => false,
- 'maximum' => '100',
- 'minimum' => '10',
- 'example' => '10',
- 'isFileTransferUrl' => false,
- 'default' => '10',
- ],
+ 'schema' => ['description' => '页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '100', 'minimum' => '10', 'example' => '10', 'isFileTransferUrl' => false, 'default' => '10'],
],
[
'name' => 'UserId',
'in' => 'query',
- 'schema' => [
- 'description' => '用户 ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'schema' => ['description' => '用户 ID', 'type' => 'string', 'required' => false, 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
],
'responses' => [
@@ -4806,16 +4380,8 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '响应信息',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
'Data' => [
'description' => '返回数据',
'type' => 'object',
@@ -4827,11 +4393,7 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'Description' => [
- 'description' => ' 描述',
- 'type' => 'string',
- 'example' => '描述',
- ],
+ 'Description' => ['description' => ' 描述', 'type' => 'string', 'example' => '描述'],
'Administrators' => [
'description' => '管理员列表',
'type' => 'array',
@@ -4839,95 +4401,42 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'Name' => [
- 'description' => '用户姓名',
- 'type' => 'string',
- 'example' => 'user',
- ],
- 'Id' => [
- 'description' => '用户 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'Name' => ['description' => '用户姓名', 'type' => 'string', 'example' => 'user'],
+ 'Id' => ['description' => '用户 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
],
],
- 'CreatedAt' => [
- 'description' => '创建日期',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'UpdatedAt' => [
- 'description' => '更新日期',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Name' => [
- 'description' => '名称',
- 'type' => 'string',
- 'example' => '名称',
- ],
- 'Id' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'CreatedAt' => ['description' => '创建日期', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'UpdatedAt' => ['description' => '更新日期', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Name' => ['description' => '名称', 'type' => 'string', 'example' => '名称'],
+ 'Id' => ['description' => 'ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
],
],
- 'TotalPages' => [
- 'description' => '总页数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '11',
- ],
- 'TotalElements' => [
- 'description' => '总条目数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
+ 'TotalPages' => ['description' => '总页数', 'type' => 'integer', 'format' => 'int32', 'example' => '11'],
+ 'TotalElements' => ['description' => '总条目数', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
],
- 'Code' => [
- 'description' => '返回码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Code' => ['description' => '返回码', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Data\\": {\\n \\"Items\\": [\\n {\\n \\"Description\\": \\"描述\\",\\n \\"Administrators\\": [\\n {\\n \\"Name\\": \\"user\\",\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\"\\n }\\n ],\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"UpdatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Name\\": \\"名称\\",\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\"\\n }\\n ],\\n \\"TotalPages\\": 11,\\n \\"TotalElements\\": 1\\n },\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<Message>-</Message>\\n<RequestId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</RequestId>\\n<Data>\\n <TotalElements>1</TotalElements>\\n <TotalPages>11</TotalPages>\\n <Items>\\n <Description>描述</Description>\\n <CreatedAt>2020-07-14T14:01:41.000+08:00</CreatedAt>\\n <Id>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</Id>\\n <UpdatedAt>2020-07-14T14:01:41.000+08:00</UpdatedAt>\\n <Name>名称</Name>\\n </Items>\\n <Items>\\n <Administrators>\\n <Id>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</Id>\\n <Name>user</Name>\\n </Administrators>\\n </Items>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
@@ -4936,15 +4445,27 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ListDetections' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:ListDepartments',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListDetectProcesses' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4952,135 +4473,57 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'CreateDateFrom',
+ 'name' => 'PageIndex',
'in' => 'query',
- 'schema' => [
- 'description' => '开始日期',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2020-10-10',
- ],
+ 'schema' => ['description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '10000', 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
- 'name' => 'CreateDateTo',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '结束日期',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2020-10-11',
- ],
+ 'schema' => ['description' => '页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '500', 'minimum' => '10', 'example' => '10', 'default' => '10'],
],
[
- 'name' => 'DepartmentId',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '部门 ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'schema' => ['description' => '检测流程名称', 'type' => 'string', 'required' => false, 'example' => '检测流程名称'],
],
[
- 'name' => 'PageIndex',
+ 'name' => 'PublishStatus',
'in' => 'query',
- 'schema' => [
- 'description' => '页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => false,
- 'maximum' => '10000',
- 'minimum' => '1',
- 'example' => '1',
- 'isFileTransferUrl' => false,
- 'default' => '1',
- ],
+ 'allowEmptyValue' => false,
+ 'schema' => ['description' => '是否发布', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'Type',
'in' => 'query',
- 'schema' => [
- 'description' => '页大小',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => false,
- 'maximum' => '100',
- 'minimum' => '10',
- 'example' => '10',
- 'isFileTransferUrl' => false,
- 'default' => '10',
- ],
+ 'allowEmptyValue' => false,
+ 'schema' => ['description' => '类型:remote(远程双录),local(本地双录)', 'type' => 'string', 'required' => false, 'example' => 'LOCAL'],
],
[
- 'name' => 'RecordingType',
+ 'name' => 'Sort',
'in' => 'query',
- 'schema' => [
- 'description' => '类型:remote(远程双录),local(本地双录)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'local',
- 'enum' => [
- 'local',
- 'remote',
- ],
- ],
+ 'allowEmptyValue' => true,
+ 'schema' => ['description' => '排序', 'type' => 'string', 'required' => false, 'example' => 'desc'],
],
[
- 'name' => 'RuleId',
+ 'name' => 'SortKey',
'in' => 'query',
- 'schema' => [
- 'description' => '规则 ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'schema' => ['description' => '排序字段:CONTENT发布时间、DRAFT草稿时间', 'type' => 'string', 'required' => false, 'example' => 'CONTENT'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '-',
+ 'description' => '无',
'type' => 'object',
'properties' => [
- 'Errors' => [
- 'description' => '-',
- 'type' => 'array',
- 'items' => [
- 'description' => '错误列表',
- 'type' => 'object',
- 'properties' => [
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'Field' => [
- 'description' => '字段',
- 'type' => 'string',
- 'example' => 'status',
- ],
- ],
- ],
- ],
- 'Message' => [
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => 'bf1c45cd-3eee-4e60-b505-2e330bf755d3'],
'Data' => [
- 'description' => '-',
+ 'description' => '数据',
'type' => 'object',
'properties' => [
'Items' => [
@@ -5090,154 +4533,78 @@
'description' => '数据项',
'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '状态',
- 'type' => 'string',
- 'example' => 'runnable',
- ],
- 'DepartmentName' => [
- 'description' => '部门名称',
- 'type' => 'string',
- 'example' => '部门名称',
- ],
- 'Tasks' => [
- 'description' => '任务数',
- 'type' => 'array',
- 'items' => [
- 'description' => '任务数',
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => '任务状态',
- 'type' => 'string',
- 'example' => 'runnable',
- ],
- 'VideoMetaUrl' => [
- 'description' => '检测结果视频 meta 地址',
- 'type' => 'string',
- 'example' => 'http://oss.aliyuncs.com/1.mp4.meta',
- ],
- 'CreatedAt' => [
- 'description' => '任务创建日期',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Id' => [
- 'description' => '任务 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
- 'VideoUrl' => [
- 'description' => '检测结果视频地址',
- 'type' => 'string',
- 'example' => 'http://oss.aliyuncs.com/1.mp4',
- ],
- ],
- ],
- ],
- 'RecordingType' => [
- 'description' => '录制类型',
- 'type' => 'string',
- 'example' => 'local',
- ],
- 'CreatedAt' => [
- 'description' => '创建日期',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'DepartmentId' => [
- 'description' => '部门 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
- 'Id' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
- 'RuleName' => [
- 'description' => '规则名称',
- 'type' => 'string',
- 'example' => 'default',
- ],
- 'RuleId' => [
- 'description' => '规则 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'Draft' => ['description' => '流程配置正式内容', 'type' => 'string', 'example' => '{}'],
+ 'FileUrl' => ['description' => '可访问的文件 URL', 'type' => 'string', 'example' => 'http://abc.com/123.json'],
+ 'CreatedAt' => ['description' => '创建时间', 'type' => 'string', 'example' => '2020-12-04T14:47:59.000+08:00'],
+ 'Md5' => ['description' => '流程配置正式内容的 MD5', 'type' => 'string', 'example' => '987d563d38f5aef27feca8702c689bb1'],
+ 'UpdatedAt' => ['description' => '更新时间', 'type' => 'string', 'example' => '2020-12-04T14:48:59.000+08:00'],
+ 'DraftAt' => ['title' => '保存时间', 'description' => '保存时间', 'type' => 'string', 'example' => '2020-12-04T14:48:59.000+08:00'],
+ 'ContentAt' => ['title' => '发布时间', 'description' => '发布时间', 'type' => 'string', 'example' => '2020-12-04T14:48:59.000+08:00'],
+ 'NewVersion' => ['description' => '是否更新版本', 'type' => 'boolean', 'example' => 'true'],
+ 'Name' => ['description' => '检测流程名称', 'type' => 'string', 'example' => 'Android检测流程'],
+ 'Content' => ['description' => '流程配置正式内容', 'type' => 'string', 'example' => '{}'],
+ 'Id' => ['description' => 'ID', 'type' => 'string', 'example' => '0f1c45cd-3eee-4e60-b505-2e330b8755d3'],
+ 'Published' => ['description' => '是否已发布 true:已发布:false:未发布', 'type' => 'boolean', 'example' => 'True'],
+ 'Type' => ['description' => '标识本地双录和远程双录(LOCAL 或 REMOTE)', 'type' => 'string', 'example' => 'REMOTE'],
],
],
],
- 'TotalPages' => [
- 'description' => '总页数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '11',
- ],
- 'TotalElements' => [
- 'description' => '总条目数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
+ 'TotalPages' => ['description' => '总页数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'TotalElements' => ['description' => '总数', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
],
],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Code' => ['description' => '返回码', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Errors\\": [\\n {\\n \\"Message\\": \\"-\\",\\n \\"Field\\": \\"status\\"\\n }\\n ],\\n \\"Message\\": \\"-\\",\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Data\\": {\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"runnable\\",\\n \\"DepartmentName\\": \\"部门名称\\",\\n \\"Tasks\\": [\\n {\\n \\"Status\\": \\"runnable\\",\\n \\"VideoMetaUrl\\": \\"http://oss.aliyuncs.com/1.mp4.meta\\",\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"VideoUrl\\": \\"http://oss.aliyuncs.com/1.mp4\\"\\n }\\n ],\\n \\"RecordingType\\": \\"local\\",\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"DepartmentId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"RuleName\\": \\"default\\",\\n \\"RuleId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\"\\n }\\n ],\\n \\"TotalPages\\": 11,\\n \\"TotalElements\\": 1\\n },\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<Errors>\\n <Field>status</Field>\\n <Message>-</Message>\\n</Errors>\\n<Message/>\\n<RequestId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</RequestId>\\n<Data>\\n <TotalElements>1</TotalElements>\\n <TotalPages>11</TotalPages>\\n <Items>\\n <Status>runnable</Status>\\n <RecordingType>local</RecordingType>\\n <CreatedAt>2020-07-14T14:01:41.000+08:00</CreatedAt>\\n <RuleId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</RuleId>\\n <DepartmentName>部门名称</DepartmentName>\\n <DepartmentId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</DepartmentId>\\n <Id>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</Id>\\n <RuleName>default</RuleName>\\n </Items>\\n <Items>\\n <Tasks>\\n <Status>runnable</Status>\\n <CreatedAt>2020-07-14T14:01:41.000+08:00</CreatedAt>\\n <VideoMetaUrl>http://oss.aliyuncs.com/1.mp4.meta</VideoMetaUrl>\\n <Id>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</Id>\\n <VideoUrl>http://oss.aliyuncs.com/1.mp4</VideoUrl>\\n </Tasks>\\n </Items>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
- 'title' => 'ListDetections',
- 'summary' => '调用 ListDetections 获取检测结果列表。',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"bf1c45cd-3eee-4e60-b505-2e330bf755d3\\",\\n \\"Data\\": {\\n \\"Items\\": [\\n {\\n \\"Draft\\": \\"{}\\",\\n \\"FileUrl\\": \\"http://abc.com/123.json\\",\\n \\"CreatedAt\\": \\"2020-12-04T14:47:59.000+08:00\\",\\n \\"Md5\\": \\"987d563d38f5aef27feca8702c689bb1\\",\\n \\"UpdatedAt\\": \\"2020-12-04T14:48:59.000+08:00\\",\\n \\"DraftAt\\": \\"2020-12-04T14:48:59.000+08:00\\",\\n \\"ContentAt\\": \\"2020-12-04T14:48:59.000+08:00\\",\\n \\"NewVersion\\": true,\\n \\"Name\\": \\"Android检测流程\\",\\n \\"Content\\": \\"{}\\",\\n \\"Id\\": \\"0f1c45cd-3eee-4e60-b505-2e330b8755d3\\",\\n \\"Published\\": true,\\n \\"Type\\": \\"REMOTE\\"\\n }\\n ],\\n \\"TotalPages\\": 10,\\n \\"TotalElements\\": 100\\n },\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>bf1c45cd-3eee-4e60-b505-2e330bf755d3</RequestId>\\n<Message>-</Message>\\n<Data>\\n <TotalElements>100</TotalElements>\\n <TotalPages>10</TotalPages>\\n <Items>\\n <NewVersion>true</NewVersion>\\n <FileUrl>http://abc.com/123.json</FileUrl>\\n <Draft>{}</Draft>\\n <Content>{}</Content>\\n <CreatedAt>2020-12-04T14:47:59.000+08:00</CreatedAt>\\n <Id>0f1c45cd-3eee-4e60-b505-2e330b8755d3</Id>\\n <UpdatedAt>2020-12-04T14:48:59.000+08:00</UpdatedAt>\\n <Name>Android检测流程</Name>\\n <Md5>987d563d38f5aef27feca8702c689bb1</Md5>\\n </Items>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
+ 'title' => 'ListDetectProcesses',
+ 'summary' => '调用 ListDetectProcesses 获取检测流程列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ListDetectProcesses' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [
+ ['createdAt' => '2022-06-01T12:11:21.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2022-01-13T10:00:13.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:ListDetectProcesses',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListDetections' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5245,112 +4612,72 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'PageIndex',
+ 'name' => 'CreateDateFrom',
'in' => 'query',
- 'schema' => [
- 'description' => '页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => false,
- 'maximum' => '10000',
- 'minimum' => '1',
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['description' => '开始日期', 'type' => 'string', 'required' => false, 'example' => '2020-10-10'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'CreateDateTo',
'in' => 'query',
- 'schema' => [
- 'description' => '页大小',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => false,
- 'maximum' => '500',
- 'minimum' => '10',
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['description' => '结束日期', 'type' => 'string', 'required' => false, 'example' => '2020-10-11'],
],
[
- 'name' => 'Name',
+ 'name' => 'DepartmentId',
'in' => 'query',
- 'schema' => [
- 'description' => '检测流程名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '检测流程名称',
- ],
+ 'schema' => ['description' => '部门 ID', 'type' => 'string', 'required' => false, 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
[
- 'name' => 'PublishStatus',
+ 'name' => 'PageIndex',
'in' => 'query',
- 'allowEmptyValue' => false,
- 'schema' => [
- 'description' => '是否发布',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '10000', 'minimum' => '1', 'example' => '1', 'isFileTransferUrl' => false, 'default' => '1'],
],
[
- 'name' => 'Type',
+ 'name' => 'PageSize',
'in' => 'query',
- 'allowEmptyValue' => false,
- 'schema' => [
- 'description' => '类型:remote(远程双录),local(本地双录)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'LOCAL',
- ],
+ 'schema' => ['description' => '页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '100', 'minimum' => '10', 'example' => '10', 'isFileTransferUrl' => false, 'default' => '10'],
],
[
- 'name' => 'Sort',
+ 'name' => 'RecordingType',
'in' => 'query',
- 'allowEmptyValue' => true,
'schema' => [
- 'description' => '排序',
+ 'description' => '类型:remote(远程双录),local(本地双录)',
'type' => 'string',
'required' => false,
- 'example' => 'desc',
+ 'example' => 'local',
+ 'enum' => ['local', 'remote'],
],
],
[
- 'name' => 'SortKey',
+ 'name' => 'RuleId',
'in' => 'query',
- 'schema' => [
- 'description' => '排序字段:CONTENT发布时间、DRAFT草稿时间',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CONTENT',
- ],
+ 'schema' => ['description' => '规则 ID', 'type' => 'string', 'required' => false, 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '无',
+ 'description' => '-',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => 'bf1c45cd-3eee-4e60-b505-2e330bf755d3',
+ 'Errors' => [
+ 'description' => '-',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '错误列表',
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '-'],
+ 'Field' => ['description' => '字段', 'type' => 'string', 'example' => 'status'],
+ ],
+ ],
],
+ 'Message' => ['description' => '错误消息', 'type' => 'string', 'example' => '-'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
'Data' => [
- 'description' => '数据',
+ 'description' => '-',
'type' => 'object',
'properties' => [
'Items' => [
@@ -5360,146 +4687,85 @@
'description' => '数据项',
'type' => 'object',
'properties' => [
- 'Draft' => [
- 'description' => '流程配置正式内容',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'FileUrl' => [
- 'description' => '可访问的文件 URL',
- 'type' => 'string',
- 'example' => 'http://abc.com/123.json',
- ],
- 'CreatedAt' => [
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2020-12-04T14:47:59.000+08:00',
- ],
- 'Md5' => [
- 'description' => '流程配置正式内容的 MD5',
- 'type' => 'string',
- 'example' => '987d563d38f5aef27feca8702c689bb1',
- ],
- 'UpdatedAt' => [
- 'description' => '更新时间',
- 'type' => 'string',
- 'example' => '2020-12-04T14:48:59.000+08:00',
- ],
- 'DraftAt' => [
- 'title' => '保存时间',
- 'description' => '保存时间',
- 'type' => 'string',
- 'example' => '2020-12-04T14:48:59.000+08:00',
- ],
- 'ContentAt' => [
- 'title' => '发布时间',
- 'description' => '发布时间',
- 'type' => 'string',
- 'example' => '2020-12-04T14:48:59.000+08:00',
- ],
- 'NewVersion' => [
- 'description' => '是否更新版本',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Name' => [
- 'description' => '检测流程名称',
- 'type' => 'string',
- 'example' => 'Android检测流程',
- ],
- 'Content' => [
- 'description' => '流程配置正式内容',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'Id' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'example' => '0f1c45cd-3eee-4e60-b505-2e330b8755d3',
- ],
- 'Published' => [
- 'description' => '是否已发布 true:已发布:false:未发布',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'Type' => [
- 'description' => '标识本地双录和远程双录(LOCAL 或 REMOTE)',
- 'type' => 'string',
- 'example' => 'REMOTE',
+ 'Status' => ['description' => '状态', 'type' => 'string', 'example' => 'runnable'],
+ 'DepartmentName' => ['description' => '部门名称', 'type' => 'string', 'example' => '部门名称'],
+ 'Tasks' => [
+ 'description' => '任务数',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '任务数',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => '任务状态', 'type' => 'string', 'example' => 'runnable'],
+ 'VideoMetaUrl' => ['description' => '检测结果视频 meta 地址', 'type' => 'string', 'example' => 'http://oss.aliyuncs.com/1.mp4.meta'],
+ 'CreatedAt' => ['description' => '任务创建日期', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Id' => ['description' => '任务 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
+ 'VideoUrl' => ['description' => '检测结果视频地址', 'type' => 'string', 'example' => 'http://oss.aliyuncs.com/1.mp4'],
+ ],
+ ],
],
+ 'RecordingType' => ['description' => '录制类型', 'type' => 'string', 'example' => 'local'],
+ 'CreatedAt' => ['description' => '创建日期', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'DepartmentId' => ['description' => '部门 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
+ 'Id' => ['description' => 'ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
+ 'RuleName' => ['description' => '规则名称', 'type' => 'string', 'example' => 'default'],
+ 'RuleId' => ['description' => '规则 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
],
],
- 'TotalPages' => [
- 'description' => '总页数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'TotalElements' => [
- 'description' => '总数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
+ 'TotalPages' => ['description' => '总页数', 'type' => 'integer', 'format' => 'int32', 'example' => '11'],
+ 'TotalElements' => ['description' => '总条目数', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
],
- 'Code' => [
- 'description' => '返回码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"bf1c45cd-3eee-4e60-b505-2e330bf755d3\\",\\n \\"Data\\": {\\n \\"Items\\": [\\n {\\n \\"Draft\\": \\"{}\\",\\n \\"FileUrl\\": \\"http://abc.com/123.json\\",\\n \\"CreatedAt\\": \\"2020-12-04T14:47:59.000+08:00\\",\\n \\"Md5\\": \\"987d563d38f5aef27feca8702c689bb1\\",\\n \\"UpdatedAt\\": \\"2020-12-04T14:48:59.000+08:00\\",\\n \\"DraftAt\\": \\"2020-12-04T14:48:59.000+08:00\\",\\n \\"ContentAt\\": \\"2020-12-04T14:48:59.000+08:00\\",\\n \\"NewVersion\\": true,\\n \\"Name\\": \\"Android检测流程\\",\\n \\"Content\\": \\"{}\\",\\n \\"Id\\": \\"0f1c45cd-3eee-4e60-b505-2e330b8755d3\\",\\n \\"Published\\": true,\\n \\"Type\\": \\"REMOTE\\"\\n }\\n ],\\n \\"TotalPages\\": 10,\\n \\"TotalElements\\": 100\\n },\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>bf1c45cd-3eee-4e60-b505-2e330bf755d3</RequestId>\\n<Message>-</Message>\\n<Data>\\n <TotalElements>100</TotalElements>\\n <TotalPages>10</TotalPages>\\n <Items>\\n <NewVersion>true</NewVersion>\\n <FileUrl>http://abc.com/123.json</FileUrl>\\n <Draft>{}</Draft>\\n <Content>{}</Content>\\n <CreatedAt>2020-12-04T14:47:59.000+08:00</CreatedAt>\\n <Id>0f1c45cd-3eee-4e60-b505-2e330b8755d3</Id>\\n <UpdatedAt>2020-12-04T14:48:59.000+08:00</UpdatedAt>\\n <Name>Android检测流程</Name>\\n <Md5>987d563d38f5aef27feca8702c689bb1</Md5>\\n </Items>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
- 'title' => 'ListDetectProcesses',
- 'summary' => '调用 ListDetectProcesses 获取检测流程列表。',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Errors\\": [\\n {\\n \\"Message\\": \\"-\\",\\n \\"Field\\": \\"status\\"\\n }\\n ],\\n \\"Message\\": \\"-\\",\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Data\\": {\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"runnable\\",\\n \\"DepartmentName\\": \\"部门名称\\",\\n \\"Tasks\\": [\\n {\\n \\"Status\\": \\"runnable\\",\\n \\"VideoMetaUrl\\": \\"http://oss.aliyuncs.com/1.mp4.meta\\",\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"VideoUrl\\": \\"http://oss.aliyuncs.com/1.mp4\\"\\n }\\n ],\\n \\"RecordingType\\": \\"local\\",\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"DepartmentId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"RuleName\\": \\"default\\",\\n \\"RuleId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\"\\n }\\n ],\\n \\"TotalPages\\": 11,\\n \\"TotalElements\\": 1\\n },\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<Errors>\\n <Field>status</Field>\\n <Message>-</Message>\\n</Errors>\\n<Message/>\\n<RequestId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</RequestId>\\n<Data>\\n <TotalElements>1</TotalElements>\\n <TotalPages>11</TotalPages>\\n <Items>\\n <Status>runnable</Status>\\n <RecordingType>local</RecordingType>\\n <CreatedAt>2020-07-14T14:01:41.000+08:00</CreatedAt>\\n <RuleId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</RuleId>\\n <DepartmentName>部门名称</DepartmentName>\\n <DepartmentId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</DepartmentId>\\n <Id>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</Id>\\n <RuleName>default</RuleName>\\n </Items>\\n <Items>\\n <Tasks>\\n <Status>runnable</Status>\\n <CreatedAt>2020-07-14T14:01:41.000+08:00</CreatedAt>\\n <VideoMetaUrl>http://oss.aliyuncs.com/1.mp4.meta</VideoMetaUrl>\\n <Id>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</Id>\\n <VideoUrl>http://oss.aliyuncs.com/1.mp4</VideoUrl>\\n </Tasks>\\n </Items>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
+ 'title' => 'ListDetections',
+ 'summary' => '调用 ListDetections 获取检测结果列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:ListDetections',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'ListFiles' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5507,35 +4773,17 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Prefix',
'in' => 'query',
- 'schema' => [
- 'description' => '路径前缀',
- 'type' => 'string',
- 'required' => false,
- 'example' => '20220110/',
- ],
+ 'schema' => ['description' => '路径前缀', 'type' => 'string', 'required' => false, 'example' => '20220110/'],
],
[
'name' => 'Limit',
'in' => 'query',
- 'schema' => [
- 'description' => '数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => false,
- 'maximum' => '1000',
- 'minimum' => '1',
- 'example' => '500',
- 'isFileTransferUrl' => false,
- 'default' => '10',
- ],
+ 'schema' => ['description' => '数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '500', 'isFileTransferUrl' => false, 'default' => '10'],
],
],
'responses' => [
@@ -5544,61 +4792,29 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
- 'Data' => [
- 'title' => '数据',
- 'description' => '数据',
- 'type' => 'string',
- 'example' => '[\'d0388a41-30c6-4c74-af83-a1f923ce1725/process/\', \'d0388a41-30c6-4c74-af83-a1f923ce1725/video_12_14_09_05_41.mp4\', \'d0388a41-30c6-4c74-af83-a1f923ce1725/video_12_14_09_05_41.mp4.meta\']',
- ],
- 'Code' => [
- 'description' => '返回码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
+ 'Data' => ['title' => '数据', 'description' => '数据', 'type' => 'string', 'example' => '[\'d0388a41-30c6-4c74-af83-a1f923ce1725/process/\', \'d0388a41-30c6-4c74-af83-a1f923ce1725/video_12_14_09_05_41.mp4\', \'d0388a41-30c6-4c74-af83-a1f923ce1725/video_12_14_09_05_41.mp4.meta\']'],
+ 'Code' => ['description' => '返回码', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Data\\": \\"[\'d0388a41-30c6-4c74-af83-a1f923ce1725/process/\', \'d0388a41-30c6-4c74-af83-a1f923ce1725/video_12_14_09_05_41.mp4\', \'d0388a41-30c6-4c74-af83-a1f923ce1725/video_12_14_09_05_41.mp4.meta\']\\",\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<Message>-</Message>\\n<RequestId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</RequestId>\\n<Data>-</Data>\\n<Code>OK</Code>","errorExample":""}]',
@@ -5607,16 +4823,30 @@
'requestParamsDescription' => '该文件是由用户提供的存量的待质检的mp4文件,由开发人员提前上传至指定目录,在控制台中供展示和选择',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2022-01-12T03:08:53.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:ListFiles',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'ListRecordResults' => [
'summary' => '多规则查询',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5624,93 +4854,47 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RecordId',
'in' => 'query',
- 'schema' => [
- 'description' => '双录 ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942',
- ],
+ 'schema' => ['description' => '双录 ID', 'type' => 'string', 'required' => false, 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942'],
],
[
'name' => 'CreateDateFrom',
'in' => 'query',
- 'schema' => [
- 'title' => 'yyyy-MM-dd',
- 'description' => '查询起始日期,格式 yyyy-MM-dd',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2020-10-10',
- ],
+ 'schema' => ['title' => 'yyyy-MM-dd', 'description' => '查询起始日期,格式 yyyy-MM-dd', 'type' => 'string', 'required' => false, 'example' => '2020-10-10'],
],
[
'name' => 'CreateDateTo',
'in' => 'query',
- 'schema' => [
- 'title' => 'yyyy-MM-dd',
- 'description' => '查询结束日期,格式 yyyy-MM-dd',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2020-10-11',
- ],
+ 'schema' => ['title' => 'yyyy-MM-dd', 'description' => '查询结束日期,格式 yyyy-MM-dd', 'type' => 'string', 'required' => false, 'example' => '2020-10-11'],
],
[
'name' => 'DepartmentId',
'in' => 'query',
- 'schema' => [
- 'description' => '部门 ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '90c2459a-4c73-4ab7-8a6b-e550d62fbd8c',
- ],
+ 'schema' => ['description' => '部门 ID', 'type' => 'string', 'required' => false, 'example' => '90c2459a-4c73-4ab7-8a6b-e550d62fbd8c'],
],
[
'name' => 'Type',
'in' => 'query',
- 'schema' => [
- 'description' => '标识本地双录和远程双录(LOCAL 或 REMOTE)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'LOCAL',
- ],
+ 'schema' => ['description' => '标识本地双录和远程双录(LOCAL 或 REMOTE)', 'type' => 'string', 'required' => false, 'example' => 'LOCAL'],
],
[
'name' => 'PageIndex',
'in' => 'query',
- 'schema' => [
- 'description' => '页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '页大小',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'OuterBusinessId',
'in' => 'query',
- 'schema' => [
- 'description' => '业务ID,用户自定义',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ads32efef43',
- ],
+ 'schema' => ['description' => '业务ID,用户自定义', 'type' => 'string', 'required' => false, 'example' => 'ads32efef43'],
],
],
'responses' => [
@@ -5720,43 +4904,16 @@
'description' => 'ApiResult<RecordDTO>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'requestId',
- 'description' => 'requestId',
- 'type' => 'string',
- 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942',
- ],
- 'Code' => [
- 'title' => 'code',
- 'description' => 'code',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'title' => '提示',
- 'description' => '提示',
- 'type' => 'string',
- 'example' => '无',
- ],
+ 'RequestId' => ['title' => 'requestId', 'description' => 'requestId', 'type' => 'string', 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942'],
+ 'Code' => ['title' => 'code', 'description' => 'code', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['title' => '提示', 'description' => '提示', 'type' => 'string', 'example' => '无'],
'Data' => [
'title' => '数据',
'description' => '数据',
'type' => 'object',
'properties' => [
- 'TotalElements' => [
- 'title' => '总数据项数',
- 'description' => '总数据项数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'TotalPages' => [
- 'title' => '总页数',
- 'description' => '总页数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '11',
- ],
+ 'TotalElements' => ['title' => '总数据项数', 'description' => '总数据项数', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'TotalPages' => ['title' => '总页数', 'description' => '总页数', 'type' => 'integer', 'format' => 'int32', 'example' => '11'],
'Items' => [
'title' => '当前页面数据项',
'description' => '当前页面数据项',
@@ -5765,106 +4922,27 @@
'description' => '数据项',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '双录记录id',
- 'description' => '双录记录 ID',
- 'type' => 'string',
- 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942',
- ],
- 'CreatedAt' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'DetectProcessName' => [
- 'title' => '业务检测流程名',
- 'description' => '业务检测流程名',
- 'type' => 'string',
- 'example' => 'process name',
- ],
- 'DepartmentName' => [
- 'title' => '部门名',
- 'description' => '部门名',
- 'type' => 'string',
- 'example' => 'XX部门',
- ],
- 'AppName' => [
- 'title' => '应用名',
- 'description' => '应用名',
- 'type' => 'string',
- 'example' => 'myapp',
- ],
- 'VideoUrl' => [
- 'title' => '视频地址',
- 'description' => '视频地址',
- 'type' => 'string',
- 'example' => 'http://oss.aliyuncs.com/1.mp4',
- ],
- 'MetaUrl' => [
- 'title' => 'meta地址',
- 'description' => 'meta 地址',
- 'type' => 'string',
- 'example' => 'http://oss.aliyuncs.com/1.mp4.meta',
- ],
- 'ResultUrl' => [
- 'title' => '结果地址',
- 'description' => '结果地址',
- 'type' => 'string',
- 'example' => 'http://oss.aliyuncs.com/1.mp4.json',
- ],
- 'RecordAt' => [
- 'title' => '录制时间',
- 'description' => '录制时间',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Duration' => [
- 'title' => '时长',
- 'description' => '时长',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '22',
- ],
- 'Status' => [
- 'title' => '检测状态',
- 'description' => '检测状态',
- 'type' => 'string',
- 'example' => 'runnable',
- ],
- 'RoomId' => [
- 'title' => 'mrtc房间id',
- 'description' => 'mrtc 房间 ID',
- 'type' => 'string',
- 'example' => '642662467657798',
- ],
- 'RtcRecordId' => [
- 'description' => 'mrtc录制ID',
- 'type' => 'string',
- 'example' => 'record_65703154805715668342',
- ],
- 'OuterBusinessId' => [
- 'description' => '业务ID,用户自定义',
- 'type' => 'string',
- 'example' => 'fasfasda',
- ],
+ 'Id' => ['title' => '双录记录id', 'description' => '双录记录 ID', 'type' => 'string', 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942'],
+ 'CreatedAt' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'DetectProcessName' => ['title' => '业务检测流程名', 'description' => '业务检测流程名', 'type' => 'string', 'example' => 'process name'],
+ 'DepartmentName' => ['title' => '部门名', 'description' => '部门名', 'type' => 'string', 'example' => 'XX部门'],
+ 'AppName' => ['title' => '应用名', 'description' => '应用名', 'type' => 'string', 'example' => 'myapp'],
+ 'VideoUrl' => ['title' => '视频地址', 'description' => '视频地址', 'type' => 'string', 'example' => 'http://oss.aliyuncs.com/1.mp4'],
+ 'MetaUrl' => ['title' => 'meta地址', 'description' => 'meta 地址', 'type' => 'string', 'example' => 'http://oss.aliyuncs.com/1.mp4.meta'],
+ 'ResultUrl' => ['title' => '结果地址', 'description' => '结果地址', 'type' => 'string', 'example' => 'http://oss.aliyuncs.com/1.mp4.json'],
+ 'RecordAt' => ['title' => '录制时间', 'description' => '录制时间', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Duration' => ['title' => '时长', 'description' => '时长', 'type' => 'integer', 'format' => 'int64', 'example' => '22'],
+ 'Status' => ['title' => '检测状态', 'description' => '检测状态', 'type' => 'string', 'example' => 'runnable'],
+ 'RoomId' => ['title' => 'mrtc房间id', 'description' => 'mrtc 房间 ID', 'type' => 'string', 'example' => '642662467657798'],
+ 'RtcRecordId' => ['description' => 'mrtc录制ID', 'type' => 'string', 'example' => 'record_65703154805715668342'],
+ 'OuterBusinessId' => ['description' => '业务ID,用户自定义', 'type' => 'string', 'example' => 'fasfasda'],
],
],
],
],
],
- 'Success' => [
- 'title' => '给 pop 使用的',
- 'description' => '给 pop 使用的',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'HttpCode' => [
- 'description' => 'HTTP 状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Success' => ['title' => '给 pop 使用的', 'description' => '给 pop 使用的', 'type' => 'boolean', 'example' => 'True'],
+ 'HttpCode' => ['description' => 'HTTP 状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Errors' => [
'title' => '错误列表',
'description' => '错误列表',
@@ -5873,16 +4951,8 @@
'description' => '错误列表',
'type' => 'object',
'properties' => [
- 'Field' => [
- 'description' => '错误 ID',
- 'type' => 'string',
- 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942',
- ],
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '无',
- ],
+ 'Field' => ['description' => '错误 ID', 'type' => 'string', 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942'],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '无'],
],
],
],
@@ -5892,47 +4962,51 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A1899517-BB99-5D3E-A71B-97524DCB0942\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"TotalElements\\": 10,\\n \\"TotalPages\\": 11,\\n \\"Items\\": [\\n {\\n \\"Id\\": \\"A1899517-BB99-5D3E-A71B-97524DCB0942\\",\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"DetectProcessName\\": \\"process name\\",\\n \\"DepartmentName\\": \\"XX部门\\",\\n \\"AppName\\": \\"myapp\\",\\n \\"VideoUrl\\": \\"http://oss.aliyuncs.com/1.mp4\\",\\n \\"MetaUrl\\": \\"http://oss.aliyuncs.com/1.mp4.meta\\",\\n \\"ResultUrl\\": \\"http://oss.aliyuncs.com/1.mp4.json\\",\\n \\"RecordAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Duration\\": 22,\\n \\"Status\\": \\"runnable\\",\\n \\"RoomId\\": \\"642662467657798\\",\\n \\"RtcRecordId\\": \\"record_65703154805715668342\\",\\n \\"OuterBusinessId\\": \\"fasfasda\\"\\n }\\n ]\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200,\\n \\"Errors\\": [\\n {\\n \\"Field\\": \\"A1899517-BB99-5D3E-A71B-97524DCB0942\\",\\n \\"Message\\": \\"无\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '获取所有双录结果',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-29T07:30:50.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2022-07-05T11:05:58.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-01-12T07:55:37.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-01-09T16:48:09.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-01-05T06:05:26.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-01-04T07:08:00.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:ListRecordResults',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'ListRules' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5940,40 +5014,17 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'PageIndex',
'in' => 'query',
- 'schema' => [
- 'description' => '页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '10000',
- 'minimum' => '1',
- 'example' => '1',
- 'isFileTransferUrl' => false,
- 'default' => '1',
- ],
+ 'schema' => ['description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '1', 'example' => '1', 'isFileTransferUrl' => false, 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '页大小',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => false,
- 'maximum' => '100',
- 'minimum' => '10',
- 'example' => '1',
- 'isFileTransferUrl' => false,
- 'default' => '10',
- ],
+ 'schema' => ['description' => '页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '100', 'minimum' => '10', 'example' => '1', 'isFileTransferUrl' => false, 'default' => '10'],
],
],
'responses' => [
@@ -5982,16 +5033,8 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
'Data' => [
'description' => '无',
'type' => 'object',
@@ -6003,82 +5046,37 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'CreatedAt' => [
- 'description' => '创建日期',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Name' => [
- 'description' => '名称',
- 'type' => 'string',
- 'example' => 'default',
- ],
- 'Content' => [
- 'description' => '规则内容',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'Id' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'CreatedAt' => ['description' => '创建日期', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Name' => ['description' => '名称', 'type' => 'string', 'example' => 'default'],
+ 'Content' => ['description' => '规则内容', 'type' => 'string', 'example' => '{}'],
+ 'Id' => ['description' => 'ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
],
],
- 'TotalPages' => [
- 'description' => '总页数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TotalElements' => [
- 'description' => '总条目数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
+ 'TotalPages' => ['description' => '总页数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'TotalElements' => ['description' => '总条目数', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
],
- 'Code' => [
- 'description' => '返回码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Code' => ['description' => '返回码', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Data\\": {\\n \\"Items\\": [\\n {\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Name\\": \\"default\\",\\n \\"Content\\": \\"{}\\",\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\"\\n }\\n ],\\n \\"TotalPages\\": 1,\\n \\"TotalElements\\": 1\\n },\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</RequestId>\\n<Message>-</Message>\\n<Data>\\n <TotalElements>1</TotalElements>\\n <TotalPages>1</TotalPages>\\n <Items>\\n <Id>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</Id>\\n <Content>{}</Content>\\n <CreatedAt>2020-07-14T14:01:41.000+08:00</CreatedAt>\\n <Name>default</Name>\\n </Items>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
@@ -6087,15 +5085,27 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:ListRules',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'ListTaskGroups' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6103,41 +5113,17 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'PageIndex',
'in' => 'query',
- 'schema' => [
- 'description' => '页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => false,
- 'maximum' => '1000',
- 'minimum' => '1',
- 'example' => '1',
- 'isFileTransferUrl' => false,
- 'default' => '1',
- ],
+ 'schema' => ['description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', 'isFileTransferUrl' => false, 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '页大小',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => false,
- 'maximum' => '1000',
- 'minimum' => '10',
- 'example' => '10',
- 'isFileTransferUrl' => false,
- 'default' => '10',
- ],
+ 'schema' => ['description' => '页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '1000', 'minimum' => '10', 'example' => '10', 'isFileTransferUrl' => false, 'default' => '10'],
],
[
'name' => 'Status',
@@ -6147,11 +5133,7 @@
'type' => 'string',
'required' => false,
'example' => 'runnable',
- 'enum' => [
- 'wait',
- 'runnable',
- 'completed',
- ],
+ 'enum' => ['wait', 'runnable', 'completed'],
],
],
],
@@ -6161,16 +5143,8 @@
'description' => '-',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '-'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
'Data' => [
'description' => '-',
'type' => 'object',
@@ -6182,113 +5156,46 @@
'description' => '-',
'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '状态',
- 'type' => 'string',
- 'example' => 'runnable',
- ],
- 'CompletedTasks' => [
- 'description' => '完成任务数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'TotalTasks' => [
- 'description' => '总任务数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'CreatedAt' => [
- 'description' => '创建日期',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Name' => [
- 'description' => '名称',
- 'type' => 'string',
- 'example' => '任务名称',
- ],
+ 'Status' => ['description' => '状态', 'type' => 'string', 'example' => 'runnable'],
+ 'CompletedTasks' => ['description' => '完成任务数', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'TotalTasks' => ['description' => '总任务数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'CreatedAt' => ['description' => '创建日期', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Name' => ['description' => '名称', 'type' => 'string', 'example' => '任务名称'],
'TaskIds' => [
'description' => '任务 ID 列表',
'type' => 'array',
- 'items' => [
- 'description' => '任务组下的任务 ID 列表',
- 'type' => 'string',
- 'example' => '{}',
- ],
- ],
- 'Id' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
- 'RuleId' => [
- 'description' => '规则 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
- 'RuleName' => [
- 'description' => '规则名称',
- 'type' => 'string',
- 'example' => 'default',
+ 'items' => ['description' => '任务组下的任务 ID 列表', 'type' => 'string', 'example' => '{}'],
],
+ 'Id' => ['description' => 'ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
+ 'RuleId' => ['description' => '规则 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
+ 'RuleName' => ['description' => '规则名称', 'type' => 'string', 'example' => 'default'],
],
],
],
- 'TotalPages' => [
- 'description' => '总页数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TotalElements' => [
- 'description' => '条目数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
+ 'TotalPages' => ['description' => '总页数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'TotalElements' => ['description' => '条目数', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"-\\",\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Data\\": {\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"runnable\\",\\n \\"CompletedTasks\\": 0,\\n \\"TotalTasks\\": 1,\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Name\\": \\"任务名称\\",\\n \\"TaskIds\\": [\\n \\"{}\\"\\n ],\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"RuleId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"RuleName\\": \\"default\\"\\n }\\n ],\\n \\"TotalPages\\": 1,\\n \\"TotalElements\\": 1\\n },\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<Message>-</Message>\\n<RequestId/>\\n<Data>\\n <TotalElements>1</TotalElements>\\n <TotalPages>1</TotalPages>\\n <Items>\\n <Status>runnable</Status>\\n <CreatedAt>2020-07-14T14:01:41.000+08:00</CreatedAt>\\n <RuleId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</RuleId>\\n <TotalTasks>1</TotalTasks>\\n <CompletedTasks>0</CompletedTasks>\\n <Id>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</Id>\\n <RuleName>default</RuleName>\\n <Name>任务名称</Name>\\n <TaskIds>1</TaskIds>\\n <TaskIds>2</TaskIds>\\n </Items>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
@@ -6297,15 +5204,27 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:ListTaskGroups',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'ListTaskItems' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6313,20 +5232,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'TaskId',
'in' => 'query',
- 'schema' => [
- 'description' => '任务 ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'schema' => ['description' => '任务 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
],
'responses' => [
@@ -6335,16 +5246,8 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
'Data' => [
'description' => '无',
'type' => 'array',
@@ -6352,79 +5255,35 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '状态',
- 'type' => 'string',
- 'example' => 'completed',
- ],
- 'CreatedAt' => [
- 'description' => '创建日期',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Message' => [
- 'description' => '检测失败时的错误信息',
- 'type' => 'string',
- 'example' => '检测失败',
- ],
- 'Output' => [
- 'description' => '检测结果输出,该结果是一个 JSON 格式。不同的检测项格式不一样。',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'Name' => [
- 'description' => '检测项名称',
- 'type' => 'string',
- 'example' => '身份证识别',
- ],
- 'SegmentSeq' => [
- 'description' => '检测的视频分段号码',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
+ 'Status' => ['description' => '状态', 'type' => 'string', 'example' => 'completed'],
+ 'CreatedAt' => ['description' => '创建日期', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Message' => ['description' => '检测失败时的错误信息', 'type' => 'string', 'example' => '检测失败'],
+ 'Output' => ['description' => '检测结果输出,该结果是一个 JSON 格式。不同的检测项格式不一样。', 'type' => 'string', 'example' => '{}'],
+ 'Name' => ['description' => '检测项名称', 'type' => 'string', 'example' => '身份证识别'],
+ 'SegmentSeq' => ['description' => '检测的视频分段号码', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
],
],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Data\\": [\\n {\\n \\"Status\\": \\"completed\\",\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Message\\": \\"检测失败\\",\\n \\"Output\\": \\"{}\\",\\n \\"Name\\": \\"身份证识别\\",\\n \\"SegmentSeq\\": 1\\n }\\n ],\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<Message>-</Message>\\n<RequestId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</RequestId>\\n<Data>\\n <Status>completed</Status>\\n <SegmentSeq>1</SegmentSeq>\\n <Message>检测失败</Message>\\n <CreatedAt>2020-07-14T14:01:41.000+08:00</CreatedAt>\\n <Output>{}</Output>\\n <Name>身份证识别</Name>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
@@ -6433,15 +5292,27 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:ListTaskItems',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'ListTasks' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6449,51 +5320,22 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'PageIndex',
'in' => 'query',
- 'schema' => [
- 'description' => '页号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => false,
- 'maximum' => '10000',
- 'minimum' => '1',
- 'example' => '1',
- 'isFileTransferUrl' => false,
- 'default' => '1',
- ],
+ 'schema' => ['description' => '页号', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '10000', 'minimum' => '1', 'example' => '1', 'isFileTransferUrl' => false, 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '页大小',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => false,
- 'maximum' => '10000',
- 'minimum' => '10',
- 'example' => '10',
- 'isFileTransferUrl' => false,
- 'default' => '10',
- ],
+ 'schema' => ['description' => '页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '10000', 'minimum' => '10', 'example' => '10', 'isFileTransferUrl' => false, 'default' => '10'],
],
[
'name' => 'TaskGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '任务组 ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '任务组 ID', 'type' => 'string', 'required' => false, 'example' => '1'],
],
],
'responses' => [
@@ -6502,16 +5344,8 @@
'description' => '-',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '-'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
'Data' => [
'description' => '-',
'type' => 'object',
@@ -6523,87 +5357,38 @@
'description' => '-',
'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '状态',
- 'type' => 'string',
- 'example' => 'runnable',
- ],
- 'VideoMetaUrl' => [
- 'description' => '视频 meta 地址',
- 'type' => 'string',
- 'example' => 'http://oss.aliyuncs.com/1.mp4.meta?expire=2010323&sign=sf2324',
- ],
- 'CreatedAt' => [
- 'description' => '创建日期',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Id' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
- 'VideoUrl' => [
- 'description' => '视频地址',
- 'type' => 'string',
- 'example' => 'http://oss.aliyuncs.com/1.mp4?expire=2010323&sign=sf2324',
- ],
+ 'Status' => ['description' => '状态', 'type' => 'string', 'example' => 'runnable'],
+ 'VideoMetaUrl' => ['description' => '视频 meta 地址', 'type' => 'string', 'example' => 'http://oss.aliyuncs.com/1.mp4.meta?expire=2010323&sign=sf2324'],
+ 'CreatedAt' => ['description' => '创建日期', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Id' => ['description' => 'ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
+ 'VideoUrl' => ['description' => '视频地址', 'type' => 'string', 'example' => 'http://oss.aliyuncs.com/1.mp4?expire=2010323&sign=sf2324'],
],
],
],
- 'TotalPages' => [
- 'description' => '页数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TotalElements' => [
- 'description' => '条目数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
+ 'TotalPages' => ['description' => '页数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'TotalElements' => ['description' => '条目数', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"-\\",\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Data\\": {\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"runnable\\",\\n \\"VideoMetaUrl\\": \\"http://oss.aliyuncs.com/1.mp4.meta?expire=2010323&sign=sf2324\\",\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"VideoUrl\\": \\"http://oss.aliyuncs.com/1.mp4?expire=2010323&sign=sf2324\\"\\n }\\n ],\\n \\"TotalPages\\": 1,\\n \\"TotalElements\\": 1\\n },\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<Message>-</Message>\\n<RequestId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</RequestId>\\n<Data>\\n <TotalElements>1</TotalElements>\\n <TotalPages>1</TotalPages>\\n <Items>\\n <Status>runnable</Status>\\n <CreatedAt>2020-07-14T14:01:41.000+08:00</CreatedAt>\\n <VideoMetaUrl>http://oss.aliyuncs.com/1.mp4.meta?expire=2010323&amp;sign=sf2324</VideoMetaUrl>\\n <Id>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</Id>\\n <VideoUrl>http://oss.aliyuncs.com/1.mp4?expire=2010323&amp;sign=sf2324</VideoUrl>\\n </Items>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
@@ -6612,15 +5397,27 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:ListTasks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'ListUsers' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6628,61 +5425,27 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'DepartmentId',
'in' => 'query',
- 'schema' => [
- 'description' => '部门 ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'schema' => ['description' => '部门 ID', 'type' => 'string', 'required' => false, 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
[
'name' => 'PageIndex',
'in' => 'query',
- 'schema' => [
- 'description' => '分页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => false,
- 'maximum' => '10000',
- 'minimum' => '1',
- 'example' => '1',
- 'isFileTransferUrl' => false,
- 'default' => '1',
- ],
+ 'schema' => ['description' => '分页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '10000', 'minimum' => '1', 'example' => '1', 'isFileTransferUrl' => false, 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '页大小',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => false,
- 'maximum' => '500',
- 'minimum' => '10',
- 'example' => '10',
- 'isFileTransferUrl' => false,
- 'default' => '10',
- ],
+ 'schema' => ['description' => '页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '500', 'minimum' => '10', 'example' => '10', 'isFileTransferUrl' => false, 'default' => '10'],
],
[
'name' => 'Username',
'in' => 'query',
- 'schema' => [
- 'description' => '搜索指定用户名',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'tom',
- ],
+ 'schema' => ['description' => '搜索指定用户名', 'type' => 'string', 'required' => false, 'example' => 'tom'],
],
],
'responses' => [
@@ -6691,16 +5454,8 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '响应信息',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
'Data' => [
'description' => '无',
'type' => 'object',
@@ -6712,21 +5467,9 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'RamUsername' => [
- 'description' => 'RAM 用户名',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'Email' => [
- 'description' => '电子邮件',
- 'type' => 'string',
- 'example' => 'a@a.com',
- ],
- 'PhoneNumber' => [
- 'description' => '手机号码',
- 'type' => 'string',
- 'example' => '186000000',
- ],
+ 'RamUsername' => ['description' => 'RAM 用户名', 'type' => 'string', 'example' => 'xxx'],
+ 'Email' => ['description' => '电子邮件', 'type' => 'string', 'example' => 'a@a.com'],
+ 'PhoneNumber' => ['description' => '手机号码', 'type' => 'string', 'example' => '186000000'],
'Departments' => [
'description' => '所属部门列表',
'type' => 'array',
@@ -6734,125 +5477,48 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'Description' => [
- 'description' => '描述',
- 'type' => 'string',
- 'example' => '部门',
- ],
- 'CreatedAt' => [
- 'description' => '创建日期',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'UpdatedAt' => [
- 'description' => '更新日期',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Name' => [
- 'description' => '部门名称',
- 'type' => 'string',
- 'example' => '不明',
- ],
- 'Id' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'Description' => ['description' => '描述', 'type' => 'string', 'example' => '部门'],
+ 'CreatedAt' => ['description' => '创建日期', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'UpdatedAt' => ['description' => '更新日期', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Name' => ['description' => '部门名称', 'type' => 'string', 'example' => '不明'],
+ 'Id' => ['description' => 'ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
],
],
- 'CreatedAt' => [
- 'description' => '创建日期',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'UpdatedAt' => [
- 'description' => '更新日期',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Source' => [
- 'description' => '用户来源',
- 'type' => 'string',
- 'example' => 'ram',
- ],
- 'Role' => [
- 'description' => '角色',
- 'type' => 'string',
- 'example' => 'admin',
- ],
- 'Name' => [
- 'description' => '姓名',
- 'type' => 'string',
- 'example' => '高x',
- ],
- 'Id' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Username' => [
- 'description' => '用户名',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
+ 'CreatedAt' => ['description' => '创建日期', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'UpdatedAt' => ['description' => '更新日期', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Source' => ['description' => '用户来源', 'type' => 'string', 'example' => 'ram'],
+ 'Role' => ['description' => '角色', 'type' => 'string', 'example' => 'admin'],
+ 'Name' => ['description' => '姓名', 'type' => 'string', 'example' => '高x'],
+ 'Id' => ['description' => 'ID', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Username' => ['description' => '用户名', 'type' => 'string', 'example' => 'xxx'],
],
],
],
- 'TotalPages' => [
- 'description' => '总页数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TotalElements' => [
- 'description' => '总条数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
+ 'TotalPages' => ['description' => '总页数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'TotalElements' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
],
],
- 'Code' => [
- 'description' => '返回码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Code' => ['description' => '返回码', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Data\\": {\\n \\"Items\\": [\\n {\\n \\"RamUsername\\": \\"xxx\\",\\n \\"Email\\": \\"a@a.com\\",\\n \\"PhoneNumber\\": \\"186000000\\",\\n \\"Departments\\": [\\n {\\n \\"Description\\": \\"部门\\",\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"UpdatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Name\\": \\"不明\\",\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\"\\n }\\n ],\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"UpdatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Source\\": \\"ram\\",\\n \\"Role\\": \\"admin\\",\\n \\"Name\\": \\"高x\\",\\n \\"Id\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Username\\": \\"xxx\\"\\n }\\n ],\\n \\"TotalPages\\": 1,\\n \\"TotalElements\\": 10\\n },\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<Message>-</Message>\\n<RequestId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</RequestId>\\n<Data>\\n <TotalElements>10</TotalElements>\\n <TotalPages>1</TotalPages>\\n <Items>\\n <Role>admin</Role>\\n <Email>a@a.com</Email>\\n <Username>xxx</Username>\\n <CreatedAt>2020-07-14T14:01:41.000+08:00</CreatedAt>\\n <RamUsername>xxx</RamUsername>\\n <PhoneNumber>186000000</PhoneNumber>\\n <Id>2020-07-14T14:01:41.000+08:00</Id>\\n <UpdatedAt>2020-07-14T14:01:41.000+08:00</UpdatedAt>\\n <Source>ram</Source>\\n <Name>高x</Name>\\n <Departments>\\n <Description>部门</Description>\\n <CreatedAt>2020-07-14T14:01:41.000+08:00</CreatedAt>\\n <Id>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</Id>\\n <UpdatedAt>2020-07-14T14:01:41.000+08:00</UpdatedAt>\\n <Name>不明</Name>\\n </Departments>\\n </Items>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
@@ -6861,16 +5527,28 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:ListUsers',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'ListWatermarks' => [
'summary' => '获取水印列表',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6878,31 +5556,17 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- ],
+ 'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'PageIndex',
'in' => 'query',
- 'schema' => [
- 'description' => '页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '页大小',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
@@ -6912,43 +5576,16 @@
'description' => 'ApiResult<PageDTO<WatermarkDTO>>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'requestId',
- 'description' => 'requestId',
- 'type' => 'string',
- 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942',
- ],
- 'Code' => [
- 'title' => 'code',
- 'description' => 'code',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'title' => '提示',
- 'description' => '提示',
- 'type' => 'string',
- 'example' => '-',
- ],
+ 'RequestId' => ['title' => 'requestId', 'description' => 'requestId', 'type' => 'string', 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942'],
+ 'Code' => ['title' => 'code', 'description' => 'code', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['title' => '提示', 'description' => '提示', 'type' => 'string', 'example' => '-'],
'Data' => [
'title' => '数据',
'description' => '数据',
'type' => 'object',
'properties' => [
- 'TotalElements' => [
- 'title' => '总数据项数',
- 'description' => '总数据项数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'TotalPages' => [
- 'title' => '总页数',
- 'description' => '总页数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'TotalElements' => ['title' => '总数据项数', 'description' => '总数据项数', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'TotalPages' => ['title' => '总页数', 'description' => '总页数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Items' => [
'title' => '当前页面数据项',
'description' => '当前页面数据项',
@@ -6957,47 +5594,17 @@
'description' => '-',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '水印id',
- 'description' => '水印 ID',
- 'type' => 'string',
- 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942',
- ],
- 'CreatedAt' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Value' => [
- 'title' => '水印信息',
- 'description' => '水印信息',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'Name' => [
- 'title' => '水印名称',
- 'description' => '水印名称',
- 'type' => 'string',
- 'example' => '名称',
- ],
+ 'Id' => ['title' => '水印id', 'description' => '水印 ID', 'type' => 'string', 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942'],
+ 'CreatedAt' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Value' => ['title' => '水印信息', 'description' => '水印信息', 'type' => 'string', 'example' => '{}'],
+ 'Name' => ['title' => '水印名称', 'description' => '水印名称', 'type' => 'string', 'example' => '名称'],
],
],
],
],
],
- 'Success' => [
- 'title' => '给 pop 使用的',
- 'description' => '给 pop 使用的',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'HttpCode' => [
- 'description' => 'HTTP 状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Success' => ['title' => '给 pop 使用的', 'description' => '给 pop 使用的', 'type' => 'boolean', 'example' => 'True'],
+ 'HttpCode' => ['description' => 'HTTP 状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Errors' => [
'title' => '错误列表',
'description' => '错误列表',
@@ -7006,16 +5613,8 @@
'description' => '-',
'type' => 'object',
'properties' => [
- 'Field' => [
- 'description' => '错误 ID',
- 'type' => 'string',
- 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942',
- ],
- 'Message' => [
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '-',
- ],
+ 'Field' => ['description' => '错误 ID', 'type' => 'string', 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942'],
+ 'Message' => ['description' => '错误消息', 'type' => 'string', 'example' => '-'],
],
],
],
@@ -7025,47 +5624,47 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A1899517-BB99-5D3E-A71B-97524DCB0942\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"-\\",\\n \\"Data\\": {\\n \\"TotalElements\\": 1,\\n \\"TotalPages\\": 1,\\n \\"Items\\": [\\n {\\n \\"Id\\": \\"A1899517-BB99-5D3E-A71B-97524DCB0942\\",\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Value\\": \\"{}\\",\\n \\"Name\\": \\"名称\\"\\n }\\n ]\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200,\\n \\"Errors\\": [\\n {\\n \\"Field\\": \\"A1899517-BB99-5D3E-A71B-97524DCB0942\\",\\n \\"Message\\": \\"-\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '列表展示水印信息',
+ 'changeSet' => [
+ ['createdAt' => '2022-01-04T11:03:18.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-01-04T07:08:00.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'idrsservice:ListWatermarks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'RenameDetectProcess' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7073,31 +5672,17 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- ],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
- 'schema' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1q1c45cd-3eee-1e60-b505-2e330b8755d2',
- ],
+ 'schema' => ['description' => 'ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1q1c45cd-3eee-1e60-b505-2e330b8755d2'],
],
[
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '名称',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '新名称',
- ],
+ 'schema' => ['description' => '名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '新名称'],
],
],
'responses' => [
@@ -7106,91 +5691,40 @@
'description' => '-',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => 'db1c45cd-3eee-1e60-b505-2e330b8755d2',
- ],
+ 'Message' => ['description' => '错误消息', 'type' => 'string', 'example' => '-'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => 'db1c45cd-3eee-1e60-b505-2e330b8755d2'],
'Data' => [
'description' => '数据',
'type' => 'object',
'properties' => [
- 'Draft' => [
- 'description' => '流程配置草稿内容',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'CreatedAt' => [
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2020-12-04T14:47:59.000+08:00',
- ],
- 'Md5' => [
- 'description' => '流程配置正式内容的 MD5',
- 'type' => 'string',
- 'example' => '987d563d38f5aef27feca8702c689bb1',
- ],
- 'Name' => [
- 'description' => '检测流程名称',
- 'type' => 'string',
- 'example' => 'Android检测流程',
- ],
- 'Content' => [
- 'description' => '流程配置正式内容',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'Id' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'example' => '0f1c45cd-3eee-4e60-b505-2e330b8755d3',
- ],
+ 'Draft' => ['description' => '流程配置草稿内容', 'type' => 'string', 'example' => '{}'],
+ 'CreatedAt' => ['description' => '创建时间', 'type' => 'string', 'example' => '2020-12-04T14:47:59.000+08:00'],
+ 'Md5' => ['description' => '流程配置正式内容的 MD5', 'type' => 'string', 'example' => '987d563d38f5aef27feca8702c689bb1'],
+ 'Name' => ['description' => '检测流程名称', 'type' => 'string', 'example' => 'Android检测流程'],
+ 'Content' => ['description' => '流程配置正式内容', 'type' => 'string', 'example' => '{}'],
+ 'Id' => ['description' => 'ID', 'type' => 'string', 'example' => '0f1c45cd-3eee-4e60-b505-2e330b8755d3'],
],
],
- 'Code' => [
- 'description' => '返回码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Code' => ['description' => '返回码', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"-\\",\\n \\"RequestId\\": \\"db1c45cd-3eee-1e60-b505-2e330b8755d2\\",\\n \\"Data\\": {\\n \\"Draft\\": \\"{}\\",\\n \\"CreatedAt\\": \\"2020-12-04T14:47:59.000+08:00\\",\\n \\"Md5\\": \\"987d563d38f5aef27feca8702c689bb1\\",\\n \\"Name\\": \\"Android检测流程\\",\\n \\"Content\\": \\"{}\\",\\n \\"Id\\": \\"0f1c45cd-3eee-4e60-b505-2e330b8755d3\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>db1c45cd-3eee-1e60-b505-2e330b8755d2</RequestId>\\n<Message>-</Message>\\n<Data>\\n <Draft>{}</Draft>\\n <Content>{}</Content>\\n <CreatedAt>2020-12-04T14:47:59.000+08:00</CreatedAt>\\n <Id>0f1c45cd-3eee-4e60-b505-2e330b8755d3</Id>\\n <Name>Android检测流程</Name>\\n <Md5>987d563d38f5aef27feca8702c689bb1</Md5>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
@@ -7199,15 +5733,132 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'idrsservice:RenameDetectProcess',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
- 'UpdateApp' => [
- 'methods' => [
- 'post',
+ 'TtsCommon' => [
+ 'summary' => '语音合成',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none'],
+ 'parameters' => [
+ [
+ 'name' => 'TtsRequest',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '请求参数',
+ 'type' => 'object',
+ 'properties' => [
+ 'AppId' => ['title' => 'appid', 'description' => 'appid', 'type' => 'string', 'required' => false, 'example' => 'd61be709-49d2-4cf1-b219-cd6181f72***'],
+ 'Text' => ['title' => '文本', 'description' => '文本', 'type' => 'string', 'required' => false, 'example' => '北京的天气'],
+ 'Voice' => ['title' => '发音人', 'description' => '发音人', 'type' => 'string', 'required' => false, 'example' => 'Xiaoyun'],
+ 'Format' => ['title' => '音频编码格式', 'description' => '音频编码格式', 'type' => 'string', 'required' => false, 'example' => 'WAV'],
+ 'Volume' => ['title' => '音量', 'description' => '音量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'],
+ 'SampleRate' => ['title' => '音频采样率', 'description' => '音频采样率', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '16000'],
+ 'SpeechRate' => ['title' => '语速', 'description' => '语速', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'],
+ 'PitchRate' => ['title' => '语调', 'description' => '语调', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'],
+ ],
+ 'required' => false,
+ ],
+ ],
],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'ApiResult<TtsResponseDTO>',
+ 'description' => 'ApiResult<TtsResponseDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'requestId', 'type' => 'string', 'example' => 'c761f0ec-107c-43dc-8565-45330e10e11b'],
+ 'Code' => ['description' => '返回码', 'type' => 'integer', 'format' => 'int32', 'example' => 'OK'],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '-'],
+ 'Data' => [
+ 'description' => '数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => '双录端处理tts任务ID', 'description' => '双录端处理tts任务ID', 'type' => 'string', 'example' => '63bb629d-92bf-4cdc-ad0b-3032c926****'],
+ 'TaskId' => ['title' => '智能语音tts任务ID', 'description' => '智能语音tts任务ID', 'type' => 'string', 'example' => '368cfa55-2364-4d79-aeb4-c0956c4a****'],
+ 'Name' => ['title' => '智能语音tts任务名称', 'description' => '智能语音tts任务名称', 'type' => 'string', 'example' => '任务1'],
+ 'Code' => ['title' => '智能语音tts任务code', 'description' => '智能语音tts任务code', 'type' => 'integer', 'format' => 'int32', 'example' => '20000000'],
+ 'Message' => ['title' => '智能语音tts任务message', 'description' => '智能语音tts任务message', 'type' => 'string', 'example' => '-'],
+ 'PublicUrl' => ['title' => '双录端语音合成结果可公网下载地址', 'description' => '双录端语音合成结果可公网下载地址', 'type' => 'string', 'example' => 'http://idrs-daily.oss-cn-beijing.aliyuncs.com/mode/android/model.zip?Expires=1607004612&OSSAccessKeyId=LTAI4FcsdDhFc7h78gqB****&Signature=XXXXX'],
+ ],
+ ],
+ 'Success' => ['title' => '给 pop 使用的', 'description' => '给 pop 使用的', 'type' => 'boolean', 'example' => 'True'],
+ 'HttpCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
+ ],
+ [
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
+ ],
+ 403 => [
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"c761f0ec-107c-43dc-8565-45330e10e11b\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"-\\",\\n \\"Data\\": {\\n \\"Id\\": \\"63bb629d-92bf-4cdc-ad0b-3032c926****\\",\\n \\"TaskId\\": \\"368cfa55-2364-4d79-aeb4-c0956c4a****\\",\\n \\"Name\\": \\"任务1\\",\\n \\"Code\\": 20000000,\\n \\"Message\\": \\"-\\",\\n \\"PublicUrl\\": \\"http://idrs-daily.oss-cn-beijing.aliyuncs.com/mode/android/model.zip?Expires=1607004612&OSSAccessKeyId=LTAI4FcsdDhFc7h78gqB****&Signature=XXXXX\\"\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200\\n}","type":"json"}]',
+ 'title' => '语音合成',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-08T02:21:10.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-07-08T02:03:24.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-07-07T13:28:03.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-07-07T09:05:44.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'idrsservice:TtsCommon',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'TtsTask' => [
+ 'summary' => '单向视频双录-语音合成推送任务',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7215,60 +5866,126 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
- 'name' => 'Id',
- 'in' => 'query',
+ 'name' => 'Request',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '应用 ID',
- 'type' => 'string',
+ 'description' => '任务请求参数',
+ 'type' => 'object',
+ 'properties' => [
+ 'RoomId' => ['description' => 'mrtc 房间 ID', 'type' => 'string', 'required' => true, 'example' => '655259585579***'],
+ 'Key' => ['description' => 'TTS问题KEY', 'type' => 'string', 'required' => true, 'example' => 'd9ee5df9-20bf-47bf-987a-76b26984b***'],
+ 'Timestamp' => ['description' => '时间戳', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1662271315039'],
+ ],
'required' => true,
- 'docRequired' => true,
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
],
],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'ApiResult<H5TtsResponseDTO>',
+ 'description' => 'ApiResult<H5TtsResponseDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '唯一请求识别码', 'type' => 'string', 'example' => '16A4A091-98BE-55F4-92D1-21590658***'],
+ 'Code' => ['description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => 'OK'],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '-'],
+ 'Data' => [
+ 'description' => '数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'Question' => ['description' => '问题', 'type' => 'string', 'example' => '北京的天气如何'],
+ 'Answer' => ['description' => '回复', 'type' => 'string', 'example' => '晴朗'],
+ 'Duration' => ['description' => '合成的音频时长,单位毫秒', 'type' => 'number', 'format' => 'double', 'example' => '727'],
+ 'SpeechRate' => ['description' => '语速', 'type' => 'integer', 'format' => 'int32', 'example' => '64'],
+ ],
+ ],
+ 'Success' => ['title' => '给 pop 使用的', 'description' => '给 pop 使用的', 'type' => 'boolean', 'example' => 'True'],
+ 'HttpCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
+ ],
+ [
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
+ ],
+ 403 => [
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
+ ],
+ [
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A4A091-98BE-55F4-92D1-21590658***\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"-\\",\\n \\"Data\\": {\\n \\"Question\\": \\"北京的天气如何\\",\\n \\"Answer\\": \\"晴朗\\",\\n \\"Duration\\": 727,\\n \\"SpeechRate\\": 64\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200\\n}","type":"json"}]',
+ 'title' => '提交TTS任务',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-29T02:57:01.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-08-26T03:41:52.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'idrsservice:TtsTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'UpdateApp' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
+ [
+ 'name' => 'Id',
+ 'in' => 'query',
+ 'schema' => ['description' => '应用 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
+ ],
[
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '名称',
- ],
+ 'schema' => ['description' => '名称', 'type' => 'string', 'required' => false, 'example' => '名称'],
],
[
'name' => 'Disabled',
'in' => 'query',
- 'schema' => [
- 'description' => '是否被禁用',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => '是否被禁用', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'PackageName',
'in' => 'query',
- 'schema' => [
- 'description' => '包名,用户移动端 SDK 校验',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'com.aliyun.idrs.sdk',
- ],
+ 'schema' => ['description' => '包名,用户移动端 SDK 校验', 'type' => 'string', 'required' => false, 'example' => 'com.aliyun.idrs.sdk'],
],
[
'name' => 'DepartmentId',
'in' => 'query',
- 'schema' => [
- 'description' => '部门 ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'schema' => ['description' => '部门 ID', 'type' => 'string', 'required' => false, 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
],
'responses' => [
@@ -7277,26 +5994,10 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '84118BF0-56F7-54D2-8C1A-35BBBBD5016B',
- ],
- 'Data' => [
- 'description' => '返回数据',
- 'type' => 'object',
- 'example' => '无',
- ],
- 'Code' => [
- 'description' => '返回码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Message' => ['description' => '错误消息', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '84118BF0-56F7-54D2-8C1A-35BBBBD5016B'],
+ 'Data' => ['description' => '返回数据', 'type' => 'object', 'example' => '无'],
+ 'Code' => ['description' => '返回码', 'type' => 'string', 'example' => 'OK'],
],
],
],
@@ -7304,80 +6005,68 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'code' => [
- 'type' => 'string',
- ],
- 'data' => [
- 'type' => 'object',
- ],
- 'requestId' => [
- 'type' => 'string',
- ],
- 'message' => [
- 'type' => 'string',
- ],
+ 'code' => ['type' => 'string', 'description' => ''],
+ 'data' => ['type' => 'object', 'description' => ''],
+ 'requestId' => ['type' => 'string', 'description' => ''],
+ 'message' => ['type' => 'string', 'description' => ''],
'errors' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'message' => [
- 'type' => 'string',
- ],
- 'field' => [
- 'type' => 'string',
- ],
+ 'message' => ['type' => 'string', 'description' => ''],
+ 'field' => ['type' => 'string', 'description' => ''],
],
+ 'description' => '',
],
+ 'description' => '',
],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"84118BF0-56F7-54D2-8C1A-35BBBBD5016B\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]',
'title' => '更新应用',
'summary' => '调用 UpdateApp 更新应用。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'idrsservice:UpdateApp',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'UpdateDepartment' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7385,50 +6074,27 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'Description',
'in' => 'formData',
- 'schema' => [
- 'description' => '描述',
- 'type' => 'string',
- 'required' => false,
- 'example' => '描述',
- ],
+ 'schema' => ['description' => '描述', 'type' => 'string', 'required' => false, 'example' => '描述'],
],
[
'name' => 'Label',
'in' => 'formData',
- 'schema' => [
- 'description' => '标签',
- 'type' => 'string',
- 'required' => false,
- 'example' => '标签',
- ],
+ 'schema' => ['description' => '标签', 'type' => 'string', 'required' => false, 'example' => '标签'],
],
[
'name' => 'Name',
'in' => 'formData',
- 'schema' => [
- 'description' => '名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '名称',
- ],
+ 'schema' => ['description' => '名称', 'type' => 'string', 'required' => false, 'example' => '名称'],
],
[
'name' => 'Id',
'in' => 'query',
- 'schema' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'schema' => ['description' => 'ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
],
'responses' => [
@@ -7437,60 +6103,29 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
- 'Data' => [
- 'description' => '无',
- 'type' => 'object',
- 'example' => '无',
- ],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
+ 'Data' => ['description' => '无', 'type' => 'object', 'example' => '无'],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<Message>-</Message>\\n<RequestId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</RequestId>\\n<Data>-</Data>\\n<Code>OK</Code>","errorExample":""}]',
@@ -7499,15 +6134,27 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'idrsservice:UpdateDepartment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'UpdateDetectProcess' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7515,51 +6162,27 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
- 'schema' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '0f1c45cd-3eee-4e60-b505-2e330b8755d3',
- ],
+ 'schema' => ['description' => 'ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0f1c45cd-3eee-4e60-b505-2e330b8755d3'],
],
[
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '检测流程名称',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'Android检测流程',
- ],
+ 'schema' => ['description' => '检测流程名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Android检测流程'],
],
[
'name' => 'Draft',
'in' => 'query',
- 'schema' => [
- 'description' => '流程配置草稿内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
+ 'schema' => ['description' => '流程配置草稿内容', 'type' => 'string', 'required' => false, 'example' => '{}'],
],
[
'name' => 'Content',
'in' => 'query',
- 'schema' => [
- 'description' => '流程配置正式内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
+ 'schema' => ['description' => '流程配置正式内容', 'type' => 'string', 'required' => false, 'example' => '{}'],
],
],
'responses' => [
@@ -7568,91 +6191,40 @@
'description' => '-',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '0c1c45cd-3eee-4e60-b505-2e330b8755d3',
- ],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '-'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '0c1c45cd-3eee-4e60-b505-2e330b8755d3'],
'Data' => [
'description' => '数据',
'type' => 'object',
'properties' => [
- 'Draft' => [
- 'description' => '流程配置草稿内容',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'CreatedAt' => [
- 'description' => '流程配置正式内容',
- 'type' => 'string',
- 'example' => '2020-12-04T14:47:59.000+08:00',
- ],
- 'Md5' => [
- 'description' => '流程配置正式内容的 MD5',
- 'type' => 'string',
- 'example' => '987d563d38f5aef27feca8702c689bb1',
- ],
- 'Name' => [
- 'description' => '检测流程名称',
- 'type' => 'string',
- 'example' => 'Android检测流程',
- ],
- 'Content' => [
- 'description' => '流程配置正式内容',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'Id' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'example' => 'cd1c45cd-3eee-4e60-b505-2e330b8755d3',
- ],
+ 'Draft' => ['description' => '流程配置草稿内容', 'type' => 'string', 'example' => '{}'],
+ 'CreatedAt' => ['description' => '流程配置正式内容', 'type' => 'string', 'example' => '2020-12-04T14:47:59.000+08:00'],
+ 'Md5' => ['description' => '流程配置正式内容的 MD5', 'type' => 'string', 'example' => '987d563d38f5aef27feca8702c689bb1'],
+ 'Name' => ['description' => '检测流程名称', 'type' => 'string', 'example' => 'Android检测流程'],
+ 'Content' => ['description' => '流程配置正式内容', 'type' => 'string', 'example' => '{}'],
+ 'Id' => ['description' => 'ID', 'type' => 'string', 'example' => 'cd1c45cd-3eee-4e60-b505-2e330b8755d3'],
],
],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"-\\",\\n \\"RequestId\\": \\"0c1c45cd-3eee-4e60-b505-2e330b8755d3\\",\\n \\"Data\\": {\\n \\"Draft\\": \\"{}\\",\\n \\"CreatedAt\\": \\"2020-12-04T14:47:59.000+08:00\\",\\n \\"Md5\\": \\"987d563d38f5aef27feca8702c689bb1\\",\\n \\"Name\\": \\"Android检测流程\\",\\n \\"Content\\": \\"{}\\",\\n \\"Id\\": \\"cd1c45cd-3eee-4e60-b505-2e330b8755d3\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0c1c45cd-3eee-4e60-b505-2e330b8755d3</RequestId>\\n<Message>-</Message>\\n<Data>\\n <Draft>{}</Draft>\\n <Content>{}</Content>\\n <CreatedAt>2020-12-04T14:47:59.000+08:00</CreatedAt>\\n <Id>cd1c45cd-3eee-4e60-b505-2e330b8755d3</Id>\\n <Name>Android检测流程</Name>\\n <Md5>987d563d38f5aef27feca8702c689bb1</Md5>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
@@ -7662,15 +6234,27 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'idrsservice:UpdateDetectProcess',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'UpdateRule' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7678,40 +6262,22 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
- 'schema' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'Id',
- ],
+ 'schema' => ['description' => 'ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Id'],
],
[
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '规则名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '名称',
- ],
+ 'schema' => ['description' => '规则名称', 'type' => 'string', 'required' => false, 'example' => '名称'],
],
[
'name' => 'Content',
'in' => 'query',
- 'schema' => [
- 'description' => '请按检测规则格式录入',
- 'type' => 'string',
- 'required' => false,
- 'example' => '规则内容',
- ],
+ 'schema' => ['description' => '请按检测规则格式录入', 'type' => 'string', 'required' => false, 'example' => '规则内容'],
],
],
'responses' => [
@@ -7720,81 +6286,38 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
'Data' => [
'description' => '无',
'type' => 'object',
'properties' => [
- 'CreatedAt' => [
- 'description' => '创建日期',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Name' => [
- 'description' => '名称',
- 'type' => 'string',
- 'example' => 'default',
- ],
- 'Content' => [
- 'description' => '检测规则内容',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'Id' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'CreatedAt' => ['description' => '创建日期', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Name' => ['description' => '名称', 'type' => 'string', 'example' => 'default'],
+ 'Content' => ['description' => '检测规则内容', 'type' => 'string', 'example' => '{}'],
+ 'Id' => ['description' => 'ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
],
- 'Code' => [
- 'description' => '返回码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Code' => ['description' => '返回码', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Data\\": {\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Name\\": \\"default\\",\\n \\"Content\\": \\"{}\\",\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<Message>-</Message>\\n<RequestId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</RequestId>\\n<Data>\\n <Content>{}</Content>\\n <CreatedAt>2020-07-14T14:01:41.000+08:00</CreatedAt>\\n <Id>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</Id>\\n <Name>default</Name>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
@@ -7803,15 +6326,27 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'idrsservice:UpdateRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'UpdateUser' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7819,60 +6354,32 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'Email',
'in' => 'query',
- 'schema' => [
- 'description' => '邮箱',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx@xxx.com',
- ],
+ 'schema' => ['description' => '邮箱', 'type' => 'string', 'required' => false, 'example' => 'xxx@xxx.com'],
],
[
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '姓名',
- 'type' => 'string',
- 'required' => false,
- 'example' => '用户姓名',
- ],
+ 'schema' => ['description' => '姓名', 'type' => 'string', 'required' => false, 'example' => '用户姓名'],
],
[
'name' => 'PhoneNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '手机号',
- 'type' => 'string',
- 'required' => false,
- 'example' => '手机号',
- ],
+ 'schema' => ['description' => '手机号', 'type' => 'string', 'required' => false, 'example' => '手机号'],
],
[
'name' => 'Role',
'in' => 'query',
- 'schema' => [
- 'description' => '角色',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'user',
- ],
+ 'schema' => ['description' => '角色', 'type' => 'string', 'required' => false, 'example' => 'user'],
],
[
'name' => 'Id',
'in' => 'query',
- 'schema' => [
- 'description' => '用户 ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'schema' => ['description' => '用户 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
],
'responses' => [
@@ -7881,75 +6388,56 @@
'description' => '无',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '84118BF0-56F7-54D2-8C1A-35BBBBD5016B',
- ],
- 'Data' => [
- 'description' => '数据',
- 'type' => 'object',
- 'example' => '{\'Id\': \'5073e5f4-99c6-4bb1-bd6c-30ab12f11059\', \'CreatedAt\': \'2021-12-29T11:31:53.072+08:00\'}',
- ],
- 'Code' => [
- 'description' => '返回码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '84118BF0-56F7-54D2-8C1A-35BBBBD5016B'],
+ 'Data' => ['description' => '数据', 'type' => 'object', 'example' => '{\'Id\': \'5073e5f4-99c6-4bb1-bd6c-30ab12f11059\', \'CreatedAt\': \'2021-12-29T11:31:53.072+08:00\'}'],
+ 'Code' => ['description' => '返回码', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"84118BF0-56F7-54D2-8C1A-35BBBBD5016B\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]',
'title' => '更新用户',
'summary' => '调用UpdateUser更新用户。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'idrsservice:UpdateUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'UpdateWatermark' => [
'summary' => '更新水印信息',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7957,39 +6445,22 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'WatermarkId',
'in' => 'query',
- 'schema' => [
- 'description' => '水印 ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'd4ba1e0428a8df069316060cef41948a',
- ],
+ 'schema' => ['description' => '水印 ID', 'type' => 'string', 'required' => false, 'example' => 'd4ba1e0428a8df069316060cef41948a'],
],
[
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '水印名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '名称',
- ],
+ 'schema' => ['description' => '水印名称', 'type' => 'string', 'required' => false, 'example' => '名称'],
],
[
'name' => 'Value',
'in' => 'query',
- 'schema' => [
- 'description' => '水印配置',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
+ 'schema' => ['description' => '水印配置', 'type' => 'string', 'required' => false, 'example' => '{}'],
],
],
'responses' => [
@@ -7999,67 +6470,22 @@
'description' => 'ApiResult<WatermarkDTO>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'requestId',
- 'description' => 'requestId',
- 'type' => 'string',
- 'example' => '84118BF0-56F7-54D2-8C1A-35BBBBD5016B',
- ],
- 'Code' => [
- 'title' => 'code',
- 'description' => 'code',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'title' => '提示',
- 'description' => '提示',
- 'type' => 'string',
- 'example' => '-',
- ],
+ 'RequestId' => ['title' => 'requestId', 'description' => 'requestId', 'type' => 'string', 'example' => '84118BF0-56F7-54D2-8C1A-35BBBBD5016B'],
+ 'Code' => ['title' => 'code', 'description' => 'code', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['title' => '提示', 'description' => '提示', 'type' => 'string', 'example' => '-'],
'Data' => [
'title' => '数据',
'description' => '数据',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '水印id',
- 'description' => '水印 ID',
- 'type' => 'string',
- 'example' => 'f3bd31c0-0001-4b4b-977d-7cfa64b585f5',
- ],
- 'CreatedAt' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Value' => [
- 'title' => '水印信息',
- 'description' => '水印信息',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'Name' => [
- 'title' => '水印名称',
- 'description' => '水印名称',
- 'type' => 'string',
- 'example' => '名称',
- ],
+ 'Id' => ['title' => '水印id', 'description' => '水印 ID', 'type' => 'string', 'example' => 'f3bd31c0-0001-4b4b-977d-7cfa64b585f5'],
+ 'CreatedAt' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Value' => ['title' => '水印信息', 'description' => '水印信息', 'type' => 'string', 'example' => '{}'],
+ 'Name' => ['title' => '水印名称', 'description' => '水印名称', 'type' => 'string', 'example' => '名称'],
],
],
- 'Success' => [
- 'title' => '给 pop 使用的',
- 'description' => '给 pop 使用的',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'HttpCode' => [
- 'description' => 'HTTP 状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Success' => ['title' => '给 pop 使用的', 'description' => '给 pop 使用的', 'type' => 'boolean', 'example' => 'True'],
+ 'HttpCode' => ['description' => 'HTTP 状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Errors' => [
'title' => '错误列表',
'description' => '错误列表',
@@ -8068,16 +6494,8 @@
'description' => '-',
'type' => 'object',
'properties' => [
- 'Field' => [
- 'description' => '错误 ID',
- 'type' => 'string',
- 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942',
- ],
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '-',
- ],
+ 'Field' => ['description' => '错误 ID', 'type' => 'string', 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942'],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '-'],
],
],
],
@@ -8087,48 +6505,47 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"84118BF0-56F7-54D2-8C1A-35BBBBD5016B\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"-\\",\\n \\"Data\\": {\\n \\"Id\\": \\"f3bd31c0-0001-4b4b-977d-7cfa64b585f5\\",\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Value\\": \\"{}\\",\\n \\"Name\\": \\"名称\\"\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200,\\n \\"Errors\\": [\\n {\\n \\"Field\\": \\"A1899517-BB99-5D3E-A71B-97524DCB0942\\",\\n \\"Message\\": \\"-\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '更新水印信息',
+ 'changeSet' => [
+ ['createdAt' => '2022-01-04T11:03:19.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'idrsservice:UpdateWatermark',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'UploadReport' => [
'summary' => '上报双录RTC信息',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -8136,192 +6553,98 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- ],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'DepartmentId',
'in' => 'query',
- 'schema' => [
- 'description' => '部门 ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
+ 'schema' => ['description' => '部门 ID', 'type' => 'string', 'required' => false, 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38'],
],
[
'name' => 'UserId',
'in' => 'query',
- 'schema' => [
- 'description' => '用户 ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => ' 59b0bbfe-929b-4a8c-9833-3ce70b4bad34',
- ],
+ 'schema' => ['description' => '用户 ID', 'type' => 'string', 'required' => false, 'example' => ' 59b0bbfe-929b-4a8c-9833-3ce70b4bad34'],
],
[
'name' => 'AppId',
'in' => 'query',
- 'schema' => [
- 'description' => '应用 ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '90c2459a-4c73-4ab7-8a6b-e550d62fbd8c',
- ],
+ 'schema' => ['description' => '应用 ID', 'type' => 'string', 'required' => false, 'example' => '90c2459a-4c73-4ab7-8a6b-e550d62fbd8c'],
],
[
'name' => 'DetectProcessId',
'in' => 'query',
- 'schema' => [
- 'description' => '业务流程 ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'iuhptk3w-2021122017',
- ],
+ 'schema' => ['description' => '业务流程 ID', 'type' => 'string', 'required' => false, 'example' => 'iuhptk3w-2021122017'],
],
[
'name' => 'RoomId',
'in' => 'query',
- 'schema' => [
- 'description' => 'mrtc 房间 ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '6000028888875',
- ],
+ 'schema' => ['description' => 'mrtc 房间 ID', 'type' => 'string', 'required' => false, 'example' => '6000028888875'],
],
[
'name' => 'VideoUrl',
'in' => 'query',
- 'schema' => [
- 'description' => '要上传的视频地址',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://mogo-apps-sh.oss-cn-shanghai-internal.aliyuncs.com/tmp/d2720028b53d384c6d3fca32e45209d1_20_src.mp4',
- ],
+ 'schema' => ['description' => '要上传的视频地址', 'type' => 'string', 'required' => false, 'example' => 'https://mogo-apps-sh.oss-cn-shanghai-internal.aliyuncs.com/tmp/d2720028b53d384c6d3fca32e45209d1_20_src.mp4'],
],
[
'name' => 'MetaUrl',
'in' => 'query',
- 'schema' => [
- 'description' => 'meta 文件地址',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://abc.oss.aliyuncs.com/1/12_03_20_03_36toubaoren.mp4.meta',
- ],
+ 'schema' => ['description' => 'meta 文件地址', 'type' => 'string', 'required' => false, 'example' => 'http://abc.oss.aliyuncs.com/1/12_03_20_03_36toubaoren.mp4.meta'],
],
[
'name' => 'ResultUrl',
'in' => 'query',
- 'schema' => [
- 'description' => '检测流程的完整 URL',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://abc.oss.aliyuncs.com/1/12_03_20_03_36toubaoren.mp4.json',
- ],
+ 'schema' => ['description' => '检测流程的完整 URL', 'type' => 'string', 'required' => false, 'example' => 'http://abc.oss.aliyuncs.com/1/12_03_20_03_36toubaoren.mp4.json'],
],
[
'name' => 'RecordAt',
'in' => 'query',
- 'schema' => [
- 'title' => 'yyyy-MM-dd hh:mm:ss',
- 'description' => '录制开始时间,格式 yyyy-MM-dd\'T\'HH:mm:ss\'Z\'',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2022-01-04T08%3A45%3A37Z',
- ],
+ 'schema' => ['title' => 'yyyy-MM-dd hh:mm:ss', 'description' => '录制开始时间,格式 yyyy-MM-dd\'T\'HH:mm:ss\'Z\'', 'type' => 'string', 'required' => false, 'example' => '2022-01-04T08%3A45%3A37Z'],
],
[
'name' => 'Duration',
'in' => 'query',
- 'schema' => [
- 'description' => '视频时长',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12',
- ],
+ 'schema' => ['description' => '视频时长', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12'],
],
[
'name' => 'Type',
'in' => 'query',
- 'schema' => [
- 'description' => '标识本地双录和远程双录(LOCAL 或 REMOTE)'."\n"
- ."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'LOCAL',
- ],
+ 'schema' => ['description' => '标识本地双录和远程双录(LOCAL 或 REMOTE)'."\n"
+ ."\n", 'type' => 'string', 'required' => false, 'example' => 'LOCAL'],
],
[
'name' => 'ClientVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '客户端版本号',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1.0.003',
- ],
+ 'schema' => ['description' => '客户端版本号', 'type' => 'string', 'required' => false, 'example' => '1.0.003'],
],
[
'name' => 'FeeId',
'in' => 'query',
- 'schema' => [
- 'description' => '对账 ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '6c94f2a7-632d-4ea0-aa06-a97800a9060f',
- ],
+ 'schema' => ['description' => '对账 ID', 'type' => 'string', 'required' => false, 'example' => '6c94f2a7-632d-4ea0-aa06-a97800a9060f'],
],
[
'name' => 'ClientBaseParam',
'in' => 'query',
- 'schema' => [
- 'description' => '客户端基础参数,记录 SDK 版本号等信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"version":"1.0.0"}',
- ],
+ 'schema' => ['description' => '客户端基础参数,记录 SDK 版本号等信息', 'type' => 'string', 'required' => false, 'example' => '{"version":"1.0.0"}'],
],
[
'name' => 'RtcRecordId',
'in' => 'query',
- 'schema' => [
- 'description' => 'mrtc录制ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'record_6570315480571566****',
- ],
+ 'schema' => ['description' => 'mrtc录制ID', 'type' => 'string', 'required' => false, 'example' => 'record_6570315480571566****'],
],
[
'name' => 'OuterBusinessId',
'in' => 'query',
- 'schema' => [
- 'description' => '业务ID,用户自定义',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ads32efef43',
- ],
+ 'schema' => ['description' => '业务ID,用户自定义', 'type' => 'string', 'required' => false, 'example' => 'ads32efef43'],
],
[
'name' => 'Role',
'in' => 'query',
- 'schema' => [
- 'description' => '用户自定义角色',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['description' => '用户自定义角色', 'type' => 'string', 'required' => false, 'example' => '0'],
],
[
'name' => 'VideoType',
'in' => 'query',
- 'schema' => [
- 'description' => '标识单流还是混流',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'MIX',
- ],
+ 'schema' => ['description' => '标识单流还是混流', 'type' => 'string', 'required' => false, 'example' => 'MIX'],
],
],
'responses' => [
@@ -8331,96 +6654,27 @@
'description' => 'ApiResult<RecordDTO>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'requestId',
- 'description' => 'requestId',
- 'type' => 'string',
- 'example' => '84118BF0-56F7-54D2-8C1A-35BBBB*****',
- ],
- 'Code' => [
- 'title' => 'code',
- 'description' => 'code',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'title' => '提示',
- 'description' => '提示',
- 'type' => 'string',
- 'example' => '无',
- ],
+ 'RequestId' => ['title' => 'requestId', 'description' => 'requestId', 'type' => 'string', 'example' => '84118BF0-56F7-54D2-8C1A-35BBBB*****'],
+ 'Code' => ['title' => 'code', 'description' => 'code', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['title' => '提示', 'description' => '提示', 'type' => 'string', 'example' => '无'],
'Data' => [
'title' => '数据',
'description' => '数据',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '双录记录id',
- 'description' => '双录记录 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce7****',
- ],
- 'CreatedAt' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'VideoUrl' => [
- 'title' => '视频地址',
- 'description' => '视频地址',
- 'type' => 'string',
- 'example' => 'http://oss.aliyuncs.com/1.mp4',
- ],
- 'MetaUrl' => [
- 'title' => 'meta地址',
- 'description' => 'meta 地址',
- 'type' => 'string',
- 'example' => 'http://oss.aliyuncs.com/1.mp4.meta',
- ],
- 'ResultUrl' => [
- 'title' => '结果地址',
- 'description' => '结果地址',
- 'type' => 'string',
- 'example' => 'http://oss.aliyuncs.com/1.mp4.json',
- ],
- 'RecordAt' => [
- 'title' => '录制时间',
- 'description' => '录制时间',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Duration' => [
- 'title' => '时长',
- 'description' => '时长',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12',
- ],
- 'RtcRecordId' => [
- 'description' => 'mrtc录制ID',
- 'type' => 'string',
- 'example' => 'record_6570315480571566****'."\n",
- ],
- 'OuterBusinessId' => [
- 'description' => '业务ID,用户自定义',
- 'type' => 'string',
- 'example' => 'ads32efef43',
- ],
+ 'Id' => ['title' => '双录记录id', 'description' => '双录记录 ID', 'type' => 'string', 'example' => '59b0bbfe-929b-4a8c-9833-3ce7****'],
+ 'CreatedAt' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'VideoUrl' => ['title' => '视频地址', 'description' => '视频地址', 'type' => 'string', 'example' => 'http://oss.aliyuncs.com/1.mp4'],
+ 'MetaUrl' => ['title' => 'meta地址', 'description' => 'meta 地址', 'type' => 'string', 'example' => 'http://oss.aliyuncs.com/1.mp4.meta'],
+ 'ResultUrl' => ['title' => '结果地址', 'description' => '结果地址', 'type' => 'string', 'example' => 'http://oss.aliyuncs.com/1.mp4.json'],
+ 'RecordAt' => ['title' => '录制时间', 'description' => '录制时间', 'type' => 'string', 'example' => '2020-07-14T14:01:41.000+08:00'],
+ 'Duration' => ['title' => '时长', 'description' => '时长', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
+ 'RtcRecordId' => ['description' => 'mrtc录制ID', 'type' => 'string', 'example' => 'record_6570315480571566****'."\n"],
+ 'OuterBusinessId' => ['description' => '业务ID,用户自定义', 'type' => 'string', 'example' => 'ads32efef43'],
],
],
- 'Success' => [
- 'title' => '给 pop 使用的',
- 'description' => '给 pop 使用的',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'HttpCode' => [
- 'description' => 'HTTP 状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Success' => ['title' => '给 pop 使用的', 'description' => '给 pop 使用的', 'type' => 'boolean', 'example' => 'True'],
+ 'HttpCode' => ['description' => 'HTTP 状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Errors' => [
'title' => '错误列表',
'description' => '错误列表',
@@ -8429,16 +6683,8 @@
'description' => '错误列表',
'type' => 'object',
'properties' => [
- 'Field' => [
- 'description' => '错误 ID',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '无',
- ],
+ 'Field' => ['description' => '错误 ID', 'type' => 'string', 'example' => '无'],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '无'],
],
],
],
@@ -8448,3102 +6694,1187 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
+ ['errorCode' => 'InvalidRequest', 'errorMessage' => 'The request is invalid.', 'description' => '无效的请求'],
],
[
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
+ ['errorCode' => 'Unauthorized', 'errorMessage' => 'The request requires user authentication.', 'description' => '该请求需要进行身份认证'],
],
403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
+ ['errorCode' => 'Forbidden', 'errorMessage' => 'Access to this resource on the server is denied.', 'description' => '没有权限访问该资源'],
],
[
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource does not exist.', 'description' => '找不到指定的资源'],
],
500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
+ ['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal server error occurred.', 'description' => '服务器内部出错'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"84118BF0-56F7-54D2-8C1A-35BBBB*****\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce7****\\",\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"VideoUrl\\": \\"http://oss.aliyuncs.com/1.mp4\\",\\n \\"MetaUrl\\": \\"http://oss.aliyuncs.com/1.mp4.meta\\",\\n \\"ResultUrl\\": \\"http://oss.aliyuncs.com/1.mp4.json\\",\\n \\"RecordAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Duration\\": 12,\\n \\"RtcRecordId\\": \\"record_6570315480571566****\\\\n\\",\\n \\"OuterBusinessId\\": \\"ads32efef43\\"\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200,\\n \\"Errors\\": [\\n {\\n \\"Field\\": \\"无\\",\\n \\"Message\\": \\"无\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<UploadReportResponse>\\n <RequestId>84118BF0-56F7-54D2-8C1A-35BBBB*****</RequestId>\\n <Code>OK</Code>\\n <Message>无</Message>\\n <Data>\\n <Id>59b0bbfe-929b-4a8c-9833-3ce7****</Id>\\n <CreatedAt>2020-07-14T14:01:41.000+08:00</CreatedAt>\\n <VideoUrl>http://oss.aliyuncs.com/1.mp4</VideoUrl>\\n <MetaUrl>http://oss.aliyuncs.com/1.mp4.meta</MetaUrl>\\n <ResultUrl>http://oss.aliyuncs.com/1.mp4.json</ResultUrl>\\n <RecordAt>2020-07-14T14:01:41.000+08:00</RecordAt>\\n <Duration>12</Duration>\\n <RtcRecordId>record_6570315480571566****\\n</RtcRecordId>\\n <OuterBusinessId>ads32efef43</OuterBusinessId>\\n </Data>\\n <Success>true</Success>\\n <HttpCode>200</HttpCode>\\n <Errors>\\n <Field>无</Field>\\n <Message>无</Message>\\n </Errors>\\n</UploadReportResponse>","errorExample":""}]',
'title' => '上报双录结果',
- ],
- 'GetRecordsByFeeId' => [
- 'summary' => '根据feeid查询上报结果信息接口',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
- [
- 'name' => 'FeeId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '对账 ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '6c94f2a7-632d-4ea0-aa06-a97800a9060f',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'ApiResult<List<Record>>',
- 'description' => 'ApiResult<List<Record>>',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'requestId',
- 'description' => 'requestId',
- 'type' => 'string',
- 'example' => '0B576AAB-A638-5029-9A54-A7C1DB5AC0B3',
- ],
- 'Code' => [
- 'title' => 'code',
- 'description' => 'code',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'title' => '提示',
- 'description' => '提示',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'Data' => [
- 'title' => '数据',
- 'description' => '数据',
- 'type' => 'array',
- 'items' => [
- 'description' => '数据',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'title' => '双录记录id',
- 'description' => '双录记录id',
- 'type' => 'string',
- 'example' => '63bb629d-92bf-4cdc-ad0b-3032c926d23f',
- ],
- 'CreatedAt' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'DetectProcessName' => [
- 'title' => '业务检测流程名',
- 'description' => '业务检测流程名',
- 'type' => 'string',
- 'example' => 'XX流程',
- ],
- 'DepartmentName' => [
- 'title' => '部门名',
- 'description' => '部门名',
- 'type' => 'string',
- 'example' => '部门',
- ],
- 'AppName' => [
- 'title' => '应用名',
- 'description' => '应用名',
- 'type' => 'string',
- 'example' => 'XX应用',
- ],
- 'VideoUrl' => [
- 'title' => '视频地址',
- 'description' => '视频地址',
- 'type' => 'string',
- 'example' => 'http://oss.aliyuncs.com/1.mp4',
- ],
- 'MetaUrl' => [
- 'title' => 'meta地址',
- 'description' => 'meta地址',
- 'type' => 'string',
- 'example' => 'http://oss.aliyuncs.com/1.mp4.meta',
- ],
- 'ResultUrl' => [
- 'title' => '结果地址',
- 'description' => '结果地址',
- 'type' => 'string',
- 'example' => 'http://oss.aliyuncs.com/1.mp4.json',
- ],
- 'RecordAt' => [
- 'title' => '录制时间',
- 'description' => '录制时间',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Duration' => [
- 'title' => '时长',
- 'description' => '时长',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '22',
- ],
- 'Status' => [
- 'title' => '检测状态',
- 'description' => '检测状态',
- 'type' => 'string',
- 'example' => 'completed',
- ],
- 'RoomId' => [
- 'title' => 'mrtc房间id',
- 'description' => 'mrtc房间id',
- 'type' => 'string',
- 'example' => '654078150345590',
- ],
- 'RecordRoomList' => [
- 'title' => '远程双录文件地址列表',
- 'description' => '远程双录文件地址列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '远程双录文件地址列表',
- 'type' => 'object',
- 'properties' => [
- 'Role' => [
- 'title' => '角色',
- 'description' => '角色',
- 'type' => 'string',
- 'example' => '21343',
- ],
- 'RecordType' => [
- 'title' => '录制视频类型',
- 'description' => '录制视频类型',
- 'type' => 'string',
- 'example' => 'Mix',
- ],
- 'RoomVideoUrl' => [
- 'title' => '视频地址',
- 'description' => '视频地址',
- 'type' => 'string',
- 'example' => 'http://oss.aliyuncs.com/1.mp4',
- ],
- 'RoomMetaUrl' => [
- 'title' => 'meta地址',
- 'description' => 'meta地址',
- 'type' => 'string',
- 'example' => 'http://oss.aliyuncs.com/1.mp4.meta',
- ],
- 'RoomResultUrl' => [
- 'title' => '结果地址',
- 'description' => '结果地址',
- 'type' => 'string',
- 'example' => 'http://oss.aliyuncs.com/1.mp4.json',
- ],
- 'RoomRecordAt' => [
- 'title' => '录制时间',
- 'description' => '录制时间',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'RoomStatus' => [
- 'title' => '检测状态',
- 'description' => '检测状态',
- 'type' => 'string',
- 'example' => 'runnable',
- ],
- 'RtcRecordId' => [
- 'description' => 'mrtc录制ID',
- 'type' => 'string',
- 'example' => 'record_65703154805715668342',
- ],
- 'OuterBusinessId' => [
- 'description' => '业务ID,用户自定义',
- 'type' => 'string',
- 'example' => 'ads32efef43',
- ],
- ],
- ],
- ],
- 'OuterBusinessId' => [
- 'description' => '业务ID,用户自定义',
- 'type' => 'string',
- 'example' => 'ads32efef43',
- ],
- ],
- ],
- ],
- 'Success' => [
- 'title' => '给 pop 使用的',
- 'description' => '给 pop 使用的',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'HttpCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Errors' => [
- 'title' => '错误列表',
- 'description' => '错误列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '错误列表',
- 'type' => 'object',
- 'properties' => [
- 'Field' => [
- 'description' => '错误 ID',
- 'type' => 'string',
- 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0942',
- ],
- 'Message' => [
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '-',
- ],
- ],
- ],
- ],
+ 'changeSet' => [
+ ['createdAt' => '2023-05-23T11:48:52.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-08-29T07:30:50.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2022-07-05T11:05:58.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2022-02-21T07:17:01.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-01-24T04:47:39.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-01-09T16:48:09.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-01-04T07:08:00.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'idrsservice:UploadReport',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
- ],
- [
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
- ],
- [
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
- ],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0B576AAB-A638-5029-9A54-A7C1DB5AC0B3\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"-\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"63bb629d-92bf-4cdc-ad0b-3032c926d23f\\",\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"DetectProcessName\\": \\"XX流程\\",\\n \\"DepartmentName\\": \\"部门\\",\\n \\"AppName\\": \\"XX应用\\",\\n \\"VideoUrl\\": \\"http://oss.aliyuncs.com/1.mp4\\",\\n \\"MetaUrl\\": \\"http://oss.aliyuncs.com/1.mp4.meta\\",\\n \\"ResultUrl\\": \\"http://oss.aliyuncs.com/1.mp4.json\\",\\n \\"RecordAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Duration\\": 22,\\n \\"Status\\": \\"completed\\",\\n \\"RoomId\\": \\"654078150345590\\",\\n \\"RecordRoomList\\": [\\n {\\n \\"Role\\": \\"21343\\",\\n \\"RecordType\\": \\"Mix\\",\\n \\"RoomVideoUrl\\": \\"http://oss.aliyuncs.com/1.mp4\\",\\n \\"RoomMetaUrl\\": \\"http://oss.aliyuncs.com/1.mp4.meta\\",\\n \\"RoomResultUrl\\": \\"http://oss.aliyuncs.com/1.mp4.json\\",\\n \\"RoomRecordAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"RoomStatus\\": \\"runnable\\",\\n \\"RtcRecordId\\": \\"record_65703154805715668342\\",\\n \\"OuterBusinessId\\": \\"ads32efef43\\"\\n }\\n ],\\n \\"OuterBusinessId\\": \\"ads32efef43\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"HttpCode\\": 200,\\n \\"Errors\\": [\\n {\\n \\"Field\\": \\"A1899517-BB99-5D3E-A71B-97524DCB0942\\",\\n \\"Message\\": \\"-\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '根据feeid获取上报记录',
],
- 'GetStatisticsRecordsByFeeId' => [
- 'summary' => '根据feeid查询上报计量信息接口',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
- [
- 'name' => 'FeeId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '对账 ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ab7ce59f-a68a-4a6f-82a6-6460fadc9a70',
- ],
- ],
+ ],
+ 'endpoints' => [
+ ['regionId' => 'ap-northeast-1', 'regionName' => '日本(东京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'idrsservice.aliyuncs.com', 'endpoint' => 'idrsservice.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'idrsservice.aliyuncs.com', 'endpoint' => 'idrsservice.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-2', 'regionName' => '澳大利亚(悉尼)已关停', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'idrsservice.aliyuncs.com', 'endpoint' => 'idrsservice.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚(吉隆坡)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'idrsservice.aliyuncs.com', 'endpoint' => 'idrsservice.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚(雅加达)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'idrsservice.aliyuncs.com', 'endpoint' => 'idrsservice.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-beijing', 'regionName' => '华北2(北京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'idrsservice.aliyuncs.com', 'endpoint' => 'idrsservice.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-chengdu', 'regionName' => '西南1(成都)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'idrsservice.aliyuncs.com', 'endpoint' => 'idrsservice.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hangzhou', 'regionName' => '华东1(杭州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'idrsservice.cn-hangzhou.aliyuncs.com', 'endpoint' => 'idrsservice.cn-hangzhou.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'idrsservice.aliyuncs.com', 'endpoint' => 'idrsservice.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-huhehaote', 'regionName' => '华北5(呼和浩特)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'idrsservice.aliyuncs.com', 'endpoint' => 'idrsservice.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-qingdao', 'regionName' => '华北1(青岛)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'idrsservice.aliyuncs.com', 'endpoint' => 'idrsservice.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shanghai', 'regionName' => '华东2(上海)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'idrsservice.aliyuncs.com', 'endpoint' => 'idrsservice.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shenzhen', 'regionName' => '华南1(深圳)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'idrsservice.aliyuncs.com', 'endpoint' => 'idrsservice.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-wulanchabu', 'regionName' => '华北6(乌兰察布)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'idrsservice.aliyuncs.com', 'endpoint' => 'idrsservice.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3(张家口)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'idrsservice.aliyuncs.com', 'endpoint' => 'idrsservice.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'us-west-1', 'regionName' => '美国(硅谷)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'idrsservice.aliyuncs.com', 'endpoint' => 'idrsservice.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'us-east-1', 'regionName' => '美国(弗吉尼亚)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'idrsservice.aliyuncs.com', 'endpoint' => 'idrsservice.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'eu-west-1', 'regionName' => '英国(伦敦)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'idrsservice.aliyuncs.com', 'endpoint' => 'idrsservice.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'eu-central-1', 'regionName' => '德国(法兰克福)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'idrsservice.aliyuncs.com', 'endpoint' => 'idrsservice.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'me-east-1', 'regionName' => '阿联酋(迪拜)', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'idrsservice.aliyuncs.com', 'endpoint' => 'idrsservice.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-south-1', 'regionName' => '印度(孟买)已关停', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'idrsservice.aliyuncs.com', 'endpoint' => 'idrsservice.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => '华南1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'idrsservice.aliyuncs.com', 'endpoint' => 'idrsservice.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'idrsservice.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'idrsservice.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'idrsservice-vpc.cn-shanghai-finance-1.aliyuncs.com'],
+ ['regionId' => 'cn-north-2-gov-1', 'regionName' => '北京政务云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'idrsservice.aliyuncs.com', 'endpoint' => 'idrsservice.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hangzhou-finance', 'regionName' => '华东1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'idrsservice.aliyuncs.com', 'endpoint' => 'idrsservice.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-beijing-finance-1', 'regionName' => '华北2 金融云(邀测)', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'idrsservice.aliyuncs.com', 'endpoint' => 'idrsservice.aliyuncs.com', 'vpc' => ''],
+ ],
+ 'errorCodes' => [
+ ['code' => 'Forbidden', 'message' => 'Access to this resource on the server is denied.', 'http_code' => 403, 'description' => '没有权限访问该资源'],
+ ['code' => 'InternalServerError', 'message' => 'An internal server error occurred.', 'http_code' => 500, 'description' => '服务器内部出错'],
+ ['code' => 'InvalidRequest', 'message' => 'The request is invalid.', 'http_code' => 400, 'description' => '无效的请求'],
+ ['code' => 'ResourceNotFound', 'message' => 'The specified resource does not exist.', 'http_code' => 404, 'description' => '找不到指定的资源'],
+ ['code' => 'Unauthorized', 'message' => 'The request requires user authentication.', 'http_code' => 401, 'description' => '该请求需要进行身份认证'],
+ ],
+ 'changeSet' => [
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'UploadReport'],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'ApiResult<List<StatisticsRecord>>',
- 'description' => 'ApiResult<List<StatisticsRecord>>',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'requestId',
- 'description' => 'requestId',
- 'type' => 'string',
- 'example' => 'CAD43A24-D34C-5848-BEB0-3D184F6687B1',
- ],
- 'Code' => [
- 'title' => 'code',
- 'description' => 'code',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'title' => '提示',
- 'description' => '提示',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'Data' => [
- 'title' => '数据',
- 'description' => '数据',
- 'type' => 'array',
- 'items' => [
- 'description' => '数据',
- 'type' => 'object',
- 'properties' => [
- 'DeviceId' => [
- 'description' => '设备id',
- 'type' => 'string',
- 'example' => '7f3dfb9aa0dd0261',
- ],
- 'TenantId' => [
- 'description' => '租户id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'AppId' => [
- 'description' => 'appid',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12',
- ],
- 'DepartmentId' => [
- 'description' => '部门id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12',
- ],
- 'DeviceType' => [
- 'description' => '终端设备类型,0:Android,1:iOS',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'CreatedAt' => [
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'UpdatedAt' => [
- 'description' => '更新时间',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'BeginAt' => [
- 'description' => '开始检测时间,时间格式yyyy-MM-dd HH:mm:ss',
- 'type' => 'string',
- 'example' => '2022-05-23 10:33:12',
- ],
- 'EndAt' => [
- 'description' => '结束检测时间,时间格式yyyy-MM-dd HH:mm:ss',
- 'type' => 'string',
- 'example' => '2022-03-24 11:39:46',
- ],
- 'Hour' => [
- 'title' => '2020050811',
- 'description' => '时间段',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2020050811',
- ],
- 'DetectionDuration' => [
- 'title' => '检测时长,s',
- 'description' => '检测时长,s',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1200',
- ],
- 'ChargeDuration' => [
- 'title' => '计费时长,min',
- 'description' => '计费时长,min',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '12',
- ],
- 'Type' => [
- 'description' => '类型:remote(远程双录),local(本地双录)',
- 'type' => 'string',
- 'example' => 'REMOTE',
- ],
- 'FeeId' => [
- 'description' => '对账 ID',
- 'type' => 'string',
- 'example' => 'ff1d7783-e087-4d62-92df-3a163eca7c07',
- ],
- ],
- ],
- ],
- 'Success' => [
- 'title' => '给 pop 使用的',
- 'description' => '给 pop 使用的',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'HttpCode' => [
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Errors' => [
- 'title' => '错误列表',
- 'description' => '错误列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '无',
- 'type' => 'object',
- 'properties' => [
- 'Field' => [
- 'description' => '错误 ID',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'Message' => [
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '-',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'createdAt' => '2023-05-23T11:49:04.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateTtsQuestion'],
+ ['description' => '响应参数发生变更', 'api' => 'GetRecordResult'],
+ ['description' => '响应参数发生变更', 'api' => 'GetRecordsByFeeId'],
+ ['description' => 'OpenAPI 下线', 'api' => 'GetRecordsByOuterBusinessId'],
+ ['description' => 'OpenAPI 下线', 'api' => 'GetTtsQuestionByGroupId'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListRecordResults'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'UploadReport'],
+ ],
+ 'createdAt' => '2022-08-29T07:31:15.000Z',
+ 'description' => '新增字段',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'TtsTask'],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
- ],
- [
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
- ],
- [
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
- ],
+ 'createdAt' => '2022-08-29T02:57:34.000Z',
+ 'description' => '发布单向视频双录API到线上',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'AsrTask'],
+ ['description' => 'OpenAPI 下线', 'api' => 'CreateTtsQuestion'],
+ ['description' => 'OpenAPI 下线', 'api' => 'CreateTtsQuestionGroup'],
+ ['description' => 'OpenAPI 下线', 'api' => 'FaceLiveness'],
+ ['description' => 'OpenAPI 下线', 'api' => 'FaceRecognize'],
+ ['description' => 'OpenAPI 下线', 'api' => 'GetAsrResult'],
+ ['description' => 'OpenAPI 下线', 'api' => 'JoinRoom'],
+ ['description' => 'OpenAPI 下线', 'api' => 'LeaveRoom'],
+ ['description' => 'OpenAPI 下线', 'api' => 'TtsTask'],
+ ],
+ 'createdAt' => '2022-08-26T03:42:12.000Z',
+ 'description' => '单向视频录制API',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'AsrRealtime'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CAD43A24-D34C-5848-BEB0-3D184F6687B1\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"-\\",\\n \\"Data\\": [\\n {\\n \\"DeviceId\\": \\"7f3dfb9aa0dd0261\\",\\n \\"TenantId\\": 1,\\n \\"AppId\\": 12,\\n \\"DepartmentId\\": 12,\\n \\"DeviceType\\": 0,\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"UpdatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"BeginAt\\": \\"2022-05-23 10:33:12\\",\\n \\"EndAt\\": \\"2022-03-24 11:39:46\\",\\n \\"Hour\\": 2020050811,\\n \\"DetectionDuration\\": 1200,\\n \\"ChargeDuration\\": 12,\\n \\"Type\\": \\"REMOTE\\",\\n \\"FeeId\\": \\"ff1d7783-e087-4d62-92df-3a163eca7c07\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"HttpCode\\": 200,\\n \\"Errors\\": [\\n {\\n \\"Field\\": \\"-\\",\\n \\"Message\\": \\"-\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '根据feeid获取计费信息',
+ 'createdAt' => '2022-07-08T02:50:57.000Z',
+ 'description' => '新增API',
],
- 'AsrSentence' => [
- 'summary' => '一句话识别',
- 'methods' => [
- 'post',
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'AsrSentence'],
+ ['description' => '请求参数发生变更', 'api' => 'FaceCompare'],
+ ['description' => '请求参数发生变更', 'api' => 'TtsCommon'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'createdAt' => '2022-07-08T02:21:26.000Z',
+ 'description' => '参数修改',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'AsrSentence'],
+ ['description' => '请求参数发生变更', 'api' => 'FaceCompare'],
+ ['description' => '请求参数发生变更', 'api' => 'TtsCommon'],
],
- 'security' => [
- [
- 'AK' => [],
- ],
+ 'createdAt' => '2022-07-08T02:04:31.000Z',
+ 'description' => '参数修改',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'AsrSentence'],
+ ['description' => '请求参数发生变更', 'api' => 'FaceCompare'],
+ ['description' => '请求参数发生变更', 'api' => 'TtsCommon'],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
+ 'createdAt' => '2022-07-07T13:28:15.000Z',
+ 'description' => '修改Content-Type',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'AsrSentence'],
+ ['description' => 'OpenAPI 下线', 'api' => 'FaceCompare'],
+ ['description' => 'OpenAPI 下线', 'api' => 'TtsCommon'],
],
- 'parameters' => [
- [
- 'name' => 'AsrRequest',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '任务请求参数',
- 'type' => 'object',
- 'properties' => [
- 'AppId' => [
- 'title' => '应用信息',
- 'description' => '应用 ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'd61be709-49d2-4cf1-b219-cd6181f72db8',
- ],
- 'FileUrl' => [
- 'title' => '语音文件地址',
- 'description' => '可访问的文件 URL',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://shuanglu-record-finance.oss-cn-shanghai.aliyuncs.com/record/4x5avhil/047730_30307_0/2022-02-12-10-20****',
- ],
- 'Format' => [
- 'title' => '音频编码格式',
- 'description' => '音频编码格式,默认值:PCM。'."\n"
- ."\n"
- .'支持格式:PCM编码、16bit采样位数、单声道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PCM',
- ],
- 'SampleRate' => [
- 'title' => '音频采样率',
- 'description' => '音频采样率,默认值:16000 Hz。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '16000',
- ],
- 'EnablePunctuationPrediction' => [
- 'title' => '是否在后处理中添加标点。取值:true、false。默认:false(不开启)。',
- 'description' => '是否在后处理中添加标点,默认值:False。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- 'default' => 'false',
- ],
- 'EnableInverseTextNormalization' => [
- 'title' => '是否在后处理中执行ITN。取值:true、false。默认:false(不开启)。',
- 'description' => '是否在后处理中执行ITN(逆文本规整,inverse text normalization)。设置为True时,中文数字将转为阿拉伯数字输出,默认值:False。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- 'default' => 'false',
- ],
- 'EnableVoiceDetection' => [
- 'title' => '是否在后处理中执行ITN。取值:true、false。默认:false(不开启)。',
- 'description' => '是否启动语音检测。默认值:False。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- 'default' => 'false',
- ],
- ],
- 'required' => false,
- ],
- ],
+ 'createdAt' => '2022-07-07T09:06:01.000Z',
+ 'description' => 'idrs-facade',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'GetRecordResult'],
+ ['description' => '响应参数发生变更', 'api' => 'ListRecordResults'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'UploadReport'],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'ApiResult<AsrResponseDTO>',
- 'description' => 'ApiResult<AsrResponseDTO>',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
- 'Code' => [
- 'description' => '返回码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'Data' => [
- 'description' => '数据',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'title' => '双录端处理asr任务ID',
- 'description' => '双录端处理asr任务ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
- 'TaskId' => [
- 'title' => '智能语音asr任务ID',
- 'description' => '智能语音asr任务ID',
- 'type' => 'string',
- 'example' => '368cfa55-2364-4d79-aeb4-c0956c4a45cd',
- ],
- 'Name' => [
- 'title' => '智能语音asr任务名称',
- 'description' => '智能语音asr任务名称',
- 'type' => 'string',
- 'example' => '任务1',
- ],
- 'Code' => [
- 'title' => '智能语音asr任务code',
- 'description' => '智能语音asr任务code',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20000000',
- ],
- 'Message' => [
- 'title' => '智能语音asr任务message',
- 'description' => '智能语音asr任务message',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'Result' => [
- 'title' => 'asr识别出的文本',
- 'description' => 'asr识别出的文本',
- 'type' => 'string',
- 'example' => '北京的天气',
- ],
- ],
- ],
- 'Success' => [
- 'title' => '给 pop 使用的',
- 'description' => '给 pop 使用的',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'HttpCode' => [
- 'description' => 'HTTP 状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- ],
- ],
- ],
+ 'createdAt' => '2022-07-05T11:06:29.000Z',
+ 'description' => '参数变更',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CreateVideoMergeTask'],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
- ],
- [
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
- ],
- [
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
- ],
+ 'createdAt' => '2022-06-14T09:13:24.000Z',
+ 'description' => '新增视频合成API',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateDetectProcess'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListDetectProcesses'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"-\\",\\n \\"Data\\": {\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"TaskId\\": \\"368cfa55-2364-4d79-aeb4-c0956c4a45cd\\",\\n \\"Name\\": \\"任务1\\",\\n \\"Code\\": 20000000,\\n \\"Message\\": \\"-\\",\\n \\"Result\\": \\"北京的天气\\"\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200\\n}","type":"json"}]',
- 'title' => '一句话识别',
+ 'createdAt' => '2022-06-01T12:11:54.000Z',
+ 'description' => '双录质检二期原有API优化',
],
- 'FaceCompare' => [
- 'summary' => '人脸对比',
- 'methods' => [
- 'post',
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateTaskGroup'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'createdAt' => '2022-05-13T03:10:28.000Z',
+ 'description' => '创建云端质检任务接口,参数改造',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'AssociateRoom'],
+ ['description' => '请求参数发生变更', 'api' => 'CreateSignature'],
+ ['description' => '请求参数发生变更', 'api' => 'CreateStatisticsRecord'],
+ ['description' => '请求参数发生变更', 'api' => 'GetDepartment'],
+ ['description' => '请求参数发生变更', 'api' => 'GetDetection'],
+ ['description' => '请求参数发生变更', 'api' => 'GetDetectProcess'],
+ ['description' => '请求参数发生变更', 'api' => 'GetDetectProcessJsonFile'],
+ ['description' => '请求参数发生变更', 'api' => 'GetPreSignedUrl'],
+ ['description' => '请求参数发生变更', 'api' => 'GetRecordResult'],
+ ],
+ 'createdAt' => '2022-02-21T07:18:40.000Z',
+ 'description' => '部门API新增入参clientBaseParam表示客户端的基础参数',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'AssociateRoom'],
+ ['description' => '请求参数发生变更', 'api' => 'CreateSignature'],
+ ['description' => '请求参数发生变更', 'api' => 'CreateStatisticsRecord'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'GetApp'],
+ ['description' => '请求参数发生变更', 'api' => 'GetPreSignedUrl'],
+ ['description' => '请求参数发生变更', 'api' => 'GetWatermark'],
+ ['description' => '请求参数发生变更', 'api' => 'UploadReport'],
+ ],
+ 'createdAt' => '2022-01-25T02:14:25.000Z',
+ 'description' => '增加客户端版本参数',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'GetApp'],
],
- 'security' => [
- [
- 'AK' => [],
- ],
+ 'createdAt' => '2022-01-14T07:35:50.000Z',
+ 'description' => '变更GetAPP出参',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'ListDetectProcesses'],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
+ 'createdAt' => '2022-01-13T10:01:08.000Z',
+ 'description' => '本地双录配置新增保存时间和发布时间',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'ListRecordResults'],
],
- 'parameters' => [
- [
- 'name' => 'FaceRequest',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '请求参数',
- 'type' => 'object',
- 'properties' => [
- 'AppId' => [
- 'title' => '应用信息',
- 'description' => '应用id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'd61be709-49d2-4cf1-b219-cd6181f72***',
- ],
- 'SourceImage' => [
- 'title' => '人脸照片 base64',
- 'description' => '照片Base64编码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/9j/4AAQSkZJRgABAQAASxxxxxxx',
- ],
- 'TargetImage' => [
- 'title' => '底库照片 base64',
- 'description' => '底库照片Base64编码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/9j/4AAQSkZJRgABAQAASxxxxxxx',
- ],
- ],
- 'required' => false,
- ],
- ],
+ 'createdAt' => '2022-01-12T07:55:58.000Z',
+ 'description' => '增加出参roomID',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'AssociateRoom'],
+ ['description' => '响应参数发生变更', 'api' => 'GetRecordResult'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListFiles'],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'ApiResult<FaceResponseDTO>',
- 'description' => 'ApiResult<FaceResponseDTO>',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4ba***',
- ],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'Data' => [
- 'description' => '数据',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
- 'RequestId' => [
- 'description' => '请求 ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4bad38',
- ],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '信息。',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'Passed' => [
- 'description' => '认证是否通过。'."\n"
- ."\n"
- .'- T:通过。'."\n"
- .'- F:不通过。',
- 'type' => 'string',
- 'example' => 'T',
- ],
- 'VerifyScore' => [
- 'description' => '人脸比对分。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '60.86',
- ],
- 'Status' => [
- 'description' => '状态',
- 'type' => 'string',
- 'example' => 'completed',
- ],
- ],
- ],
- 'Success' => [
- 'title' => '给 pop 使用的',
- 'description' => '给 pop 使用的',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'HttpCode' => [
- 'description' => 'HTTP 状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- ],
- ],
- ],
+ 'createdAt' => '2022-01-12T03:11:07.000Z',
+ 'description' => 'mrtc回调修改,获取文件接口出参修改,获取双录记录出参修改',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'GetRecordResult'],
+ ['description' => '响应参数发生变更', 'api' => 'ListRecordResults'],
+ ['description' => '请求参数发生变更', 'api' => 'UploadReport'],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
- ],
- [
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
- ],
- [
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
- ],
+ 'createdAt' => '2022-01-09T16:48:37.000Z',
+ 'description' => '本地双录远程双录,新增入参和出参',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'GetRecordResult'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4ba***\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"-\\",\\n \\"Data\\": {\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4bad38\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"-\\",\\n \\"Passed\\": \\"T\\",\\n \\"VerifyScore\\": 60.86,\\n \\"Status\\": \\"completed\\"\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200\\n}","type":"json"}]',
- 'title' => '人脸对比',
+ 'createdAt' => '2022-01-07T06:10:04.000Z',
+ 'description' => '远程双录获取接口新增返回参数,roomID和roomID对应的URL地址',
],
- 'TtsCommon' => [
- 'summary' => '语音合成',
- 'methods' => [
- 'post',
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'AssociateRoom'],
+ ['description' => '请求参数发生变更', 'api' => 'CreateSignature'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'createdAt' => '2022-01-06T06:42:43.000Z',
+ 'description' => 'bugfix',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'CreateSignature'],
],
- 'security' => [
- [
- 'AK' => [],
- ],
+ 'createdAt' => '2022-01-05T09:06:10.000Z',
+ 'description' => '增加MRTC创建签名接口',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateWatermark'],
+ ['description' => '请求参数发生变更', 'api' => 'ListRecordResults'],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
+ 'createdAt' => '2022-01-05T06:06:26.000Z',
+ 'description' => '修改创建水印参数,修改创建查询录制记录需要的部门名为部门ID',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'CreateWatermark'],
+ ['description' => 'OpenAPI 下线', 'api' => 'DeleteWatermark'],
+ ['description' => '响应参数发生变更', 'api' => 'GetWatermark'],
+ ['description' => '响应参数发生变更', 'api' => 'ListWatermarks'],
+ ['description' => 'OpenAPI 下线', 'api' => 'UpdateWatermark'],
+ ],
+ 'createdAt' => '2022-01-04T11:03:46.000Z',
+ 'description' => '水印功能完善',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'AssociateRoom'],
+ ['description' => '请求参数发生变更', 'api' => 'CreateStatisticsRecord'],
+ ['description' => 'OpenAPI 下线', 'api' => 'GetRecordResult'],
+ ['description' => 'OpenAPI 下线', 'api' => 'GetWatermark'],
+ ['description' => 'OpenAPI 下线', 'api' => 'ListRecordResults'],
+ ['description' => 'OpenAPI 下线', 'api' => 'ListWatermarks'],
+ ['description' => 'OpenAPI 下线', 'api' => 'UploadReport'],
+ ],
+ 'createdAt' => '2022-01-04T07:09:30.000Z',
+ 'description' => '增加新参数,标记客户端上报类型',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'CreateWatermark'],
],
- 'parameters' => [
- [
- 'name' => 'TtsRequest',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '请求参数',
- 'type' => 'object',
- 'properties' => [
- 'AppId' => [
- 'title' => 'appid',
- 'description' => 'appid',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'd61be709-49d2-4cf1-b219-cd6181f72***',
- ],
- 'Text' => [
- 'title' => '文本',
- 'description' => '文本',
- 'type' => 'string',
- 'required' => false,
- 'example' => '北京的天气',
- ],
- 'Voice' => [
- 'title' => '发音人',
- 'description' => '发音人',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Xiaoyun',
- ],
- 'Format' => [
- 'title' => '音频编码格式',
- 'description' => '音频编码格式',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'WAV',
- ],
- 'Volume' => [
- 'title' => '音量',
- 'description' => '音量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '50',
- ],
- 'SampleRate' => [
- 'title' => '音频采样率',
- 'description' => '音频采样率',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '16000',
- ],
- 'SpeechRate' => [
- 'title' => '语速',
- 'description' => '语速',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '50',
- ],
- 'PitchRate' => [
- 'title' => '语调',
- 'description' => '语调',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '50',
- ],
- ],
- 'required' => false,
+ 'createdAt' => '2022-01-04T06:29:55.000Z',
+ 'description' => '新增用户自定义水印功能',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateLiveRecordTemplate'],
+ ['description' => '响应参数发生变更', 'api' => 'GetLiveRecordTemplate'],
+ ['description' => '请求参数发生变更', 'api' => 'StartLiveRecordTask'],
+ ['description' => '请求参数发生变更', 'api' => 'UpdateLiveRecordTask'],
+ ['description' => '请求参数发生变更', 'api' => 'UpdateLiveRecordTemplate'],
+ ],
+ 'createdAt' => '2021-04-12T02:24:28.000Z',
+ 'description' => '支持对远程双录合流视频的自定义动态布局',
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'Idrsservice',
+ 'productName' => '智能双录质检',
+ 'ramCodes' => ['idrsservice'],
+ 'ramLevel' => '服务级',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'GetRecordsByOuterBusinessId',
+ 'description' => '根据业务ID获取双录记录',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetRecordsByOuterBusinessId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'ApiResult<TtsResponseDTO>',
- 'description' => 'ApiResult<TtsResponseDTO>',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => 'requestId',
- 'type' => 'string',
- 'example' => 'c761f0ec-107c-43dc-8565-45330e10e11b',
- ],
- 'Code' => [
- 'description' => '返回码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'Data' => [
- 'description' => '数据',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'title' => '双录端处理tts任务ID',
- 'description' => '双录端处理tts任务ID',
- 'type' => 'string',
- 'example' => '63bb629d-92bf-4cdc-ad0b-3032c926****',
- ],
- 'TaskId' => [
- 'title' => '智能语音tts任务ID',
- 'description' => '智能语音tts任务ID',
- 'type' => 'string',
- 'example' => '368cfa55-2364-4d79-aeb4-c0956c4a****',
- ],
- 'Name' => [
- 'title' => '智能语音tts任务名称',
- 'description' => '智能语音tts任务名称',
- 'type' => 'string',
- 'example' => '任务1',
- ],
- 'Code' => [
- 'title' => '智能语音tts任务code',
- 'description' => '智能语音tts任务code',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20000000',
- ],
- 'Message' => [
- 'title' => '智能语音tts任务message',
- 'description' => '智能语音tts任务message',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'PublicUrl' => [
- 'title' => '双录端语音合成结果可公网下载地址',
- 'description' => '双录端语音合成结果可公网下载地址',
- 'type' => 'string',
- 'example' => 'http://idrs-daily.oss-cn-beijing.aliyuncs.com/mode/android/model.zip?Expires=1607004612&OSSAccessKeyId=LTAI4FcsdDhFc7h78gqB****&Signature=XXXXX',
- ],
- ],
- ],
- 'Success' => [
- 'title' => '给 pop 使用的',
- 'description' => '给 pop 使用的',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'HttpCode' => [
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- ],
+ [
+ 'apiName' => 'GetWatermark',
+ 'description' => '获取水印信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetWatermark',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
- ],
- [
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
- ],
- [
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
+ [
+ 'apiName' => 'GetRecordsByFeeId',
+ 'description' => '根据feeid获取上报记录',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetRecordsByFeeId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"c761f0ec-107c-43dc-8565-45330e10e11b\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"-\\",\\n \\"Data\\": {\\n \\"Id\\": \\"63bb629d-92bf-4cdc-ad0b-3032c926****\\",\\n \\"TaskId\\": \\"368cfa55-2364-4d79-aeb4-c0956c4a****\\",\\n \\"Name\\": \\"任务1\\",\\n \\"Code\\": 20000000,\\n \\"Message\\": \\"-\\",\\n \\"PublicUrl\\": \\"http://idrs-daily.oss-cn-beijing.aliyuncs.com/mode/android/model.zip?Expires=1607004612&OSSAccessKeyId=LTAI4FcsdDhFc7h78gqB****&Signature=XXXXX\\"\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200\\n}","type":"json"}]',
- 'title' => '语音合成',
- ],
- 'TtsTask' => [
- 'summary' => '单向视频双录-语音合成推送任务',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'FaceRecognize',
+ 'description' => '人脸识别',
'operationType' => 'none',
- ],
- 'parameters' => [
- [
- 'name' => 'Request',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '任务请求参数',
- 'type' => 'object',
- 'properties' => [
- 'RoomId' => [
- 'description' => 'mrtc 房间 ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '655259585579***',
- ],
- 'Key' => [
- 'description' => 'TTS问题KEY',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'd9ee5df9-20bf-47bf-987a-76b26984b***',
- ],
- 'Timestamp' => [
- 'description' => '时间戳',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1662271315039',
- ],
- ],
- 'required' => true,
+ 'ramAction' => [
+ 'action' => 'idrsservice:FaceRecognize',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'ApiResult<H5TtsResponseDTO>',
- 'description' => 'ApiResult<H5TtsResponseDTO>',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '唯一请求识别码',
- 'type' => 'string',
- 'example' => '16A4A091-98BE-55F4-92D1-21590658***',
- ],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'Data' => [
- 'description' => '数据',
- 'type' => 'object',
- 'properties' => [
- 'Question' => [
- 'description' => '问题',
- 'type' => 'string',
- 'example' => '北京的天气如何',
- ],
- 'Answer' => [
- 'description' => '回复',
- 'type' => 'string',
- 'example' => '晴朗',
- ],
- 'Duration' => [
- 'description' => '合成的音频时长,单位毫秒',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '727',
- ],
- 'SpeechRate' => [
- 'description' => '语速',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '64',
- ],
- ],
- ],
- 'Success' => [
- 'title' => '给 pop 使用的',
- 'description' => '给 pop 使用的',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'HttpCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- ],
+ [
+ 'apiName' => 'GetPreSignedUrl',
+ 'description' => 'GetPreSignedUrl',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetPreSignedUrl',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
- ],
- [
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
- ],
- [
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
+ [
+ 'apiName' => 'ListTaskGroups',
+ 'description' => 'ListTaskGroups',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:ListTaskGroups',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A4A091-98BE-55F4-92D1-21590658***\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"-\\",\\n \\"Data\\": {\\n \\"Question\\": \\"北京的天气如何\\",\\n \\"Answer\\": \\"晴朗\\",\\n \\"Duration\\": 727,\\n \\"SpeechRate\\": 64\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200\\n}","type":"json"}]',
- 'title' => '提交TTS任务',
- ],
- 'LeaveRoom' => [
- 'summary' => '单向视频双录-通知离开房间',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- ],
- 'parameters' => [
- [
- 'name' => 'RoomId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'mrtc 房间 ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '661940620884***',
+ [
+ 'apiName' => 'UpdateUser',
+ 'description' => '更新用户',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'idrsservice:UpdateUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'ApiResult<String>',
- 'description' => 'ApiResult<String>',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '请求ID,一次请求的唯一标识。'."\n",
- 'type' => 'string',
- 'example' => '8F5F961D-07AA-5293-BFFE-32CDC251***',
- ],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'Data' => [
- 'description' => '数据',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'Success' => [
- 'title' => '给 pop 使用的',
- 'description' => '给 pop 使用的',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'HttpCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- ],
+ [
+ 'apiName' => 'GetTask',
+ 'description' => '获取指定任务信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
- ],
- [
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
- ],
- [
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
+ [
+ 'apiName' => 'AssociateRoom',
+ 'description' => 'mrtc录制信息上传',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'idrsservice:AssociateRoom',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8F5F961D-07AA-5293-BFFE-32CDC251***\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"无\\",\\n \\"Success\\": true,\\n \\"HttpCode\\": 200\\n}","type":"json"}]',
- 'title' => '离开MRTC房间',
- ],
- 'FaceRecognize' => [
- 'summary' => '单向视频双录-人脸识别静默活体',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'TtsCommon',
+ 'description' => '语音合成',
'operationType' => 'none',
- ],
- 'parameters' => [
- [
- 'name' => 'FaceRequest',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '请求参数',
- 'type' => 'object',
- 'properties' => [
- 'AppId' => [
- 'description' => '双录质检应用ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'd61be709-49d2-4cf1-b219-cd6181f72***',
- ],
- 'SourceImage' => [
- 'description' => '照片Base64编码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '/9j/4AAQSkZJRgABAQAASxxxxxxx',
- ],
- 'TargetImage' => [
- 'description' => '底库照片Base64编码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '/9j/4AAQSkZJRgABAQAASxxxxxxx',
- ],
- 'Liveness' => [
- 'description' => '是否检测真人',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
- 'required' => true,
+ 'ramAction' => [
+ 'action' => 'idrsservice:TtsCommon',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'ApiResult<FaceRecognizeResponseDTO>',
- 'description' => 'ApiResult<FaceRecognizeResponseDTO>',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4ba***',
- ],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'Data' => [
- 'description' => '数据',
- 'type' => 'object',
- 'properties' => [
- 'ComparePassed' => [
- 'title' => '识别是否通过',
- 'description' => '识别是否通过',
- 'type' => 'string',
- 'example' => 'T ',
- ],
- 'CompareScore' => [
- 'title' => '分值',
- 'description' => '分值',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '32.435',
- ],
- 'LivenessPassed' => [
- 'title' => '识别是否通过',
- 'description' => '识别是否通过',
- 'type' => 'string',
- 'example' => 'T',
- ],
- 'LivenessScore' => [
- 'title' => '分值',
- 'description' => '分值',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '56.34',
- ],
- ],
- ],
- 'Success' => [
- 'title' => '给 pop 使用的',
- 'description' => '给 pop 使用的',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'HttpCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- ],
+ [
+ 'apiName' => 'CreateRule',
+ 'description' => 'CreateRule',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'idrsservice:CreateRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
- ],
- [
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
- ],
- [
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
+ [
+ 'apiName' => 'CreateTaskGroup',
+ 'description' => 'CreateTaskGroup',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'idrsservice:CreateTaskGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- 500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
+ ],
+ [
+ 'apiName' => 'DeleteDepartment',
+ 'description' => '删除部门',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'idrsservice:DeleteDepartment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4ba***\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"-\\",\\n \\"Data\\": {\\n \\"ComparePassed\\": \\"T \\",\\n \\"CompareScore\\": 32.435,\\n \\"LivenessPassed\\": \\"T\\",\\n \\"LivenessScore\\": 56.34\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200\\n}","type":"json"}]',
- 'title' => '人脸识别',
- ],
- 'FaceLiveness' => [
- 'summary' => '单向视频双录-静默活体',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'DeleteUserDepartments',
+ 'description' => '删除用户部门关系',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'idrsservice:DeleteUserDepartments',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'RenameDetectProcess',
+ 'description' => 'RenameDetectProcess',
'operationType' => 'none',
- ],
- 'parameters' => [
- [
- 'name' => 'FaceRequest',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '请求参数',
- 'type' => 'object',
- 'properties' => [
- 'AppId' => [
- 'description' => '双录质检应用ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'd61be709-49d2-4cf1-b219-cd6181f72***',
- ],
- 'SourceImage' => [
- 'description' => '照片Base64编码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '/9j/4AAQSkZJRgABAQAASxxxxxxx',
- ],
- ],
- 'required' => true,
+ 'ramAction' => [
+ 'action' => 'idrsservice:RenameDetectProcess',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'ApiResult<FaceLivenessResponseDTO>',
- 'description' => 'ApiResult<FaceLivenessResponseDTO>',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => '7AC54DAF-38F8-58C7-8383-3131FEDDA***',
- ],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'Data' => [
- 'description' => '数据',
- 'type' => 'object',
- 'properties' => [
- 'PublicId' => [
- 'title' => '人脸任务ID',
- 'description' => '人脸任务ID',
- 'type' => 'string',
- 'example' => 'd61be709-49d2-4cf1-b219-cd6181f72***'."\n",
- ],
- 'Code' => [
- 'title' => '人脸接口返回的code',
- 'description' => '人脸接口返回的code',
- 'type' => 'string',
- 'example' => '2000000',
- ],
- 'Message' => [
- 'title' => '人脸接口返回的错误信息',
- 'description' => '人脸接口返回的错误信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Passed' => [
- 'title' => '识别是否通过',
- 'description' => '识别是否通过',
- 'type' => 'string',
- 'example' => 'T',
- ],
- 'Score' => [
- 'title' => '分值',
- 'description' => '分值',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '3.24324324324',
- ],
- 'Status' => [
- 'title' => '任务状态',
- 'description' => '任务状态',
- 'type' => 'string',
- 'example' => 'COMPLETED',
- ],
- ],
- ],
- 'Success' => [
- 'title' => '给 pop 使用的',
- 'description' => '给 pop 使用的',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'HttpCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- ],
+ [
+ 'apiName' => 'ListDetections',
+ 'description' => 'ListDetections',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:ListDetections',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
- ],
- [
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
- ],
- [
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
+ [
+ 'apiName' => 'DeleteRule',
+ 'description' => 'DeleteRule',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'idrsservice:DeleteRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7AC54DAF-38F8-58C7-8383-3131FEDDA***\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"-\\",\\n \\"Data\\": {\\n \\"PublicId\\": \\"d61be709-49d2-4cf1-b219-cd6181f72***\\\\n\\",\\n \\"Code\\": \\"2000000\\",\\n \\"Message\\": \\"success\\",\\n \\"Passed\\": \\"T\\",\\n \\"Score\\": 3.24324324324,\\n \\"Status\\": \\"COMPLETED\\"\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200\\n}","type":"json"}]',
- 'title' => '静默活体检测',
- ],
- 'CreateTtsQuestionGroup' => [
- 'summary' => '单向视频双录-创建TTS问题组',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'CreateWatermark',
+ 'description' => '创建水印信息',
'operationType' => 'create',
- ],
- 'parameters' => [
- [
- 'name' => 'Request',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '请求参数',
- 'type' => 'object',
- 'properties' => [
- 'Voice' => [
- 'description' => '发音人',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xiaoyun',
- ],
- 'Format' => [
- 'description' => '音频编码格式',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PCM',
- ],
- 'Volume' => [
- 'description' => '音量大小,取值范围:0~100。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '50',
- ],
- 'SampleRate' => [
- 'description' => '音频采样率',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '16000',
- ],
- 'SpeechRate' => [
- 'description' => '语速,取值范围:-500~500。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '50',
- ],
- 'PitchRate' => [
- 'description' => '音调,取值范围:-500~500。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '50',
- ],
- ],
- 'required' => true,
+ 'ramAction' => [
+ 'action' => 'idrsservice:CreateWatermark',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'ApiResult<IdResponseDTO>',
- 'description' => 'ApiResult<IdResponseDTO>',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '为保证一致,建议统一使用requestid',
- 'type' => 'string',
- 'example' => 'B2AADC9E-2A58-5918-AE4E-FF59E19D7***',
- ],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'Data' => [
- 'description' => '数据',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'description' => 'TTS任务组唯一ID',
- 'type' => 'string',
- 'example' => '63bb629d-92bf-4cdc-ad0b-3032c926d***',
- ],
- ],
- ],
- 'Success' => [
- 'title' => '给 pop 使用的',
- 'description' => '给 pop 使用的',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'HttpCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- ],
+ [
+ 'apiName' => 'ListRecordResults',
+ 'description' => '获取所有双录结果',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:ListRecordResults',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
- ],
- [
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
- ],
- [
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
+ [
+ 'apiName' => 'FaceLiveness',
+ 'description' => '静默活体检测',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'idrsservice:FaceLiveness',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B2AADC9E-2A58-5918-AE4E-FF59E19D7***\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"-\\",\\n \\"Data\\": {\\n \\"Id\\": \\"63bb629d-92bf-4cdc-ad0b-3032c926d***\\"\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200\\n}","type":"json"}]',
- 'title' => '创建TTS问题组',
- ],
- 'GetAsrResult' => [
- 'summary' => '单向视频双录-获取语音识别结果',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'GetTaskGroup',
+ 'description' => 'GetTaskGroup',
'operationType' => 'get',
- ],
- 'parameters' => [
- [
- 'name' => 'AsrTaskId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '任务id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'B2AADC9E-2A58-5918-AE4E-FF59E19D7***',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetTaskGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'ApiResult<ResultResponseDTO>',
- 'description' => 'ApiResult<ResultResponseDTO>',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '唯一请求识别码',
- 'type' => 'string',
- 'example' => 'C14ED32C-B9E4-54E7-BA85-C2B562C5B***',
- ],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'Data' => [
- 'description' => '数据',
- 'type' => 'object',
- 'properties' => [
- 'Result' => [
- 'description' => 'asr识别出的文本',
- 'type' => 'string',
- 'example' => '北京的天气',
- ],
- ],
- ],
- 'Success' => [
- 'title' => '给 pop 使用的',
- 'description' => '给 pop 使用的',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'HttpCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- ],
+ [
+ 'apiName' => 'AsrTask',
+ 'description' => '提交ASR任务',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'idrsservice:AsrTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
- ],
- [
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
- ],
- ],
- [
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
+ [
+ 'apiName' => 'UploadReport',
+ 'description' => '上报双录结果',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'idrsservice:UploadReport',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- 500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
+ ],
+ [
+ 'apiName' => 'GetUser',
+ 'description' => '查询用户信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C14ED32C-B9E4-54E7-BA85-C2B562C5B***\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"-\\",\\n \\"Data\\": {\\n \\"Result\\": \\"北京的天气\\"\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200\\n}","type":"json"}]',
- 'title' => '获取ASR任务结果',
- ],
- 'JoinRoom' => [
- 'summary' => '单向视频双录-通知加入房间',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'ListApps',
+ 'description' => 'ListApps',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:ListApps',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'TtsTask',
+ 'description' => '提交TTS任务',
'operationType' => 'none',
- ],
- 'parameters' => [
- [
- 'name' => 'AppId',
- 'in' => 'query',
- 'allowEmptyValue' => false,
- 'schema' => [
- 'description' => '双录质检应用id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '4a29b426-742f-4078-8386-79b440b***',
+ 'ramAction' => [
+ 'action' => 'idrsservice:TtsTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'RoomId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'mrtc 房间 ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '66194***681868',
+ ],
+ [
+ 'apiName' => 'CreateSignature',
+ 'description' => '创建 mrtc 签名',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'idrsservice:CreateSignature',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'StreamId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'mrtc 视频流或音频流ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12312***2412',
+ ],
+ [
+ 'apiName' => 'GetDetection',
+ 'description' => 'GetDetection',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetDetection',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'RoomToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'mrtc 房间密码',
- 'type' => 'string',
- 'required' => false,
- 'example' => '006f4***b269',
+ ],
+ [
+ 'apiName' => 'CreateTtsQuestionGroup',
+ 'description' => '创建TTS问题组',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'idrsservice:CreateTtsQuestionGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'ApiResult<JoinRoomResponseDTO>',
- 'description' => 'ApiResult<JoinRoomResponseDTO>',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D15744FC-97D2-5D61-A18C-8CC4FA0A3***',
- ],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'Data' => [
- 'description' => '数据',
- 'type' => 'object',
- 'properties' => [
- 'RoomId' => [
- 'description' => 'mrtc 房间 ID',
- 'type' => 'string',
- 'example' => '641981583353***',
- ],
- 'StreamId' => [
- 'description' => 'mrtc 视频流或音频流ID',
- 'type' => 'string',
- 'example' => '12312***412',
- ],
- ],
- ],
- 'Success' => [
- 'title' => '给 pop 使用的',
- 'description' => '给 pop 使用的',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'HttpCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- ],
+ [
+ 'apiName' => 'DeleteUser',
+ 'description' => '删除用户',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'idrsservice:DeleteUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
+ [
+ 'apiName' => 'UpdateApp',
+ 'description' => '更新应用',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'idrsservice:UpdateApp',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
+ ],
+ [
+ 'apiName' => 'GetStatisticsRecordsByFeeId',
+ 'description' => '根据feeid获取计费信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetStatisticsRecordsByFeeId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- 403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
+ ],
+ [
+ 'apiName' => 'DeleteApp',
+ 'description' => '删除应用',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'idrsservice:DeleteApp',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
+ ],
+ [
+ 'apiName' => 'CreateUserDepartments',
+ 'description' => '创建用户部门关系',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'idrsservice:CreateUserDepartments',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- 500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
+ ],
+ [
+ 'apiName' => 'GetTtsQuestionByGroupId',
+ 'description' => '根据TTS问题组ID获取此ID下所有的TTS信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetTtsQuestionByGroupId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D15744FC-97D2-5D61-A18C-8CC4FA0A3***\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"-\\",\\n \\"Data\\": {\\n \\"RoomId\\": \\"641981583353***\\",\\n \\"StreamId\\": \\"12312***412\\"\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200\\n}","type":"json"}]',
- 'title' => '加入MRTC房间',
- ],
- 'CreateTtsQuestion' => [
- 'summary' => '单向视频双录-创建TTS问题',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'GetRule',
+ 'description' => 'GetRule',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'CreateTtsQuestion',
+ 'description' => '创建TTS问题',
'operationType' => 'create',
- ],
- 'parameters' => [
- [
- 'name' => 'Request',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '请求参数',
- 'type' => 'object',
- 'properties' => [
- 'QuestionGroupId' => [
- 'description' => 'TTS问题组ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '47584ba4-9781-496b-8e6f-c8525a213***'."\n",
- ],
- 'Question' => [
- 'description' => '问题',
- 'type' => 'string',
- 'required' => true,
- 'example' => '您可以根据自己需求填写',
- ],
- 'Answer' => [
- 'description' => '回复',
- 'type' => 'string',
- 'required' => true,
- 'example' => '您可以根据自己需求填写',
- ],
- ],
- 'required' => true,
+ 'ramAction' => [
+ 'action' => 'idrsservice:CreateTtsQuestion',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'ApiResult<IdResponseDTO>',
- 'description' => 'ApiResult<IdResponseDTO>',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D9AA9055-F73D-592C-832B-5AEECB093***',
- ],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'Data' => [
- 'description' => '数据',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'description' => 'ID',
- 'type' => 'string',
- 'example' => '59b0bbfe-929b-4a8c-9833-3ce70b4ba***',
- ],
- ],
- ],
- 'Success' => [
- 'title' => '给 pop 使用的',
- 'description' => '给 pop 使用的',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'HttpCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- ],
+ [
+ 'apiName' => 'UpdateRule',
+ 'description' => 'UpdateRule',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'idrsservice:UpdateRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
- ],
- [
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
+ [
+ 'apiName' => 'ListWatermarks',
+ 'description' => '列表展示水印信息',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'idrsservice:ListWatermarks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
+ ],
+ [
+ 'apiName' => 'ListDetectProcesses',
+ 'description' => 'ListDetectProcesses',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:ListDetectProcesses',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- 500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
+ ],
+ [
+ 'apiName' => 'DeleteDetectProcess',
+ 'description' => 'DeleteDetectProcess',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'idrsservice:DeleteDetectProcess',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D9AA9055-F73D-592C-832B-5AEECB093***\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"-\\",\\n \\"Data\\": {\\n \\"Id\\": \\"59b0bbfe-929b-4a8c-9833-3ce70b4ba***\\"\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200\\n}","type":"json"}]',
- 'title' => '创建TTS问题',
- ],
- 'AsrTask' => [
- 'summary' => '单向视频双录-语音识别任务',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'AsrSentence',
+ 'description' => '一句话识别',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'idrsservice:AsrSentence',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'LeaveRoom',
+ 'description' => '离开MRTC房间',
'operationType' => 'none',
- ],
- 'parameters' => [
- [
- 'name' => 'Request',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '请求参数',
- 'type' => 'object',
- 'properties' => [
- 'AppId' => [
- 'description' => '双录质检应用ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'd9ee5df9-20bf-47bf-987a-76b26984b***',
- ],
- 'RoomId' => [
- 'description' => 'mrtc 房间 ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '662027426755***',
- ],
- 'Timestamp' => [
- 'description' => '时间戳',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1656388156399',
- ],
- 'Event' => [
- 'description' => '事件类型,开始START,结束END',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'START',
- ],
- 'AsrTaskId' => [
- 'description' => '任务id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'd9ee5df9-20bf-47bf-987a-76b26984b***'."\n",
- ],
- ],
- 'required' => false,
+ 'ramAction' => [
+ 'action' => 'idrsservice:LeaveRoom',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'ApiResult<IdResponseDTO>',
- 'description' => 'ApiResult<IdResponseDTO>',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'DF4B0162-A5E0-5F85-BEFD-CAC36E876***',
- ],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'Data' => [
- 'description' => '数据',
- 'type' => 'object',
- 'properties' => [
- 'Result' => [
- 'description' => '检测结果',
- 'type' => 'string',
- 'example' => '北京的天气',
- ],
- ],
- ],
- 'Success' => [
- 'title' => '给 pop 使用的',
- 'description' => '给 pop 使用的',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'HttpCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- ],
+ [
+ 'apiName' => 'ListFiles',
+ 'description' => 'ListFiles',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:ListFiles',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
+ [
+ 'apiName' => 'ListUsers',
+ 'description' => '查询用户列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:ListUsers',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
+ ],
+ [
+ 'apiName' => 'UpdateDetectProcess',
+ 'description' => 'UpdateDetectProcess',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'idrsservice:UpdateDetectProcess',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- 403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
+ ],
+ [
+ 'apiName' => 'JoinRoom',
+ 'description' => '加入MRTC房间',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'idrsservice:JoinRoom',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
+ ],
+ [
+ 'apiName' => 'GetAsrResult',
+ 'description' => '获取ASR任务结果',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetAsrResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- 500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
+ ],
+ [
+ 'apiName' => 'ListTasks',
+ 'description' => 'ListTasks',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:ListTasks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DF4B0162-A5E0-5F85-BEFD-CAC36E876***\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"-\\",\\n \\"Data\\": {\\n \\"Result\\": \\"北京的天气\\"\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200\\n}","type":"json"}]',
- 'title' => '提交ASR任务',
- ],
- 'GetTtsQuestionByGroupId' => [
- 'summary' => '根据TTS问题组ID获取TTS问题信息',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'UpdateWatermark',
+ 'description' => '更新水印信息',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'idrsservice:UpdateWatermark',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'GetDetectProcessJsonFile',
+ 'description' => '获取检测流程配置的 JSON 文件',
'operationType' => 'get',
- ],
- 'parameters' => [
- [
- 'name' => 'GroupId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'TTS问题组ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '47584ba4-9781-496b-8e6f-c8525a213***',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetDetectProcessJsonFile',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'ApiResult<GetQuestionsDTO>',
- 'description' => 'ApiResult<GetQuestionsDTO>',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '为公共参数,每个请求的id都是唯一的',
- 'type' => 'string',
- 'example' => 'D2DFCDC3-1ECF-599D-8EDA-8F598E5A9***',
- ],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'Data' => [
- 'description' => '数据',
- 'type' => 'object',
- 'properties' => [
- 'GroupId' => [
- 'description' => 'TTS问题组ID'."\n"
- ."\n",
- 'type' => 'string',
- 'example' => '47584ba4-9781-496b-8e6f-c8525a213***',
- ],
- 'Questions' => [
- 'description' => '问题列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '问题信息',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'description' => '问题id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'TenantId' => [
- 'description' => '租户id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
- 'QuestionGroupId' => [
- 'description' => '问题组id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '47584ba4-9781-496b-8e6f-c8525a213***',
- ],
- 'QuestionKey' => [
- 'description' => '问题key',
- 'type' => 'string',
- 'example' => '47584ba4-9781-496b-8e6f-c8525a213***',
- ],
- 'Question' => [
- 'description' => '问题。',
- 'type' => 'string',
- 'example' => '北京的天气如何',
- ],
- 'Answer' => [
- 'description' => '回复',
- 'type' => 'string',
- 'example' => '晴朗',
- ],
- 'Duration' => [
- 'description' => '合成的音频时长,单位毫秒',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '674',
- ],
- 'OssUrl' => [
- 'description' => '下载地址',
- 'type' => 'string',
- 'example' => 'https://pts-data-f***.pcm',
- ],
- ],
- ],
- ],
- ],
- ],
- 'Success' => [
- 'title' => '给 pop 使用的',
- 'description' => '给 pop 使用的',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'HttpCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- ],
+ [
+ 'apiName' => 'GetApp',
+ 'description' => 'GetApp',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetApp',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
- ],
- ],
- [
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
+ [
+ 'apiName' => 'CreateDepartment',
+ 'description' => 'CreateDepartment',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'idrsservice:CreateDepartment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- 403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
+ ],
+ [
+ 'apiName' => 'ListTaskItems',
+ 'description' => 'ListTaskItems',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:ListTaskItems',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
+ ],
+ [
+ 'apiName' => 'DeleteWatermark',
+ 'description' => '删除水印信息',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'idrsservice:DeleteWatermark',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- 500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
+ ],
+ [
+ 'apiName' => 'CreateApp',
+ 'description' => 'CreateApp',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'idrsservice:CreateApp',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D2DFCDC3-1ECF-599D-8EDA-8F598E5A9***\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"-\\",\\n \\"Data\\": {\\n \\"GroupId\\": \\"47584ba4-9781-496b-8e6f-c8525a213***\\",\\n \\"Questions\\": [\\n {\\n \\"Id\\": 1,\\n \\"TenantId\\": 2,\\n \\"QuestionGroupId\\": 0,\\n \\"QuestionKey\\": \\"47584ba4-9781-496b-8e6f-c8525a213***\\",\\n \\"Question\\": \\"北京的天气如何\\",\\n \\"Answer\\": \\"晴朗\\",\\n \\"Duration\\": 674,\\n \\"OssUrl\\": \\"https://pts-data-f***.pcm\\"\\n }\\n ]\\n },\\n \\"Success\\": true,\\n \\"HttpCode\\": 200\\n}","type":"json"}]',
- 'title' => '根据TTS问题组ID获取此ID下所有的TTS信息',
- ],
- 'GetRecordsByOuterBusinessId' => [
- 'summary' => '根据OuterBusinessId查询上报结果信息接口',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'GetDetectProcess',
+ 'description' => '获取检测流程信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetDetectProcess',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'GetDepartment',
+ 'description' => 'GetDepartment',
'operationType' => 'get',
- ],
- 'parameters' => [
- [
- 'name' => 'OuterBusinessId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '业务ID,用户自定义',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ads32efef43',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetDepartment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'ApiResult<List<Record>>',
- 'description' => 'ApiResult<List<Record>>',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'requestId',
- 'description' => 'requestId',
- 'type' => 'string',
- 'example' => '0f1c45cd-3eee-4e60-b505-2e330b875***',
- ],
- 'Code' => [
- 'title' => 'code',
- 'description' => 'code',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'title' => '提示',
- 'description' => '提示',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'Data' => [
- 'title' => '数据',
- 'description' => '数据',
- 'type' => 'array',
- 'items' => [
- 'description' => '数据',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'title' => '双录记录id',
- 'description' => '双录记录id',
- 'type' => 'string',
- 'example' => '0f1c45cd-3eee-4e60-b505-2e330b875***',
- ],
- 'CreatedAt' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'DetectProcessName' => [
- 'title' => '业务检测流程名',
- 'description' => '业务检测流程名',
- 'type' => 'string',
- 'example' => 'XX流程',
- ],
- 'DepartmentName' => [
- 'title' => '部门名',
- 'description' => '部门名',
- 'type' => 'string',
- 'example' => 'XX部门',
- ],
- 'AppName' => [
- 'title' => '应用名',
- 'description' => '应用名',
- 'type' => 'string',
- 'example' => 'XX应用',
- ],
- 'VideoUrl' => [
- 'title' => '视频地址',
- 'description' => '视频地址',
- 'type' => 'string',
- 'example' => 'http://oss.aliyuncs.com/1.mp4',
- ],
- 'MetaUrl' => [
- 'title' => 'meta地址',
- 'description' => 'meta地址',
- 'type' => 'string',
- 'example' => 'http://oss.aliyuncs.com/1.mp4.meta',
- ],
- 'ResultUrl' => [
- 'title' => '结果地址',
- 'description' => '结果地址',
- 'type' => 'string',
- 'example' => 'http://oss.aliyuncs.com/1.mp4.json',
- ],
- 'RecordAt' => [
- 'title' => '录制时间',
- 'description' => '录制时间',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'Duration' => [
- 'title' => '时长',
- 'description' => '时长',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '22',
- ],
- 'Status' => [
- 'title' => '检测状态',
- 'description' => '检测状态',
- 'type' => 'string',
- 'example' => 'COMPLETED',
- ],
- 'RoomId' => [
- 'title' => 'mrtc房间id',
- 'description' => 'mrtc房间id',
- 'type' => 'string',
- 'example' => '641981583353***',
- ],
- 'RecordRoomList' => [
- 'title' => '远程双录文件地址列表',
- 'description' => '远程双录文件地址列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '房间列表',
- 'type' => 'object',
- 'properties' => [
- 'Role' => [
- 'title' => '角色',
- 'description' => '角色',
- 'type' => 'string',
- 'example' => 'user',
- ],
- 'RecordType' => [
- 'title' => '录制视频类型',
- 'description' => '录制视频类型',
- 'type' => 'string',
- 'example' => 'Mix',
- ],
- 'RoomVideoUrl' => [
- 'title' => '视频地址',
- 'description' => '视频地址',
- 'type' => 'string',
- 'example' => 'http://oss.aliyuncs.com/1.mp4',
- ],
- 'RoomMetaUrl' => [
- 'title' => 'meta地址',
- 'description' => 'meta地址',
- 'type' => 'string',
- 'example' => 'http://oss.aliyuncs.com/1.mp4.meta',
- ],
- 'RoomResultUrl' => [
- 'title' => '结果地址',
- 'description' => '结果地址',
- 'type' => 'string',
- 'example' => 'http://oss.aliyuncs.com/1.mp4.json',
- ],
- 'RoomRecordAt' => [
- 'title' => '录制时间',
- 'description' => '录制时间',
- 'type' => 'string',
- 'example' => '2020-07-14T14:01:41.000+08:00',
- ],
- 'RoomStatus' => [
- 'title' => '检测状态',
- 'description' => '检测状态',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'RtcRecordId' => [
- 'description' => 'mrtc录制ID',
- 'type' => 'string',
- 'example' => 'record_65703154805715668342',
- ],
- 'OuterBusinessId' => [
- 'description' => '业务ID,用户自定义',
- 'type' => 'string',
- 'example' => 'ads32efef43',
- ],
- ],
- ],
- ],
- 'OuterBusinessId' => [
- 'description' => '业务ID,用户自定义',
- 'type' => 'string',
- 'example' => 'ads32efef43',
- ],
- ],
- ],
- ],
- 'Success' => [
- 'title' => '给 pop 使用的',
- 'description' => '给 pop 使用的',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'HttpCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Errors' => [
- 'title' => '错误列表',
- 'description' => '错误列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '错误列表',
- 'type' => 'object',
- 'properties' => [
- 'Field' => [
- 'description' => '错误 ID',
- 'type' => 'string',
- 'example' => 'A1899517-BB99-5D3E-A71B-97524DCB0***',
- ],
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '-',
- ],
- ],
- ],
- ],
- ],
+ [
+ 'apiName' => 'UpdateDepartment',
+ 'description' => 'UpdateDepartment',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'idrsservice:UpdateDepartment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidRequest',
- 'errorMessage' => 'The request is invalid.',
+ [
+ 'apiName' => 'CreateDetectProcess',
+ 'description' => 'CreateDetectProcess',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'idrsservice:CreateDetectProcess',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- [
- 'errorCode' => 'Unauthorized',
- 'errorMessage' => 'The request requires user authentication.',
+ ],
+ [
+ 'apiName' => 'ListDepartments',
+ 'description' => 'ListDepartments',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:ListDepartments',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- 403 => [
- [
- 'errorCode' => 'Forbidden',
- 'errorMessage' => 'Access to this resource on the server is denied.',
+ ],
+ [
+ 'apiName' => 'GetRecordResult',
+ 'description' => '获取双录结果',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:GetRecordResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource does not exist.',
+ ],
+ [
+ 'apiName' => 'FaceCompare',
+ 'description' => '人脸对比',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'idrsservice:FaceCompare',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- 500 => [
- [
- 'errorCode' => 'InternalServerError',
- 'errorMessage' => 'An internal server error occurred.',
+ ],
+ [
+ 'apiName' => 'ListRules',
+ 'description' => 'ListRules',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'idrsservice:ListRules',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Idrsservice', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0f1c45cd-3eee-4e60-b505-2e330b875***\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"-\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"0f1c45cd-3eee-4e60-b505-2e330b875***\\",\\n \\"CreatedAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"DetectProcessName\\": \\"XX流程\\",\\n \\"DepartmentName\\": \\"XX部门\\",\\n \\"AppName\\": \\"XX应用\\",\\n \\"VideoUrl\\": \\"http://oss.aliyuncs.com/1.mp4\\",\\n \\"MetaUrl\\": \\"http://oss.aliyuncs.com/1.mp4.meta\\",\\n \\"ResultUrl\\": \\"http://oss.aliyuncs.com/1.mp4.json\\",\\n \\"RecordAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"Duration\\": 22,\\n \\"Status\\": \\"COMPLETED\\",\\n \\"RoomId\\": \\"641981583353***\\",\\n \\"RecordRoomList\\": [\\n {\\n \\"Role\\": \\"user\\",\\n \\"RecordType\\": \\"Mix\\",\\n \\"RoomVideoUrl\\": \\"http://oss.aliyuncs.com/1.mp4\\",\\n \\"RoomMetaUrl\\": \\"http://oss.aliyuncs.com/1.mp4.meta\\",\\n \\"RoomResultUrl\\": \\"http://oss.aliyuncs.com/1.mp4.json\\",\\n \\"RoomRecordAt\\": \\"2020-07-14T14:01:41.000+08:00\\",\\n \\"RoomStatus\\": \\"1\\",\\n \\"RtcRecordId\\": \\"record_65703154805715668342\\",\\n \\"OuterBusinessId\\": \\"ads32efef43\\"\\n }\\n ],\\n \\"OuterBusinessId\\": \\"ads32efef43\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"HttpCode\\": 200,\\n \\"Errors\\": [\\n {\\n \\"Field\\": \\"A1899517-BB99-5D3E-A71B-97524DCB0***\\",\\n \\"Message\\": \\"-\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '根据业务ID获取双录记录',
- ],
- ],
- 'endpoints' => [
- [
- 'regionId' => 'ap-northeast-1',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-northeast-2-pop',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-south-1',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-2',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-3',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-5',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing-finance-1',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing-finance-pop',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing-gov-1',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing-nu16-b01',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-chengdu',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-edge-1',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-fujian',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-haidian-cm12-c01',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-bj-b01',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-finance',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-internal-prod-1',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-internal-test-1',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-internal-test-2',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-internal-test-3',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-test-306',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hongkong',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hongkong-finance-pop',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-huhehaote',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-huhehaote-nebula-1',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-north-2-gov-1',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-qingdao',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-qingdao-nebula',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-et15-b01',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-et2-b01',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-inner',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-internal-test-1',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen-finance-1',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen-inner',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen-st4-d01',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen-su18-b01',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-wuhan',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-wulanchabu',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-yushanfang',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhangbei-na61-b01',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhangjiakou',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhangjiakou-na62-a01',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhengzhou-nebula-1',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'eu-central-1',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'eu-west-1',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'eu-west-1-oxs',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'me-east-1',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'rus-west-1-pop',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'us-east-1',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'us-west-1',
- 'endpoint' => 'idrsservice.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'idrsservice.cn-hangzhou.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-finance-1',
- 'endpoint' => 'idrsservice.cn-shanghai-finance-1.aliyuncs.com',
],
+ 'resourceTypes' => [],
],
];