summaryrefslogtreecommitdiff
path: root/data/zh_cn/captcha/2023-03-05/api-docs.php
diff options
context:
space:
mode:
Diffstat (limited to 'data/zh_cn/captcha/2023-03-05/api-docs.php')
-rw-r--r--data/zh_cn/captcha/2023-03-05/api-docs.php277
1 files changed, 136 insertions, 141 deletions
diff --git a/data/zh_cn/captcha/2023-03-05/api-docs.php b/data/zh_cn/captcha/2023-03-05/api-docs.php
index de7654b..acceed2 100644
--- a/data/zh_cn/captcha/2023-03-05/api-docs.php
+++ b/data/zh_cn/captcha/2023-03-05/api-docs.php
@@ -1,35 +1,23 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'captcha',
- 'version' => '2023-03-05',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'captcha', 'version' => '2023-03-05'],
'directories' => [
'VerifyIntelligentCaptcha',
[
- 'id' => 198934,
- 'title' => '下线中',
+ 'children' => ['VerifyCaptcha'],
'type' => 'directory',
- 'children' => [
- 'VerifyCaptcha',
- ],
+ 'title' => '下线中',
+ 'id' => 34244,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'VerifyIntelligentCaptcha' => [
- 'summary' => '验证码智能验证接口。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'VerifyCaptcha' => [
+ 'summary' => '验证码验证接口。该接口已不建议接入，请使用VerifyIntelligentCaptcha。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -39,33 +27,15 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeCode' => '194420',
- 'abilityTreeNodes' => [
- 'FEATUREwafACFB6T',
- ],
+ 'abilityTreeCode' => '175427',
+ 'abilityTreeNodes' => ['FEATUREwafACFB6T'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'CaptchaVerifyParam',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '由端上传入的验证参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'dsjidsjidsjkds*djsjdiskds'."\n",
- ],
- ],
- [
- 'name' => 'SceneId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '场景id。',
- 'type' => 'string',
- 'required' => false,
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => '由端上传入的验证参数。', 'type' => 'string', 'required' => false, 'example' => 'dsjidsjidsjkds*djsjdiskds'],
],
],
'responses' => [
@@ -75,69 +45,51 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '95784F***D39FDC5'."\n",
- ],
- 'Success' => [
- 'description' => '请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '响应码',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => '响应消息，若成功请求为success',
- 'type' => 'string',
- 'example' => 'success',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '95784F***D39FDC5'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'Success'],
+ 'Message' => ['description' => '响应消息，若成功请求为success', 'type' => 'string', 'example' => 'success'],
'Result' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
- 'VerifyResult' => [
- 'description' => '验证结果'."\n"
- ."\n"
- .'- true：验证通过'."\n"
- ."\n"
- .'- false：验证不通过',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'VerifyCode' => [
- 'type' => 'string',
- ],
- 'CertifyId' => [
- 'description' => '认证ID',
- 'type' => 'string',
- ],
+ 'VerifyResult' => ['description' => '验证结果。'."\n"
+ ."\n"
+ .'- true：验证通过。'."\n"
+ ."\n"
+ .'- false：验证不通过。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"95784F***D39FDC5\\\\n\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"VerifyResult\\": true,\\n \\"VerifyCode\\": \\"\\",\\n \\"CertifyId\\": \\"\\"\\n }\\n}","type":"json"}]',
- 'title' => '验证码智能验证',
- ],
- 'VerifyCaptcha' => [
- 'summary' => '验证码验证接口。该接口已不建议接入，请使用VerifyIntelligentCaptcha。',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"95784F***D39FDC5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"VerifyResult\\": true\\n }\\n}","type":"json"}]',
+ 'title' => '验证码验证',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyCaptcha'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-afs:VerifyCaptcha',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Captcha', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'VerifyIntelligentCaptcha' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -147,22 +99,22 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
- 'abilityTreeCode' => '175427',
- 'abilityTreeNodes' => [
- 'FEATUREwafACFB6T',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '194420',
+ 'abilityTreeNodes' => ['FEATUREwafACFB6T'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'CaptchaVerifyParam',
- 'in' => 'query',
- 'schema' => [
- 'description' => '由端上传入的验证参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'dsjidsjidsjkds*djsjdiskds',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => '由端上传入的验证参数。', 'type' => 'string', 'required' => false, 'example' => 'dsjidsjidsjkds*djsjdiskds'."\n"],
+ ],
+ [
+ 'name' => 'SceneId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '场景id。', 'type' => 'string', 'required' => false],
],
],
'responses' => [
@@ -172,57 +124,100 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '95784F***D39FDC5',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '响应码',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => '响应消息，若成功请求为success',
- 'type' => 'string',
- 'example' => 'success',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '95784F***D39FDC5'."\n"],
+ 'Success' => ['description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'Success'],
+ 'Message' => ['description' => '响应消息，若成功请求为success', 'type' => 'string', 'example' => 'success'],
'Result' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
- 'VerifyResult' => [
- 'description' => '验证结果。'."\n"
- ."\n"
- .'- true：验证通过。'."\n"
- ."\n"
- .'- false：验证不通过。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'VerifyResult' => ['description' => '验证结果'."\n"
+ ."\n"
+ .'- true：验证通过'."\n"
+ ."\n"
+ .'- false：验证不通过', 'type' => 'boolean', 'example' => 'true'],
+ 'VerifyCode' => ['type' => 'string', 'description' => ''],
+ 'CertifyId' => ['description' => '认证ID', 'type' => 'string'],
],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '验证码智能验证',
+ 'summary' => '验证码智能验证接口。',
+ 'changeSet' => [
+ ['createdAt' => '2023-12-21T08:59:25.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2023-11-22T07:31:58.000Z', 'description' => '请求参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"95784F***D39FDC5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"VerifyResult\\": true\\n }\\n}","type":"json"}]',
- 'title' => '验证码验证',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyIntelligentCaptcha'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-afs:VerifyCaptcha',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Captcha', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"95784F***D39FDC5\\\\n\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"VerifyResult\\": true,\\n \\"VerifyCode\\": \\"\\",\\n \\"CertifyId\\": \\"\\"\\n }\\n}","type":"json"}]',
],
],
'endpoints' => [
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'captcha.cn-shanghai.aliyuncs.com',
+ ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'captcha.cn-shanghai.aliyuncs.com', 'endpoint' => 'captcha.cn-shanghai.aliyuncs.com', 'vpc' => 'captcha-vpc.cn-shanghai.aliyuncs.com'],
+ ],
+ 'errorCodes' => [],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyIntelligentCaptcha'],
+ ['threshold' => '1500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyCaptcha'],
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'Captcha',
+ 'productName' => 'Web应用防火墙',
+ 'ramCodes' => ['yundun-afs'],
+ 'ramLevel' => '操作级',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'VerifyIntelligentCaptcha',
+ 'description' => '验证码智能验证',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-afs:VerifyCaptcha',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Captcha', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'VerifyCaptcha',
+ 'description' => '验证码验证（待下线）',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-afs:VerifyCaptcha',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Captcha', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'resourceTypes' => [],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 18:37:10 +0000