summaryrefslogtreecommitdiff
path: root/data/en_us/saf/2019-05-21/api-docs.php
diff options
context:
space:
mode:
authorZhineng Li <[email protected]>2026-02-13 10:54:11 +0800
committerZhineng Li <[email protected]>2026-02-13 10:54:11 +0800
commit7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch)
tree0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/saf/2019-05-21/api-docs.php
downloadacs-metadata-full-main.tar.gz
acs-metadata-full-main.zip
Diffstat (limited to 'data/en_us/saf/2019-05-21/api-docs.php')
-rw-r--r--data/en_us/saf/2019-05-21/api-docs.php501
1 files changed, 501 insertions, 0 deletions
diff --git a/data/en_us/saf/2019-05-21/api-docs.php b/data/en_us/saf/2019-05-21/api-docs.php
new file mode 100644
index 0000000..781d18c
--- /dev/null
+++ b/data/en_us/saf/2019-05-21/api-docs.php
@@ -0,0 +1,501 @@
+<?php return [
+ 'version' => '1.0',
+ 'info' => [
+ 'style' => 'RPC',
+ 'product' => 'saf',
+ 'version' => '2019-05-21',
+ ],
+ 'directories' => [
+ [
+ 'id' => 181717,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'ExecuteRequest',
+ ],
+ ],
+ [
+ 'id' => 181718,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'ExecuteRequestML',
+ 'ExecuteRequestSG',
+ ],
+ ],
+ [
+ 'id' => 181726,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'RequestDecision',
+ ],
+ ],
+ ],
+ 'components' => [
+ 'schemas' => [],
+ ],
+ 'apis' => [
+ 'ExecuteRequest' => [
+ 'summary' => 'Risk detection interface that supports both public service calls and custom event calls.',
+ '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' => 'Service input parameters, a JSON formatted string containing the complete JSON information. If it is a custom event, an `eventCode` attribute needs to be added here.',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '{"accountId": "1233***"}',
+ ],
+ ],
+ [
+ 'name' => 'Service',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Service product code. For custom events, fill in `saf_de` here.',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'account_abuse_pro',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'description' => 'Status code.',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Message' => [
+ 'description' => 'Result message.',
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Data' => [
+ 'description' => 'Data information, including fields such as tags, score, and extend.',
+ 'type' => 'object',
+ 'example' => '{"score": 80.4, "tags": "ra0601,rnk0002,rn0312"}',
+ ],
+ 'RequestId' => [
+ 'description' => 'Request ID.',
+ 'type' => 'string',
+ 'example' => 'A5F41DC6-2070-5CE7-8B2D-7A23D882932D',
+ ],
+ 'AccessDeniedDetail' => [
+ 'description' => 'The details about the access denial.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'AuthAction' => [
+ 'description' => 'The specific operation attempted by the visitor (such as s3:PutObject, ec2:DescribeInstances, etc.)',
+ 'type' => 'string',
+ 'example' => 'yundun-saf:Execute',
+ ],
+ 'AuthPrincipalType' => [
+ 'description' => 'Request the identity type of the subject.'."\n"
+ .'- SubUser: Sub account (created by the main account).'."\n"
+ .'- AssumdRoleUser: Role (temporary identity obtained through the AssumRole operation).',
+ 'type' => 'string',
+ 'example' => 'SubUser',
+ ],
+ 'AuthPrincipalOwnerId' => [
+ 'description' => 'UID of the cloud account to which the requesting access subject belongs.',
+ 'type' => 'string',
+ 'example' => '178059440630****',
+ ],
+ 'AuthPrincipalDisplayName' => [
+ 'description' => 'Request the readable identifier name of the subject (such as username, role name).',
+ 'type' => 'string',
+ 'example' => '29918048924096****',
+ ],
+ 'PolicyType' => [
+ 'description' => 'Identify the scope and types of policy effects in unauthorized scenarios.'."\n"
+ .'- AccountLevelIdentityBasedPolicy: Account Level Identity Policy (applies to the entire cloud account).'."\n"
+ .'- ResourceGroupLevelIdentityBasedPolicy: Resource Group Level Identity Policy (applies to specified resource groups).'."\n"
+ .'- SessionPolicy: Role Session Policy (Additional Policy for Temporary Sessions to Take Effect).'."\n"
+ .'- ControlPolicy: Control Policy (Core Permission Control Policy).'."\n"
+ .'- AssumRolePolicy: Role trust policy (defining which entities trust a role).',
+ 'type' => 'string',
+ 'example' => 'AccountLevelIdentityBasedPolicy',
+ ],
+ 'NoPermissionType' => [
+ 'description' => 'Specific types of judgments without permission.'."\n"
+ .'- ImplicitDeny: Implicit refusal (without explicit authorization).'."\n"
+ .'- ExplicitDeny: Explicitly reject (explicitly reject the operation in the policy).',
+ 'type' => 'string',
+ 'example' => 'ImplicitDeny',
+ ],
+ 'EncodedDiagnosticMessage' => [
+ 'description' => 'Base64 encoded permission diagnostic logs for troubleshooting and automated analysis.',
+ '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' => 'Multi-Scenario Risk Identification and Detection',
+ 'translator' => 'machine',
+ ],
+ 'ExecuteRequestML' => [
+ 'summary' => 'Risk detection interface, which only supports custom event calls and is applicable only in the Malaysian region.',
+ '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' => 'Service input parameters, a JSON formatted string containing complete JSON information. It is necessary to add the `eventCode` attribute for custom events here.',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '{"accountId": "1233***"}',
+ ],
+ ],
+ [
+ 'name' => 'Service',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Service product code. Since this interface only supports custom events, you should fill in `saf_de` here.',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'saf_de',
+ ],
+ ],
+ [
+ 'name' => 'Lang',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ 'default' => 'en-us',
+ 'description' => 'The language of the content within the request and response. Valid values:'."\n"
+ ."\n"
+ .'* **zh**: Chinese (default)'."\n"
+ .'* **en**: English',
+ 'example' => 'en',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'description' => 'Status code.',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Message' => [
+ 'description' => 'Result message.',
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Data' => [
+ 'description' => 'Data information, including fields such as tags, score, extend, etc.',
+ 'type' => 'object',
+ 'example' => '{"score": 80.4, "tags": "ra0601,rnk0002,rn0312"}',
+ ],
+ 'RequestId' => [
+ 'description' => 'Request 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' => 'Invoke Decision Engine for Malaysian Cluster',
+ 'translator' => 'machine',
+ ],
+ 'ExecuteRequestSG' => [
+ 'summary' => 'Risk detection interface, which supports public service calls and custom event calls.',
+ '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' => 'Service input parameters, a JSON formatted string containing the complete JSON information. If it is a custom event, add the `eventCode` attribute here.',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '{"accountId": "1233***"}',
+ ],
+ ],
+ [
+ 'name' => 'Service',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Service product code. For custom events, use `saf_de` here.',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'account_abuse_intl_pro',
+ ],
+ ],
+ [
+ 'name' => 'Lang',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ 'default' => 'en-us',
+ 'description' => 'The language of the content within the request and response. Valid values:'."\n"
+ ."\n"
+ .'* **zh**: Chinese (default)'."\n"
+ .'* **en**: English',
+ 'example' => 'en',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'description' => 'Status code.',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Message' => [
+ 'description' => 'Result message.',
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Data' => [
+ 'description' => 'Data information, including fields such as tags, score, extend, etc.',
+ 'type' => 'object',
+ 'example' => '{"score": 80.4, "tags": "ra0601,rnk0002,rn0312"}',
+ ],
+ 'RequestId' => [
+ 'description' => 'Request 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' => 'Invoke Decision Engine Singapore Cluster',
+ 'translator' => 'machine',
+ ],
+ 'RequestDecision' => [
+ 'summary' => 'Invoke Decision Engine Interface',
+ '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' => 'Service input parameters, a string in JSON format, complete JSON string information.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{"accountId": "1233***"}',
+ ],
+ ],
+ [
+ 'name' => 'EventCode',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Event code.',
+ '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' => 'Request ID.',
+ 'type' => 'string',
+ 'example' => 'A5F41DC6-2070-5CE7-8B2D-7A23D882932D',
+ ],
+ 'Code' => [
+ 'description' => 'Status code.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '200',
+ ],
+ 'Message' => [
+ 'description' => 'Result message.',
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'Data' => [
+ 'description' => 'Data information, including fields such as tags, score, and 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' => 'RequestDecision',
+ 'translator' => 'machine',
+ ],
+ ],
+ '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',
+ ],
+ ],
+];