diff options
| author | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
|---|---|---|
| committer | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
| commit | 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch) | |
| tree | 5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/captcha | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/en_us/captcha')
| -rw-r--r-- | data/en_us/captcha/2023-03-05/api-docs.php | 274 |
1 files changed, 142 insertions, 132 deletions
diff --git a/data/en_us/captcha/2023-03-05/api-docs.php b/data/en_us/captcha/2023-03-05/api-docs.php index 7b9ff74..d01a7e6 100644 --- a/data/en_us/captcha/2023-03-05/api-docs.php +++ b/data/en_us/captcha/2023-03-05/api-docs.php @@ -1,35 +1,22 @@ <?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' => null, + 'children' => ['VerifyCaptcha'], 'type' => 'directory', - 'children' => [ - 'VerifyCaptcha', - ], + 'title' => 'Offline', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'VerifyIntelligentCaptcha' => [ - 'summary' => '验证码验证', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'VerifyCaptcha' => [ + 'summary' => 'Captcha verification API. This API is no longer recommended for integration. Please use VerifyIntelligentCaptcha instead.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -39,97 +26,72 @@ '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' => [ - 'type' => 'string', - ], + 'in' => 'query', + 'schema' => ['description' => 'The verification parameter passed in from the client.', 'type' => 'string', 'required' => false, 'example' => 'dsjidsjidsjkds*djsjdiskds', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '95784F***D39FDC5'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The response message. If the request is successful, the value is success.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ - 'description' => '', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'VerifyResult' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'VerifyCode' => [ - 'type' => 'string', - ], - 'CertifyId' => [ - 'type' => 'string', - ], + 'VerifyResult' => ['description' => 'The verification result.'."\n" + ."\n" + .'- true: The verification is passed.'."\n" + ."\n" + .'- false: The verification is not passed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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"}]', - ], - 'VerifyCaptcha' => [ - 'summary' => '验证码验证', - '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' => 'Verify Captcha', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'VerifyIntelligentCaptcha' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -139,77 +101,125 @@ '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' => 'The verification parameter passed in by the client.', 'type' => 'string', 'required' => false, 'example' => 'dsjidsjidsjkds*djsjdiskds'."\n", 'title' => ''], + ], + [ + 'name' => 'SceneId', + 'in' => 'formData', + 'schema' => ['description' => 'The scene ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '95784F***D39FDC5'."\n"], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The response message. If the request is successful, success is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ - 'description' => '', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'VerifyResult' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'VerifyResult' => ['description' => 'The verification result.'."\n" + ."\n" + .'- true: The verification is passed.'."\n" + ."\n" + .'- false: The verification fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'VerifyCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CertifyId' => ['description' => 'The authentication ID.', 'type' => 'string', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Intelligent CAPTCHA Verification', + 'summary' => 'Intelligent CAPTCHA verification API.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyIntelligentCaptcha'], + ], ], - '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"}]', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'yundun-afs:VerifyCaptcha', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Captcha', 'resourceType' => 'All Resource', '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' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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 Application Firewall', + 'ramCodes' => ['yundun-afs'], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'VerifyIntelligentCaptcha', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'yundun-afs:VerifyCaptcha', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Captcha', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'VerifyCaptcha', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'yundun-afs:VerifyCaptcha', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Captcha', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'resourceTypes' => [], ], ]; |
