summaryrefslogtreecommitdiff
path: root/data/zh_cn/saf/2019-05-21
diff options
context:
space:
mode:
Diffstat (limited to 'data/zh_cn/saf/2019-05-21')
-rw-r--r--data/zh_cn/saf/2019-05-21/api-docs.php491
1 files changed, 491 insertions, 0 deletions
diff --git a/data/zh_cn/saf/2019-05-21/api-docs.php b/data/zh_cn/saf/2019-05-21/api-docs.php
new file mode 100644
index 0000000..aeb823e
--- /dev/null
+++ b/data/zh_cn/saf/2019-05-21/api-docs.php
@@ -0,0 +1,491 @@
+<?php return [
+ 'version' => '1.0',
+ 'info' => [
+ 'style' => 'RPC',
+ 'product' => 'saf',
+ 'version' => '2019-05-21',
+ ],
+ 'directories' => [
+ [
+ 'id' => 181717,
+ 'title' => '国内公共服务调用',
+ 'type' => 'directory',
+ 'children' => [
+ 'ExecuteRequest',
+ ],
+ ],
+ [
+ 'id' => 181718,
+ 'title' => '海外公共服务调用',
+ 'type' => 'directory',
+ 'children' => [
+ 'ExecuteRequestML',
+ 'ExecuteRequestSG',
+ ],
+ ],
+ [
+ 'id' => 181726,
+ 'title' => '自定义事件服务调用',
+ 'type' => 'directory',
+ 'children' => [
+ 'RequestDecision',
+ ],
+ ],
+ ],
+ 'components' => [
+ 'schemas' => [],
+ ],
+ 'apis' => [
+ 'ExecuteRequest' => [
+ 'summary' => '风险检测接口，该接口支持公共服务调用和自定义事件调用。',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '48720',
+ 'abilityTreeNodes' => [
+ 'FEATUREsaf7L0MVB',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ServiceParameters',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '服务入参，Json格式的字符串，完整Json字符串信息。如果是自定义事件，这里需要添加eventCode属性。',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '{"accountId": "1233***"}',
+ ],
+ ],
+ [
+ 'name' => 'Service',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '服务产品码。如果是自定义事件，这里填saf_de。',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'account_abuse_pro',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'description' => '状态码。',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Message' => [
+ 'description' => '结果信息。',
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Data' => [
+ 'description' => '数据信息，包含：tags、score、extend等字段。',
+ 'type' => 'object',
+ 'example' => '{"score": 80.4, "tags": "ra0601,rnk0002,rn0312"}',
+ ],
+ 'RequestId' => [
+ 'description' => '请求ID。',
+ 'type' => 'string',
+ 'example' => 'A5F41DC6-2070-5CE7-8B2D-7A23D882932D',
+ ],
+ 'AccessDeniedDetail' => [
+ 'description' => '无权限诊断详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'AuthAction' => [
+ 'description' => '访问者尝试执行的具体操作（如 s3:PutObject, ec2:DescribeInstances 等）。',
+ 'type' => 'string',
+ 'example' => 'yundun-saf:Execute',
+ ],
+ 'AuthPrincipalType' => [
+ 'description' => '请求主体的身份类型。'."\n"
+ .'- SubUser：子账号（主账号创建的子用户）。'."\n"
+ .'- AssumedRoleUser：角色（通过 AssumeRole 操作获得的临时身份）。',
+ 'type' => 'string',
+ 'example' => 'SubUser',
+ ],
+ 'AuthPrincipalOwnerId' => [
+ 'description' => '发起请求的访问主体所属的云账号UID。',
+ 'type' => 'string',
+ 'example' => '178059440630****',
+ ],
+ 'AuthPrincipalDisplayName' => [
+ 'description' => '请求主体的可读标识名称（如用户名、角色名）。',
+ 'type' => 'string',
+ 'example' => '29918048924096****',
+ ],
+ 'PolicyType' => [
+ 'description' => '标识无权限场景下的策略作用范围及类型'."\n"
+ .'- AccountLevelIdentityBasedPolicy：账号层级身份策略（作用于整个云账号）。'."\n"
+ .'- ResourceGroupLevelIdentityBasedPolicy：资源组层级身份策略（作用于指定资源组）。'."\n"
+ .'- SessionPolicy：角色会话策略（临时会话生效的附加策略）。'."\n"
+ .'- ControlPolicy：管控策略（核心权限控制策略）。'."\n"
+ .'- AssumeRolePolicy：角色信任策略（定义角色被哪些实体信任）。',
+ 'type' => 'string',
+ 'example' => 'AccountLevelIdentityBasedPolicy',
+ ],
+ 'NoPermissionType' => [
+ 'description' => '无权限的具体判定类型。'."\n"
+ .'- ImplicitDeny：隐式拒绝（无显式授权）。'."\n"
+ .'- ExplicitDeny：显式拒绝（策略中明确拒绝该操作）。',
+ 'type' => 'string',
+ 'example' => 'ImplicitDeny',
+ ],
+ 'EncodedDiagnosticMessage' => [
+ 'description' => 'Base64编码的权限诊断日志，用于问题排查和自动化分析。',
+ 'type' => 'string',
+ 'example' => 'AQIBIAAAA...r+ow==',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"score\\": 80.4,\\n \\"tags\\": \\"ra0601,rnk0002,rn0312\\"\\n },\\n \\"RequestId\\": \\"A5F41DC6-2070-5CE7-8B2D-7A23D882932D\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"yundun-saf:Execute\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"AuthPrincipalOwnerId\\": \\"178059440630****\\",\\n \\"AuthPrincipalDisplayName\\": \\"29918048924096****\\",\\n \\"PolicyType\\": \\"AccountLevelIdentityBasedPolicy\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQIBIAAAA...r+ow==\\"\\n }\\n}","type":"json"}]',
+ 'title' => '多个场景风险识别检测',
+ ],
+ 'ExecuteRequestML' => [
+ 'summary' => '风险检测接口，该接口只支持自定义事件调用，并且只适用于马来西亚区域。',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '48721',
+ 'abilityTreeNodes' => [
+ 'FEATUREsaf6MRPQF',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ServiceParameters',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '服务入参，Json格式的字符串，完整Json字符串信息。这里需要添加自定义事件的eventCode属性。',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '{"accountId": "1233***"}',
+ ],
+ ],
+ [
+ 'name' => 'Service',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '服务产品码。因为该接口只支持自定义事件，所以这里填saf_de。',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'saf_de',
+ ],
+ ],
+ [
+ 'name' => 'Lang',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '语言。',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'en',
+ 'default' => 'en-us',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'description' => '状态码。',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Message' => [
+ 'description' => '结果信息。',
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Data' => [
+ 'description' => '数据信息，包含：tags、score、extend等字段。',
+ 'type' => 'object',
+ 'example' => '{"score": 80.4, "tags": "ra0601,rnk0002,rn0312"}',
+ ],
+ 'RequestId' => [
+ 'description' => '请求ID。',
+ 'type' => 'string',
+ 'example' => 'A5F41DC6-2070-5CE7-8B2D-7A23D882932D',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"score\\": 80.4,\\n \\"tags\\": \\"ra0601,rnk0002,rn0312\\"\\n },\\n \\"RequestId\\": \\"A5F41DC6-2070-5CE7-8B2D-7A23D882932D\\"\\n}","type":"json"}]',
+ 'title' => '调用决策引擎马来集群',
+ ],
+ 'ExecuteRequestSG' => [
+ 'summary' => '风险检测接口，该接口支持公共服务调用和自定义事件调用。',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '48722',
+ 'abilityTreeNodes' => [
+ 'FEATUREsaf6MRPQF',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ServiceParameters',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '服务入参，Json格式的字符串，完整Json字符串信息。如果是自定义事件，这里需要添加eventCode属性。',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '{"accountId": "1233***"}',
+ ],
+ ],
+ [
+ 'name' => 'Service',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '服务产品码。如果是自定义事件，这里填saf_de。',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'account_abuse_intl_pro',
+ ],
+ ],
+ [
+ 'name' => 'Lang',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '语言。',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'en',
+ 'default' => 'en-us',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'description' => '状态码。',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Message' => [
+ 'description' => '结果信息。',
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Data' => [
+ 'description' => '数据信息，包含：tags、score、extend等字段。',
+ 'type' => 'object',
+ 'example' => '{"score": 80.4, "tags": "ra0601,rnk0002,rn0312"}',
+ ],
+ 'RequestId' => [
+ 'description' => '请求ID。',
+ 'type' => 'string',
+ 'example' => 'A5F41DC6-2070-5CE7-8B2D-7A23D882932D',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"score\\": 80.4,\\n \\"tags\\": \\"ra0601,rnk0002,rn0312\\"\\n },\\n \\"RequestId\\": \\"A5F41DC6-2070-5CE7-8B2D-7A23D882932D\\"\\n}","type":"json"}]',
+ 'title' => '调用决策引擎新加坡集群',
+ ],
+ 'RequestDecision' => [
+ 'summary' => '风险检测接口，该接口只支持自定义事件调用。',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '114081',
+ 'abilityTreeNodes' => [
+ 'FEATUREsaf6MRPQF',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ServiceParameters',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '服务入参，Json格式的字符串，完整Json字符串信息。',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{"accountId": "1233***"}',
+ ],
+ ],
+ [
+ 'name' => 'EventCode',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '事件编码。',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'de_*',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => '请求ID。',
+ 'type' => 'string',
+ 'example' => 'A5F41DC6-2070-5CE7-8B2D-7A23D882932D',
+ ],
+ 'Code' => [
+ 'description' => '状态码。',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '200',
+ ],
+ 'Message' => [
+ 'description' => '结果信息。',
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Data' => [
+ 'description' => '数据信息，包含：tags、score、extend等字段。',
+ 'type' => 'object',
+ 'example' => '{"score": 80.4, "tags": "ra0601,rnk0002,rn0312"}',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A5F41DC6-2070-5CE7-8B2D-7A23D882932D\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"score\\": 80.4,\\n \\"tags\\": \\"ra0601,rnk0002,rn0312\\"\\n }\\n}","type":"json"}]',
+ 'title' => '调用决策引擎自定义事件',
+ ],
+ ],
+ 'endpoints' => [
+ [
+ 'regionId' => 'cn-hangzhou',
+ 'endpoint' => 'saf.cn-hangzhou.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-beijing',
+ 'endpoint' => 'saf.cn-beijing.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-zhangjiakou',
+ 'endpoint' => 'saf.cn-zhangjiakou.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shanghai',
+ 'endpoint' => 'saf.cn-shanghai.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shenzhen',
+ 'endpoint' => 'saf.cn-shenzhen.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hongkong',
+ 'endpoint' => 'saf.cn-hongkong.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-southeast-1',
+ 'endpoint' => 'saf.ap-southeast-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-southeast-3',
+ 'endpoint' => 'saf.ap-southeast-3.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'us-east-1',
+ 'endpoint' => 'saf.us-east-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'us-west-1',
+ 'endpoint' => 'saf.us-west-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'eu-central-1',
+ 'endpoint' => 'saf.eu-central-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-south-1',
+ 'endpoint' => 'saf.ap-south-1.aliyuncs.com',
+ ],
+ ],
+];
generated by cgit v1.2.3 (git 2.46.0) at 2026-03-07 12:50:13 +0000