summaryrefslogtreecommitdiff
path: root/data/zh_cn/safconsole/2021-01-12
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/safconsole/2021-01-12
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/zh_cn/safconsole/2021-01-12')
-rw-r--r--data/zh_cn/safconsole/2021-01-12/api-docs.php383
1 files changed, 187 insertions, 196 deletions
diff --git a/data/zh_cn/safconsole/2021-01-12/api-docs.php b/data/zh_cn/safconsole/2021-01-12/api-docs.php
index 5f42de2..24c83e1 100644
--- a/data/zh_cn/safconsole/2021-01-12/api-docs.php
+++ b/data/zh_cn/safconsole/2021-01-12/api-docs.php
@@ -1,20 +1,12 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'safconsole',
- 'version' => '2021-01-12',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'safconsole', 'version' => '2021-01-12'],
'directories' => [
[
- 'id' => 236784,
- 'title' => '样本管理',
+ 'children' => ['RevokeFeedback', 'SendFeedback', 'UploadSampleApi'],
'type' => 'directory',
- 'children' => [
- 'RevokeFeedback',
- 'SendFeedback',
- 'UploadSampleApi',
- ],
+ 'title' => '样本管理',
+ 'id' => 436015,
],
],
'components' => [
@@ -23,14 +15,8 @@
'apis' => [
'RevokeFeedback' => [
'summary' => '用于风险识别服务的社群样本外部删除。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -43,32 +29,18 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '79133',
- 'abilityTreeNodes' => [
- 'FEATUREsafT73ZWM',
- ],
+ 'abilityTreeNodes' => ['FEATUREsafT73ZWM'],
],
'parameters' => [
[
'name' => 'SampleType',
'in' => 'formData',
- 'schema' => [
- 'description' => '样本类型。手机号类型样本需传入PHONE,邮箱类型样本需传入EMAIL,账户类型样本需传入ACCOUNT',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'PHONE'."\n",
- ],
+ 'schema' => ['description' => '样本类型。手机号类型样本需传入PHONE,邮箱类型样本需传入EMAIL,账户类型样本需传入ACCOUNT', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PHONE'."\n"],
],
[
'name' => 'Value',
'in' => 'formData',
- 'schema' => [
- 'description' => '样本值。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '10000000000',
- ],
+ 'schema' => ['description' => '样本值。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '10000000000'],
],
],
'responses' => [
@@ -76,46 +48,45 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '接口状态或POP错误码。取值说明如下:2xx:成功。3xx:重定向。4xx:请求错误。5xx:服务器错误。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '返回信息。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '公共参数,每个请求的ID都是唯一的,可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '4A91D2D1-AEC9-1658-ABCE-5A39DE66A5C2',
- ],
+ 'Code' => ['description' => '接口状态或POP错误码。取值说明如下:2xx:成功。3xx:重定向。4xx:请求错误。5xx:服务器错误。', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '公共参数,每个请求的ID都是唯一的,可用于排查和定位问题。', 'type' => 'string', 'example' => '4A91D2D1-AEC9-1658-ABCE-5A39DE66A5C2'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
200 => [
- [
- 'errorCode' => 'NotAuthorized',
- 'errorMessage' => 'You are not authorized to call the service. The service has expired, the quota for the subscription is reached, or you have not purchased the service.',
+ ['errorCode' => 'NotAuthorized', 'errorMessage' => 'You are not authorized to call the service. The service has expired, the quota for the subscription is reached, or you have not purchased the service.', 'description' => ''],
+ ],
+ ],
+ 'title' => '删除样本外部接口',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevokeFeedback'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'yundun-saf:RevokeFeedback',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SAF', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"4A91D2D1-AEC9-1658-ABCE-5A39DE66A5C2\\"\\n}","type":"json"}]',
- 'title' => '删除样本外部接口',
],
'SendFeedback' => [
'summary' => '用于风险识别服务的社群样本外部创建。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -128,54 +99,28 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '79134',
- 'abilityTreeNodes' => [
- 'FEATUREsafT73ZWM',
- ],
+ 'abilityTreeNodes' => ['FEATUREsafT73ZWM'],
],
'parameters' => [
[
'name' => 'SampleType',
'in' => 'query',
- 'schema' => [
- 'description' => '样本类型。手机号类型样本需传入PHONE,邮箱类型样本需传入EMAIL,账户类型样本需传入ACCOUNT',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'PHONE',
- ],
+ 'schema' => ['description' => '样本类型。手机号类型样本需传入PHONE,邮箱类型样本需传入EMAIL,账户类型样本需传入ACCOUNT', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PHONE'],
],
[
'name' => 'RiskLabel',
'in' => 'query',
- 'schema' => [
- 'description' => '样本标签。用户自定义,以逗号分隔。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'OTHERS',
- ],
+ 'schema' => ['description' => '样本标签。用户自定义,以逗号分隔。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'OTHERS'],
],
[
'name' => 'Value',
'in' => 'query',
- 'schema' => [
- 'description' => '样本值。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => false,
- 'example' => '10000000000',
- ],
+ 'schema' => ['description' => '样本值。', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => '10000000000'],
],
[
'name' => 'Reason',
'in' => 'query',
- 'schema' => [
- 'description' => '风险原因。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => 'Abnormal transaction behavior.',
- ],
+ 'schema' => ['description' => '风险原因。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Abnormal transaction behavior.'],
],
],
'responses' => [
@@ -183,47 +128,47 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '接口状态或POP错误码。取值说明如下:2xx:成功。3xx:重定向。4xx:请求错误。5xx:服务器错误。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '返回信息。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '公共参数,每个请求的ID都是唯一的,可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '4A91D2D1-AEC9-1658-ABCE-5A39DE66A5C2',
- ],
+ 'Code' => ['description' => '接口状态或POP错误码。取值说明如下:2xx:成功。3xx:重定向。4xx:请求错误。5xx:服务器错误。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '公共参数,每个请求的ID都是唯一的,可用于排查和定位问题。', 'type' => 'string', 'example' => '4A91D2D1-AEC9-1658-ABCE-5A39DE66A5C2'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
200 => [
- [
- 'errorCode' => 'NotAuthorized',
- 'errorMessage' => 'You are not authorized to call the service. The service has expired, the quota for the subscription is reached, or you have not purchased the service.',
+ ['errorCode' => 'NotAuthorized', 'errorMessage' => 'You are not authorized to call the service. The service has expired, the quota for the subscription is reached, or you have not purchased the service.', 'description' => ''],
+ ],
+ ],
+ 'title' => '创建样本外部接口',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-23T04:52:17.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendFeedback'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-saf:SendFeedback',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SAF', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"4A91D2D1-AEC9-1658-ABCE-5A39DE66A5C2\\"\\n}","type":"json"}]',
- 'title' => '创建样本外部接口',
],
'UploadSampleApi' => [
'summary' => '用于风险识别服务的样本上传。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -233,71 +178,49 @@
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '207197',
- 'abilityTreeNodes' => [
- 'FEATUREsafT73ZWM',
- ],
+ 'abilityTreeNodes' => ['FEATUREsafT73ZWM'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SampleType',
'in' => 'query',
- 'schema' => [
- 'description' => '样本的类型'."\n"
- ."\n"
- .'- 黑名单: block'."\n"
- ."\n"
- .'- 白名单: pass',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'block',
- ],
+ 'schema' => ['description' => '样本的类型'."\n"
+ ."\n"
+ .'- 黑名单: block'."\n"
+ ."\n"
+ .'- 白名单: pass', 'type' => 'string', 'required' => true, 'example' => 'block'],
],
[
'name' => 'DataType',
'in' => 'query',
- 'schema' => [
- 'description' => '样本的数据类型'."\n"
- ."\n"
- .'- 手机号: mobile'."\n"
- .'- 手机号MD5: mobileMd5'."\n"
- .'- IP: ip'."\n"
- .'- 设备唯一id: umid'."\n"
- .'- 账号: accountId'."\n"
- .'- imei: imei'."\n"
- .'- imeiMd5: imeiMd5'."\n"
- .'- oaid: oaid'."\n"
- .'- oaidMd5: oaidMd5'."\n"
- .'- androidId: androidId'."\n"
- .'- androidIdMd5: androidIdMd5',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ip',
- ],
+ 'schema' => ['description' => '样本的数据类型'."\n"
+ ."\n"
+ .'- 手机号: mobile'."\n"
+ .'- 手机号MD5: mobileMd5'."\n"
+ .'- IP: ip'."\n"
+ .'- 设备唯一id: umid'."\n"
+ .'- 账号: accountId'."\n"
+ .'- imei: imei'."\n"
+ .'- imeiMd5: imeiMd5'."\n"
+ .'- oaid: oaid'."\n"
+ .'- oaidMd5: oaidMd5'."\n"
+ .'- androidId: androidId'."\n"
+ .'- androidIdMd5: androidIdMd5', 'type' => 'string', 'required' => true, 'example' => 'ip'],
],
[
'name' => 'Service',
'in' => 'query',
- 'schema' => [
- 'description' => '生效服务的列表,多个服务用逗号分开'."\n"
- ."\n"
- .'- 注册风险识别基础版/增强版: account_abuse'."\n"
- .'- 营销风险识别基础版/增强版: coupon_abuse'."\n"
- .'- 登录风险识别基础版/增强版: account_takeover',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'account_abuse,coupon_abuse,account_takeover',
- ],
+ 'schema' => ['description' => '生效服务的列表,多个服务用逗号分开'."\n"
+ ."\n"
+ .'- 注册风险识别基础版/增强版: account_abuse'."\n"
+ .'- 营销风险识别基础版/增强版: coupon_abuse'."\n"
+ .'- 登录风险识别基础版/增强版: account_takeover', 'type' => 'string', 'required' => true, 'example' => 'account_abuse,coupon_abuse,account_takeover'],
],
[
'name' => 'DataValue',
'in' => 'query',
- 'schema' => [
- 'description' => '样本的具体值,以JSON格式传入。一次不要超过1000条。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '["123.124.125.126","123.124.125.127"]',
- ],
+ 'schema' => ['description' => '样本的具体值,以JSON格式传入。一次不要超过1000条。', 'type' => 'string', 'required' => true, 'example' => '["123.124.125.126","123.124.125.127"]'],
],
],
'responses' => [
@@ -307,43 +230,111 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '4A91D2D1-AEC9-1658-ABCE-5A39DE66A5C2',
- ],
- 'Message' => [
- 'description' => '返回的错误消息',
- 'type' => 'string',
- 'example' => 'null',
- ],
- 'Code' => [
- 'description' => '返回的请求码',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '访问是否成功的标志',
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '4A91D2D1-AEC9-1658-ABCE-5A39DE66A5C2'],
+ 'Message' => ['description' => '返回的错误消息', 'type' => 'string', 'example' => 'null'],
+ 'Code' => ['description' => '返回的请求码', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['description' => '访问是否成功的标志', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4A91D2D1-AEC9-1658-ABCE-5A39DE66A5C2\\",\\n \\"Message\\": \\"null\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
'title' => '上传样本接口',
+ 'changeSet' => [
+ ['createdAt' => '2023-12-28T09:21:12.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadSampleApi'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-saf:UploadSampleApi',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SAF', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
],
'endpoints' => [
+ ['regionId' => 'cn-hangzhou', 'regionName' => '华东1(杭州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'safconsole.cn-hangzhou.aliyuncs.com', 'endpoint' => 'safconsole.cn-hangzhou.aliyuncs.com', 'vpc' => 'safconsole-vpc.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'regionName' => '华东2(上海)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'safconsole.cn-shanghai.aliyuncs.com', 'endpoint' => 'safconsole.cn-shanghai.aliyuncs.com', 'vpc' => 'safconsole-vpc.cn-shanghai.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => 'NotAuthorized', 'message' => 'You do not have permission to access this resource.', 'http_code' => 400, 'description' => '您没有权限访问此资源。'],
+ ],
+ 'changeSet' => [
[
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'safconsole.cn-shanghai.aliyuncs.com',
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'UploadSampleApi'],
+ ],
+ 'createdAt' => '2023-12-28T09:21:18.000Z',
+ 'description' => '',
],
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'safconsole.cn-hangzhou.aliyuncs.com',
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendFeedback'],
+ ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevokeFeedback'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadSampleApi'],
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'SAF',
+ 'productName' => '风险识别',
+ 'ramCodes' => ['yundun-saf'],
+ 'ramLevel' => '操作级',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'RevokeFeedback',
+ 'description' => '删除样本外部接口',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'yundun-saf:RevokeFeedback',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SAF', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SendFeedback',
+ 'description' => '创建样本外部接口',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-saf:SendFeedback',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SAF', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UploadSampleApi',
+ 'description' => '上传样本接口',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-saf:UploadSampleApi',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SAF', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'resourceTypes' => [
+ ['validationType' => 'always', 'resourceType' => 'Samplebatch', 'arn' => 'acs:yundun-saf::{#accountId}:samplebatch/*'],
],
],
];