summaryrefslogtreecommitdiff
path: root/data/en_us/actiontrail/2017-12-04/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/actiontrail/2017-12-04/api-docs.php
downloadacs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.tar.gz
acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.zip
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/actiontrail/2017-12-04/api-docs.php')
-rw-r--r--data/en_us/actiontrail/2017-12-04/api-docs.php1668
1 files changed, 1668 insertions, 0 deletions
diff --git a/data/en_us/actiontrail/2017-12-04/api-docs.php b/data/en_us/actiontrail/2017-12-04/api-docs.php
new file mode 100644
index 0000000..3a274b5
--- /dev/null
+++ b/data/en_us/actiontrail/2017-12-04/api-docs.php
@@ -0,0 +1,1668 @@
+<?php return [
+ 'version' => '1.0',
+ 'info' => [
+ 'style' => 'RPC',
+ 'product' => 'Actiontrail',
+ 'version' => '2017-12-04',
+ ],
+ 'directories' => [
+ [
+ 'id' => 5314,
+ 'title' => 'Region',
+ 'type' => 'directory',
+ 'children' => [
+ 'DescribeRegions',
+ ],
+ ],
+ [
+ 'id' => 5316,
+ 'title' => 'Tracking',
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateTrail',
+ 'DeleteTrail',
+ 'StartLogging',
+ 'StopLogging',
+ 'UpdateTrail',
+ 'DescribeTrails',
+ 'GetTrailStatus',
+ ],
+ ],
+ [
+ 'id' => 5318,
+ 'title' => 'Event',
+ 'type' => 'directory',
+ 'children' => [
+ 'LookupEvents',
+ ],
+ ],
+ ],
+ 'components' => [
+ 'schemas' => [],
+ ],
+ 'apis' => [
+ 'DescribeRegions' => [
+ 'summary' => '查询地域信息',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREactiontrailHCRZJP',
+ ],
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'test',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '4ABAEA6E-C740-5CE2-A003-643E551964F5',
+ ],
+ 'Regions' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Region' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'test',
+ 'type' => 'object',
+ 'properties' => [
+ 'RegionId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'cn-shanghai',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4ABAEA6E-C740-5CE2-A003-643E551964F5\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"RegionId\\": \\"cn-shanghai\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeRegionsResponse>\\n <RequestId>4ABAEA6E-C740-5CE2-A003-643E551964F5</RequestId>\\n <Regions>\\n <Region>\\n <RegionId>cn-hangzhou</RegionId>\\n </Region>\\n <Region>\\n <RegionId>cn-shanghai</RegionId>\\n </Region>\\n <Region>\\n <RegionId>cn-nanjing</RegionId>\\n </Region>\\n <Region>\\n <RegionId>cn-fuzhou</RegionId>\\n </Region>\\n <Region>\\n <RegionId>cn-qingdao</RegionId>\\n </Region>\\n <Region>\\n <RegionId>cn-beijing</RegionId>\\n </Region>\\n <Region>\\n <RegionId>cn-zhangjiakou</RegionId>\\n </Region>\\n <Region>\\n <RegionId>cn-huhehaote</RegionId>\\n </Region>\\n <Region>\\n <RegionId>cn-wulanchabu</RegionId>\\n </Region>\\n <Region>\\n <RegionId>cn-shenzhen</RegionId>\\n </Region>\\n <Region>\\n <RegionId>cn-heyuan</RegionId>\\n </Region>\\n <Region>\\n <RegionId>cn-guangzhou</RegionId>\\n </Region>\\n <Region>\\n <RegionId>cn-chengdu</RegionId>\\n </Region>\\n <Region>\\n <RegionId>cn-hongkong</RegionId>\\n </Region>\\n <Region>\\n <RegionId>ap-southeast-1</RegionId>\\n </Region>\\n <Region>\\n <RegionId>ap-southeast-2</RegionId>\\n </Region>\\n <Region>\\n <RegionId>ap-northeast-2</RegionId>\\n </Region>\\n <Region>\\n <RegionId>ap-southeast-3</RegionId>\\n </Region>\\n <Region>\\n <RegionId>ap-southeast-5</RegionId>\\n </Region>\\n <Region>\\n <RegionId>ap-northeast-1</RegionId>\\n </Region>\\n <Region>\\n <RegionId>eu-central-1</RegionId>\\n </Region>\\n <Region>\\n <RegionId>eu-west-1</RegionId>\\n </Region>\\n <Region>\\n <RegionId>us-west-1</RegionId>\\n </Region>\\n <Region>\\n <RegionId>us-east-1</RegionId>\\n </Region>\\n <Region>\\n <RegionId>me-east-1</RegionId>\\n </Region>\\n <Region>\\n <RegionId>ap-southeast-7</RegionId>\\n </Region>\\n <Region>\\n <RegionId>ap-south-1</RegionId>\\n </Region>\\n </Regions>\\n</DescribeRegionsResponse>","errorExample":""}]',
+ 'title' => 'DescribeRegions',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CreateTrail' => [
+ 'summary' => 'Create Trail',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREactiontrail321LUI',
+ ],
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the trail to be created. '."\n"
+ .'Length should be between 6 and 36 characters, must start with a lowercase letter, and can include lowercase letters, numbers, hyphens (-), and underscores (_).'."\n"
+ .'> The trail name must be unique within the same account.',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'trail-test',
+ ],
+ ],
+ [
+ 'name' => 'OssBucketName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The OSS bucket for the trail delivery. '."\n"
+ .'Length should be between 3 and 63 characters, must start with a lowercase letter or number, and can include lowercase letters, numbers, and hyphens (-). '."\n"
+ ."\n"
+ .'> At least one of OssBucketName and SlsProjectArn must be specified.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'audit-log',
+ ],
+ ],
+ [
+ 'name' => 'OssKeyPrefix',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The prefix for the filenames in the OSS bucket for the trail delivery. '."\n"
+ .'Length should be between 6 and 32 characters, must start with a letter, and can include letters, numbers, hyphens (-), forward slashes (/), and underscores (_).',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'at-product-account-audit-B',
+ ],
+ ],
+ [
+ 'name' => 'RoleName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the associated role for Operation Audit, with a default value of aliyunserviceroleforactiontrail.',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'aliyunserviceroleforactiontrail',
+ ],
+ ],
+ [
+ 'name' => 'SlsProjectArn',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ARN of the Log Service project for the trail delivery. '."\n"
+ ."\n"
+ .'> At least one of OssBucketName and SlsProjectArn must be specified.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'acs:log:cn-shanghai::project/***',
+ ],
+ ],
+ [
+ 'name' => 'SlsWriteRoleArn',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ARN of the role assumed by Operation Audit when delivering operation events to the Log Service project.'."\n"
+ ."\n"
+ .'- If this parameter is not specified, Operation Audit will create the necessary resources by creating a service-linked role. For more information, see [Operation Audit Service-Linked Role](~~169244~~).'."\n"
+ ."\n"
+ .'- If this parameter is specified, when you need to deliver events to the current account, you need to grant the RAM role the permissions of the Operation Audit service-linked role. When you need to deliver events to another account, you need to bind the system permission policy for event delivery to the RAM role. For more information on cross-account delivery, see [Deliver Events from Multiple Alibaba Cloud Accounts to One Account](~~207462~~).',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'acs:ram::***:role/aliyunserviceroleforactiontrail',
+ ],
+ ],
+ [
+ 'name' => 'EventRW',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The read/write type of the delivered events, with values: '."\n"
+ .'- Write (default): Write type. '."\n"
+ .'- Read: Read type. '."\n"
+ .'- All: Both read and write types.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Write',
+ ],
+ ],
+ [
+ 'name' => 'TrailRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region of the trail. '."\n"
+ .'The default value is All, indicating that events from all regions are tracked. '."\n"
+ .'You can also specify a specific region. For more information about regions, call the [DescribeRegions](~~95532~~) API.'."\n"
+ ."\n\n"
+ ."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'All',
+ ],
+ ],
+ [
+ 'name' => 'MnsTopicArn',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ARN of the Message Service (formerly MNS) Topic used to receive Operation Audit events, in the format: `acs:mns:<Region>:<Account ID>:/topics/<topicName>`. After specifying this parameter, a message will be delivered to the MNS Topic when events are delivered to OSS.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'acs:mns:cn-hangzhou:1111:/topics/your-topic-name',
+ ],
+ ],
+ [
+ 'name' => 'IsOrganizationTrail',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Whether to create a multi-account trail. Values: '."\n"
+ ."\n"
+ .'- true: Create a multi-account trail. '."\n"
+ ."\n"
+ .'- false (default): Create a single-account trail.',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'test',
+ 'type' => 'object',
+ 'properties' => [
+ 'MnsTopicArn' => [
+ 'description' => 'The ARN of the MNS Topic used to receive Operation Audit events. ',
+ 'type' => 'string',
+ 'example' => 'acs:mns:cn-hangzhou:1111:/topics/your-topic-name',
+ ],
+ 'SlsProjectArn' => [
+ 'description' => 'The ARN of the Log Service project for the trail delivery.',
+ 'type' => 'string',
+ 'example' => 'acs:log:cn-hangzhou:151266687691****:project/test-project',
+ ],
+ 'RoleName' => [
+ 'description' => 'The name of the associated role for operation audit service.',
+ 'type' => 'string',
+ 'example' => 'aliyunserviceroleforactiontrail',
+ ],
+ 'EventRW' => [
+ 'description' => 'The read/write type of the delivered events.',
+ 'type' => 'string',
+ 'example' => 'Write',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.',
+ 'type' => 'string',
+ 'example' => '145318BE-DEE1-4C57-AA7C-5BE7D34A6AE0',
+ ],
+ 'HomeRegion' => [
+ 'description' => 'The home region of the trail.',
+ 'type' => 'string',
+ 'example' => 'cn-hangzhou',
+ ],
+ 'OssKeyPrefix' => [
+ 'description' => 'The prefix of the file name in the OSS bucket.',
+ 'type' => 'string',
+ 'example' => 'at-product-account-audit-B',
+ ],
+ 'OssBucketName' => [
+ 'description' => 'The OSS bucket.',
+ 'type' => 'string',
+ 'example' => 'audit-log',
+ ],
+ 'SlsWriteRoleArn' => [
+ 'description' => 'The ARN of the role assumed when delivering operation events to the Log Service project.',
+ 'type' => 'string',
+ 'example' => 'acs:ram::***:role/aliyunserviceroleforactiontrail',
+ ],
+ 'TrailRegion' => [
+ 'description' => 'The region of the trail.',
+ 'type' => 'string',
+ 'example' => 'All',
+ ],
+ 'Name' => [
+ 'description' => 'The name of the trail.',
+ 'type' => 'string',
+ 'example' => 'trail-test',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InvalidDeliveryConfigurationException',
+ 'errorMessage' => 'You must specify at least one Log Service project or OSS bucket for a Trail.',
+ ],
+ [
+ 'errorCode' => 'InvalidPrefixException',
+ 'errorMessage' => 'The specified OSS bucket prefix is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidQueryParameter',
+ 'errorMessage' => 'The specified query parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidTrailNameException',
+ 'errorMessage' => 'The specified Trail name is invalid.',
+ ],
+ [
+ 'errorCode' => 'RepeatOssBucket',
+ 'errorMessage' => 'The specified OSS bucket is already in use. We recommend that you modify the existing Trail or specify another bucket.',
+ ],
+ [
+ 'errorCode' => 'SlsProjectDoesNotExistException',
+ 'errorMessage' => 'The specified Log Service project does not exist.',
+ ],
+ [
+ 'errorCode' => 'TrailAlreadyExistsException',
+ 'errorMessage' => 'The specified Trail name already exists.',
+ ],
+ [
+ 'errorCode' => 'MaximumNumberOfOrganizationTrailExceeded',
+ 'errorMessage' => 'Your account can create only one organization trail.',
+ ],
+ [
+ 'errorCode' => 'NotAllowCreateOrganizationTrail',
+ 'errorMessage' => 'Your account does not allow you to create organization trail. Submit a ticket to get customer support.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'InsufficientBucketPolicyException',
+ 'errorMessage' => 'Access to the specified OSS bucket was denied.',
+ ],
+ [
+ 'errorCode' => 'InsufficientSlsPolicyException',
+ 'errorMessage' => 'Access to the specified Log Service project was denied.',
+ ],
+ [
+ 'errorCode' => 'MaximumNumberOfTrailsExceededException',
+ 'errorMessage' => 'The number of Trails in the same region exceeds the upper limit (5).',
+ ],
+ ],
+ [
+ [
+ 'errorCode' => 'BucketDoesNotExistException',
+ 'errorMessage' => 'The specified OSS bucket does not exist.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"MnsTopicArn\\": \\"acs:mns:cn-hangzhou:1111:/topics/your-topic-name\\",\\n \\"SlsProjectArn\\": \\"acs:log:cn-hangzhou:151266687691****:project/test-project\\",\\n \\"RoleName\\": \\"aliyunserviceroleforactiontrail\\",\\n \\"EventRW\\": \\"Write\\",\\n \\"RequestId\\": \\"145318BE-DEE1-4C57-AA7C-5BE7D34A6AE0\\",\\n \\"HomeRegion\\": \\"cn-hangzhou\\",\\n \\"OssKeyPrefix\\": \\"at-product-account-audit-B\\",\\n \\"OssBucketName\\": \\"audit-log\\",\\n \\"SlsWriteRoleArn\\": \\"acs:ram::***:role/aliyunserviceroleforactiontrail\\",\\n \\"TrailRegion\\": \\"All\\",\\n \\"Name\\": \\"trail-test\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateTrailResponse>\\n <RoleName>aliyunserviceroleforactiontrail</RoleName>\\n <EventRW>Write</EventRW>\\n <RequestId>AB7A5AE1-EC3C-4C00-91B0-BE7BDEE354AE</RequestId>\\n <HomeRegion>cn-hangzhou</HomeRegion>\\n <OssBucketName>audit-log</OssBucketName>\\n <TrailRegion>All</TrailRegion>\\n <Name>trail-test</Name>\\n</CreateTrailResponse>","errorExample":""}]',
+ 'title' => 'Create Trail',
+ 'description' => 'You can create a trail to deliver operation events to Log Service (SLS) or Object Storage Service (OSS), or both. Before creating a trail, please perform the following operations: '."\n"
+ ."\n"
+ .'- Deliver to Log Service (SLS): Ensure that you have created an SLS Project. '."\n"
+ .'> After successful delivery, Operation Audit will automatically create a logstore named `actiontrail_<trail_name>`, which will automatically set up the best audit configurations, create required indexes and dashboards for queries, and prohibit user writes to ensure the accuracy of audit data. You do not need to create the logstore in advance.'."\n"
+ ."\n"
+ .'- Deliver to Object Storage Service (OSS): Ensure that you have created an OSS bucket.'."\n"
+ ."\n"
+ .'This document provides an example to help you create a single-account trail named `trail-test` and deliver operation events to an OSS bucket named `audit-log`.',
+ 'requestParamsDescription' => 'For details about common request parameters, see [Common Parameters](~~28837~~).',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'translator' => 'machine',
+ ],
+ 'DeleteTrail' => [
+ 'summary' => '删除跟踪',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREactiontrail321LUI',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'my-test',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'test',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '145318BE-DEE1-4C57-AA7C-5BE7D34A6AE0',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 404 => [
+ [
+ 'errorCode' => 'TrailNotFoundException',
+ 'errorMessage' => 'The specified Trail does not exist.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"145318BE-DEE1-4C57-AA7C-5BE7D34A6AE0\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'DeleteTrail',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'StartLogging' => [
+ 'summary' => '开启跟踪',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREactiontrail321LUI',
+ 'FEATUREactiontrailK0OCFQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'trail-test',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'test',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '145318BE-DEE1-4C57-AA7C-5BE7D34A6AE0',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 404 => [
+ [
+ 'errorCode' => 'TrailNotFoundException',
+ 'errorMessage' => 'The specified Trail does not exist.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"145318BE-DEE1-4C57-AA7C-5BE7D34A6AE0\\"\\n}","errorExample":""},{"type":"xml","example":"<StartLoggingResponse>\\n <RequestId>1C488B66-B819-4D14-8711-C4EAAA13AC01</RequestId>\\n</StartLoggingResponse>","errorExample":""}]',
+ 'title' => 'StartLogging',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'StopLogging' => [
+ 'summary' => '关闭跟踪',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREactiontrailHCRZJP',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'trail-test',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'test',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '145318BE-DEE1-4C57-AA7C-5BE7D34A6AE0',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 404 => [
+ [
+ 'errorCode' => 'TrailNotFoundException',
+ 'errorMessage' => 'The specified Trail does not exist.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"145318BE-DEE1-4C57-AA7C-5BE7D34A6AE0\\"\\n}","errorExample":""},{"type":"xml","example":"<StopLoggingResponse>\\n <RequestId>1C488B66-B819-4D14-8711-C4EAAA13AC01</RequestId>\\n</StopLoggingResponse>","errorExample":""}]',
+ 'title' => 'StopLogging',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateTrail' => [
+ 'summary' => '修改跟踪配置',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREactiontrail321LUI',
+ 'FEATUREactiontrailK0OCFQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'trail-test',
+ ],
+ ],
+ [
+ 'name' => 'OssBucketName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'audit-log',
+ ],
+ ],
+ [
+ 'name' => 'OssKeyPrefix',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'at-product-account-audit-B',
+ ],
+ ],
+ [
+ 'name' => 'RoleName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'aliyunserviceroleforactiontrail',
+ ],
+ ],
+ [
+ 'name' => 'SlsProjectArn',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'acs:log:cn-hangzhou:159498693826****:project/trail-test',
+ ],
+ ],
+ [
+ 'name' => 'SlsWriteRoleArn',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'acs:ram::159498693826****:role/aliyunserviceroleforactiontrail',
+ ],
+ ],
+ [
+ 'name' => 'EventRW',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'All',
+ ],
+ ],
+ [
+ 'name' => 'TrailRegion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'All',
+ ],
+ ],
+ [
+ 'name' => 'MnsTopicArn',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'acs:mns:cn-hangzhou:1111:/topics/your-topic-name',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'test',
+ 'type' => 'object',
+ 'properties' => [
+ 'MnsTopicArn' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'acs:mns:cn-hangzhou:1111:/topics/your-topic-name',
+ ],
+ 'SlsProjectArn' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'acs:log:cn-hangzhou:159498693826****:project/trail-test',
+ ],
+ 'RoleName' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'aliyunserviceroleforactiontrail',
+ ],
+ 'EventRW' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'All',
+ ],
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '145318BE-DEE1-4C57-AA7C-5BE7D34A6AE0',
+ ],
+ 'HomeRegion' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'cn-hangzhou',
+ ],
+ 'OssKeyPrefix' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'at-product-account-audit-B',
+ ],
+ 'OssBucketName' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'audit-log',
+ ],
+ 'SlsWriteRoleArn' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'acs:ram::159498693826****:role/aliyunserviceroleforactiontrail',
+ ],
+ 'TrailRegion' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'All',
+ ],
+ 'Name' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'trail-test',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'RepeatOssBucket',
+ 'errorMessage' => 'The specified OSS bucket is already in use. We recommend that you modify the existing Trail or specify another bucket.',
+ ],
+ [
+ 'errorCode' => 'SlsProjectDoesNotExistException',
+ 'errorMessage' => 'The specified Log Service project does not exist.',
+ ],
+ [
+ 'errorCode' => 'IncompleteSignature',
+ 'errorMessage' => 'The request signature does not conform to Alibaba Cloud standards.',
+ ],
+ [
+ 'errorCode' => 'InvalidDeliveryConfigurationException',
+ 'errorMessage' => 'You must specify at least one Log Service project or OSS bucket for a Trail.',
+ ],
+ [
+ 'errorCode' => 'InvalidPrefixException',
+ 'errorMessage' => 'The specified OSS bucket prefix is invalid.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'InsufficientBucketPolicyException',
+ 'errorMessage' => 'Access to the specified OSS bucket was denied.',
+ ],
+ [
+ 'errorCode' => 'InsufficientSlsPolicyException',
+ 'errorMessage' => 'Access to the specified Log Service project was denied.',
+ ],
+ ],
+ [
+ [
+ 'errorCode' => 'TrailNotFoundException',
+ 'errorMessage' => 'The specified Trail does not exist.',
+ ],
+ [
+ 'errorCode' => 'BucketDoesNotExistException',
+ 'errorMessage' => 'The specified OSS bucket does not exist.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"MnsTopicArn\\": \\"acs:mns:cn-hangzhou:1111:/topics/your-topic-name\\",\\n \\"SlsProjectArn\\": \\"acs:log:cn-hangzhou:159498693826****:project/trail-test\\",\\n \\"RoleName\\": \\"aliyunserviceroleforactiontrail\\",\\n \\"EventRW\\": \\"All\\",\\n \\"RequestId\\": \\"145318BE-DEE1-4C57-AA7C-5BE7D34A6AE0\\",\\n \\"HomeRegion\\": \\"cn-hangzhou\\",\\n \\"OssKeyPrefix\\": \\"at-product-account-audit-B\\",\\n \\"OssBucketName\\": \\"audit-log\\",\\n \\"SlsWriteRoleArn\\": \\"acs:ram::159498693826****:role/aliyunserviceroleforactiontrail\\",\\n \\"TrailRegion\\": \\"All\\",\\n \\"Name\\": \\"trail-test\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateTrailResponse>\\n <SlsProjectArn>acs:log:cn-hangzhou:159498693826****:project/trail-test</SlsProjectArn>\\n <RoleName>aliyunserviceroleforactiontrail</RoleName>\\n <EventRW>All</EventRW>\\n <RequestId>145318BE-DEE1-4C57-AA7C-5BE7D34A6AE0</RequestId>\\n <HomeRegion>cn-hangzhou</HomeRegion>\\n <OssBucketName>audit-log</OssBucketName>\\n <SlsWriteRoleArn>acs:ram::159498693826****:role/aliyunserviceroleforactiontrail</SlsWriteRoleArn>\\n <TrailRegion>All</TrailRegion>\\n <Name>trail-test</Name>\\n</UpdateTrailResponse>","errorExample":""}]',
+ 'title' => 'UpdateTrail',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DescribeTrails' => [
+ 'summary' => 'Queries created trails.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREactiontrailHCRZJP',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'IncludeShadowTrails',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to return shadow trails. Valid values:'."\n"
+ ."\n"
+ .'* false (default)'."\n"
+ .'* true'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'NameList',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The trails to query. Separate the names of multiple trails with commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'audit-log,trail-test2',
+ ],
+ ],
+ [
+ 'name' => 'IncludeOrganizationTrail',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to query multi-account trails. Valid values:'."\n"
+ ."\n"
+ .'* true: queries multi-account trails.'."\n"
+ .'* false (default): does not query multi-account trails. Only single-account trails are queried.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ 'default' => 'true',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'test'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '10313D41-C40A-4D53-ACA0-0190334DF81C',
+ ],
+ 'TrailList' => [
+ 'description' => 'The trails.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'test'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TrailRegion' => [
+ 'description' => 'The region in which the trail delivers events. Valid values:'."\n"
+ ."\n"
+ .'* All (default): delivers events in all regions.'."\n"
+ .'* cn-hangzhou: delivers events only in the China (Hangzhou) region.'."\n"
+ .'* cn-beijing: delivers events only in the China (Beijing) region.'."\n",
+ 'type' => 'string',
+ 'example' => 'All',
+ ],
+ 'Status' => [
+ 'description' => 'The status of the trail. Valid values:'."\n"
+ ."\n"
+ .'* Disable: disabled.'."\n"
+ .'* Enable: enabled.'."\n"
+ .'* Fresh: The trail was created but was not enabled.'."\n",
+ 'type' => 'string',
+ 'example' => 'Enable',
+ ],
+ 'UpdateTime' => [
+ 'description' => 'The most recent time when the configuration of the trail was updated.'."\n",
+ 'type' => 'string',
+ 'example' => '1619407012000',
+ ],
+ 'HomeRegion' => [
+ 'description' => 'The home region of the trail.'."\n",
+ 'type' => 'string',
+ 'example' => 'cn-hangzhou',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the trail was created.'."\n",
+ 'type' => 'string',
+ 'example' => '1614580048000',
+ ],
+ 'OssKeyPrefix' => [
+ 'description' => 'The prefix of the log files stored in the Object Storage Service (OSS) bucket.'."\n",
+ 'type' => 'string',
+ 'example' => 'trail1',
+ ],
+ 'EventRW' => [
+ 'description' => 'The read/write type of the events that are delivered. Valid values:'."\n"
+ ."\n"
+ .'* Write (default): write events.'."\n"
+ .'* Read: read events.'."\n"
+ .'* All: read and write events.'."\n",
+ 'type' => 'string',
+ 'example' => 'Write',
+ ],
+ 'StartLoggingTime' => [
+ 'description' => 'The time when the trail was last enabled.'."\n",
+ 'type' => 'string',
+ 'example' => '1619407012000',
+ ],
+ 'MnsTopicArn' => [
+ 'description' => 'The Alibaba Cloud Resource Name (ARN) of the Message Service (MNS) topic to which ActionTrail sends messages. The ARN is in the `acs:mns:<Region>:<Account ID>:/topics/<Topic name>` format. If the ARN is specified, a message is generated and sent to the MNS topic whenever an event is delivered to OSS.'."\n",
+ 'type' => 'string',
+ 'example' => 'acs:mns:cn-hangzhou:1111:/topics/your-topic-name',
+ ],
+ 'RoleName' => [
+ 'description' => 'The name of the Resource Access Management (RAM) role that is assumed by ActionTrail.'."\n",
+ 'type' => 'string',
+ 'example' => 'aliyunactiontraildefaultrole',
+ ],
+ 'SlsProjectArn' => [
+ 'description' => 'The unique ARN of the Log Service project to which events are delivered.'."\n",
+ 'type' => 'string',
+ 'example' => 'acs:log:cn-hangzhou:159498693826****:project/alice-audit-log',
+ ],
+ 'IsOrganizationTrail' => [
+ 'description' => 'Indicates whether the trail is a multi-account trail. Valid values:'."\n"
+ ."\n"
+ .'* false (default)'."\n"
+ .'* true'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'SlsWriteRoleArn' => [
+ 'description' => 'The unique ARN of the role that is assumed by ActionTrail to deliver log files to the Log Service project.'."\n",
+ 'type' => 'string',
+ 'example' => 'acs:ram::159498693826****:role/aliyunserviceroleforactiontrail',
+ ],
+ 'StopLoggingTime' => [
+ 'description' => 'The time when the trail was last disabled.'."\n",
+ 'type' => 'string',
+ 'example' => '1617674944000',
+ ],
+ 'Name' => [
+ 'description' => 'The name of the trail.'."\n",
+ 'type' => 'string',
+ 'example' => 'test-4',
+ ],
+ 'OssBucketName' => [
+ 'description' => 'The name of the OSS bucket.'."\n",
+ 'type' => 'string',
+ 'example' => 'secloud',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InvalidTrailNameException',
+ 'errorMessage' => 'The specified Trail name is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidQueryParameter',
+ 'errorMessage' => 'The specified query parameter is invalid.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"10313D41-C40A-4D53-ACA0-0190334DF81C\\",\\n \\"TrailList\\": [\\n {\\n \\"TrailRegion\\": \\"All\\",\\n \\"Status\\": \\"Enable\\",\\n \\"UpdateTime\\": \\"1619407012000\\",\\n \\"HomeRegion\\": \\"cn-hangzhou\\",\\n \\"CreateTime\\": \\"1614580048000\\",\\n \\"OssKeyPrefix\\": \\"trail1\\",\\n \\"EventRW\\": \\"Write\\",\\n \\"StartLoggingTime\\": \\"1619407012000\\",\\n \\"MnsTopicArn\\": \\"acs:mns:cn-hangzhou:1111:/topics/your-topic-name\\",\\n \\"RoleName\\": \\"aliyunactiontraildefaultrole\\",\\n \\"SlsProjectArn\\": \\"acs:log:cn-hangzhou:159498693826****:project/alice-audit-log\\",\\n \\"IsOrganizationTrail\\": false,\\n \\"SlsWriteRoleArn\\": \\"acs:ram::159498693826****:role/aliyunserviceroleforactiontrail\\",\\n \\"StopLoggingTime\\": \\"1617674944000\\",\\n \\"Name\\": \\"test-4\\",\\n \\"OssBucketName\\": \\"secloud\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeTrailsResponse>\\n <RequestId>10313D41-C40A-4D53-ACA0-0190334DF81C</RequestId>\\n <TrailList>\\n <Status>Enable</Status>\\n <MnsTopicArn>acs:mns:cn-hangzhou:1111:/topics/your-topic-name</MnsTopicArn>\\n <HomeRegion>cn-hangzhou</HomeRegion>\\n <StartLoggingTime>1619407012000</StartLoggingTime>\\n <CreateTime>1614580048000</CreateTime>\\n <StopLoggingTime>1617674944000</StopLoggingTime>\\n <SlsWriteRoleArn>acs:ram::159498693826****:role/aliyunserviceroleforactiontrail</SlsWriteRoleArn>\\n <TrailRegion>All</TrailRegion>\\n <Name>test-4</Name>\\n <IsOrganizationTrail>false</IsOrganizationTrail>\\n <SlsProjectArn>acs:log:cn-hangzhou:159498693826****:project/alice-audit-log</SlsProjectArn>\\n <RoleName>aliyunactiontraildefaultrole</RoleName>\\n <EventRW>Write</EventRW>\\n <UpdateTime>1619407012000</UpdateTime>\\n <OssKeyPrefix>trail1</OssKeyPrefix>\\n <OssBucketName>secloud</OssBucketName>\\n </TrailList>\\n</DescribeTrailsResponse>","errorExample":""}]',
+ 'title' => 'DescribeTrails',
+ 'description' => 'This topic provides an example on how to call the API operation to query single-account trails that are created within the current Alibaba Cloud account. The returned result shows that only one trail named `test-4` is created within the Alibaba Cloud account.'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetTrailStatus' => [
+ 'summary' => 'Queries a trail\'s status.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREactiontrail321LUI',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the trail.\\'."\n"
+ .'The name must be 6 to 36 characters in length and can contain lowercase letters, digits, hyphens (-), and underscores (\\_). It must start with a lowercase letter.'."\n"
+ ."\n"
+ .'> The name must be unique within an Alibaba Cloud account.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'trail-test',
+ ],
+ ],
+ [
+ 'name' => 'IsOrganizationTrail',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to query the status of a multi-account trail. Valid values:'."\n"
+ ."\n"
+ .'* true: queries the status of a multi-account trail.'."\n"
+ .'* false (default): queries the status of a single-account trail.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'test'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '8FFD2DE7-74F0-4582-A4CB-BF6523FEF06C',
+ ],
+ 'StartLoggingTime' => [
+ 'description' => 'The time when the trail was last enabled.'."\n",
+ 'type' => 'string',
+ 'example' => '2021-03-31T04:06:41Z',
+ ],
+ 'LatestDeliveryError' => [
+ 'description' => 'The log of the last failed delivery.'."\n",
+ 'type' => 'string',
+ 'example' => 'write sls failed, exception: the parent of sub user must be project owner, itemscount: 1',
+ ],
+ 'StopLoggingTime' => [
+ 'description' => 'The time when the trail was last disabled.'."\n",
+ 'type' => 'string',
+ 'example' => '2021-04-02T02:36:56Z',
+ ],
+ 'IsLogging' => [
+ 'description' => 'Indicates whether logging is enabled for the trail.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'LatestDeliveryTime' => [
+ 'description' => 'The most recent time when an event was delivered by the trail.'."\n",
+ 'type' => 'string',
+ 'example' => '1547792223000',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 404 => [
+ [
+ 'errorCode' => 'TrailNotFoundException',
+ 'errorMessage' => 'The specified Trail does not exist.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8FFD2DE7-74F0-4582-A4CB-BF6523FEF06C\\",\\n \\"StartLoggingTime\\": \\"2021-03-31T04:06:41Z\\",\\n \\"LatestDeliveryError\\": \\"write sls failed, exception: the parent of sub user must be project owner, itemscount: 1\\",\\n \\"StopLoggingTime\\": \\"2021-04-02T02:36:56Z\\",\\n \\"IsLogging\\": false,\\n \\"LatestDeliveryTime\\": \\"1547792223000\\"\\n}","errorExample":""},{"type":"xml","example":"<GetTrailStatusResponse>\\n <RequestId>8FFD2DE7-74F0-4582-A4CB-BF6523FEF06C</RequestId>\\n <StartLoggingTime>2021-03-31T04:06:41Z</StartLoggingTime>\\n <LatestDeliveryError>write sls failed, exception: the parent of sub user must be project owner, itemscount: 1</LatestDeliveryError>\\n <StopLoggingTime>2021-04-02T02:36:56Z</StopLoggingTime>\\n <IsLogging>false</IsLogging>\\n</GetTrailStatusResponse>","errorExample":""}]',
+ 'title' => 'GetTrailStatus',
+ 'description' => 'This topic describes how to query the status of a sample trail named `trail-test`.'."\n",
+ 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~28837~~).'."\n",
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'LookupEvents' => [
+ 'summary' => 'Retrieve Events',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREactiontrailHCRZJP',
+ ],
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Event',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Event ID.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'AD9CD9DA-EC2D-4EB7-A817-C0442A94****',
+ ],
+ ],
+ [
+ 'name' => 'Request',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Request ID.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'AD9CD9DA-EC2D-4EB7-A817-C0442A94****',
+ ],
+ ],
+ [
+ 'name' => 'EventType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Event type, with values:'."\n"
+ ."\n"
+ .'- ApiCall: API call event.'."\n"
+ ."\n"
+ .'- ConsoleOperation: Console operation event.'."\n"
+ ."\n"
+ .'- AliyunServiceEvent: Alibaba Cloud service event. '."\n"
+ ."\n"
+ .'- PasswordReset: Password reset event. '."\n"
+ ."\n"
+ .'- ConsoleSignin: Console login event. '."\n"
+ ."\n"
+ .'- ConsoleSignout: Console logout event.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ConsoleSignin',
+ ],
+ ],
+ [
+ 'name' => 'ServiceName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Cloud service name.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'AsaSub',
+ ],
+ ],
+ [
+ 'name' => 'EventName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Event name.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ConsoleSignin',
+ ],
+ ],
+ [
+ 'name' => 'User',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Caller name, i.e., RAM user.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'yanjie.wyj',
+ ],
+ ],
+ [
+ 'name' => 'ResourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Resource type.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Instance',
+ ],
+ ],
+ [
+ 'name' => 'ResourceName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Resource name.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'i-bp14664y88udkt45****',
+ ],
+ ],
+ [
+ 'name' => 'EventRW',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Read-write type of the request event, with values: '."\n"
+ ."\n"
+ .'- Read: Read type. '."\n"
+ ."\n"
+ .'- Write (default): Write type. '."\n"
+ ."\n"
+ .'- All: Both read and write types.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Write',
+ ],
+ ],
+ [
+ 'name' => 'EventAccessKeyId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'AccessKey ID of the event to be retrieved.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'LTAI****************',
+ ],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Used to request the next page of retrieval results.'."\n"
+ .'> The request parameters must be consistent with the previous request.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '20',
+ ],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Maximum number of results allowed to return. '."\n"
+ .'Range: 0~50.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '20',
+ ],
+ ],
+ [
+ 'name' => 'StartTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Start time for retrieving events, defaulting to 7 days before the current time. The date format follows the ISO8601 standard and uses UTC time. Format: `YYYY-MM-DDThh:mm:ssZ`.'."\n"
+ .'> Supports event retrieval within the last 90 days, with a span not exceeding 30 days.'."\n"
+ ."\n\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2020-06-15T14:00:00Z',
+ ],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'End time for retrieving events, defaulting to the current time. The date format follows the ISO8601 standard and uses UTC time. Format: `YYYY-MM-DDThh:mm:ssZ`.'."\n"
+ .'> Supports event retrieval within the last 90 days, with a span not exceeding 30 days.'."\n"
+ ."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2020-06-22T14:00:00Z',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'test',
+ 'type' => 'object',
+ 'properties' => [
+ 'EndTime' => [
+ 'description' => 'End time of the retrieved events.',
+ 'type' => 'string',
+ 'example' => '2020-07-22T14:00:00Z',
+ ],
+ 'NextToken' => [
+ 'description' => 'Returns the next page of retrieval results.'."\n"
+ .'> If there are no more results, this field is not returned.',
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ 'RequestId' => [
+ 'description' => 'Request ID.',
+ 'type' => 'string',
+ 'example' => 'FD79665A-CE8B-49D4-82E6-5EE2E0E791DD',
+ ],
+ 'Events' => [
+ 'description' => 'test',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'List of retrieved events.',
+ 'type' => 'object',
+ 'example' => 'AD9CD9DA-EC2D-4EB7-A817-C0442A94****',
+ ],
+ ],
+ 'StartTime' => [
+ 'description' => 'Start time of the retrieved events.',
+ 'type' => 'string',
+ 'example' => '2020-07-15T14:00:00Z',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'IncompleteSignature',
+ 'errorMessage' => 'The request signature does not conform to Alibaba Cloud standards.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameterCombination',
+ 'errorMessage' => 'The end time must be later than the start time.',
+ ],
+ [
+ 'errorCode' => 'InvalidQueryParameter',
+ 'errorMessage' => 'The specified query parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameterDateOutOfRange',
+ 'errorMessage' => 'Query time range exceeds 30 days.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameterEndTime',
+ 'errorMessage' => 'The specified EndTime is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameterStartTime',
+ 'errorMessage' => 'The specified StartTime is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameterStartTimeExceedsCurrent',
+ 'errorMessage' => 'The StartTime exceeds the current time. Use GMT time format for queries.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameterStartTimeOutOfDate',
+ 'errorMessage' => 'The StartTime exceeds the limit of 90 days.',
+ ],
+ [
+ 'errorCode' => 'InvalidTimeRangeException',
+ 'errorMessage' => 'The end time must be later than the start time. The time span cannot exceed 30 days.',
+ ],
+ ],
+ 404 => [
+ [
+ 'errorCode' => 'InvalidAction',
+ 'errorMessage' => 'The specified action is invalid.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2020-07-22T14:00:00Z\\",\\n \\"NextToken\\": \\"1\\",\\n \\"RequestId\\": \\"FD79665A-CE8B-49D4-82E6-5EE2E0E791DD\\",\\n \\"Events\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"StartTime\\": \\"2020-07-15T14:00:00Z\\"\\n}","errorExample":""},{"type":"xml","example":"<LookupEventsResponse>\\n <RequestId>AB6843AF-C07E-4B59-BBF8-A0CEB785E6A2</RequestId>\\n <NextToken>2</NextToken>\\n <EndTime>2020-11-26T01:30:39Z</EndTime>\\n <Events>\\n <eventId>96.227_1606286128938_****</eventId>\\n <eventVersion>1</eventVersion>\\n <errorMessage>success</errorMessage>\\n <eventSource>signin.aliyun.com</eventSource>\\n <sourceIpAddress>42.120.XX.XX</sourceIpAddress>\\n <userAgent>Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/73.0.3683.86 Safari/537.36</userAgent>\\n <eventType>ConsoleSignin</eventType>\\n <userIdentity>\\n <accountId>159498693826****</accountId>\\n <principalId>24611178745315****</principalId>\\n <type>ram-user</type>\\n <userName>alice</userName>\\n </userIdentity>\\n <serviceName>AasSub</serviceName>\\n <additionalEventData>\\n <callbackUrl>https://api.aliyun.com/new?spm=a2c1g.8271268.10000.9.2d59df259iBwq1</callbackUrl>\\n <mfaChecked>false</mfaChecked>\\n </additionalEventData>\\n <requestId>96.227_1606286128938_2847</requestId>\\n <eventTime>2020-11-25T06:35:29Z</eventTime>\\n <acsRegion>cn-hangzhou</acsRegion>\\n <eventName>ConsoleSignin</eventName>\\n </Events>\\n <Events>\\n <eventId>132.20_1606132532480_****</eventId>\\n <eventVersion>1</eventVersion>\\n <errorMessage>success</errorMessage>\\n <eventSource>signin.aliyun.com</eventSource>\\n <sourceIpAddress>42.120.XX.XX</sourceIpAddress>\\n <userAgent>Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.75 Safari/537.36</userAgent>\\n <eventType>ConsoleSignin</eventType>\\n <userIdentity>\\n <accountId>159498693826****</accountId>\\n <principalId>26855899827085****</principalId>\\n <type>ram-user</type>\\n <userName>yuge.****</userName>\\n </userIdentity>\\n <serviceName>AasSub</serviceName>\\n <additionalEventData>\\n <callbackUrl>https://home.console.aliyun.com/</callbackUrl>\\n <mfaChecked>false</mfaChecked>\\n </additionalEventData>\\n <requestId>132.20_1606132532480_7292</requestId>\\n <eventTime>2020-11-23T11:55:32Z</eventTime>\\n <acsRegion>cn-hangzhou</acsRegion>\\n <eventName>ConsoleSignin</eventName>\\n </Events>\\n <StartTime>2020-11-19T01:31:09Z</StartTime>\\n</LookupEventsResponse>","errorExample":""}]',
+ 'title' => 'Retrieve Detailed Historical Events',
+ 'description' => 'When using LookupEvents to retrieve historical events, the maximum number of calls per second is two.'."\n"
+ .'Note: Do not call this interface frequently. You can create a trail to deliver events to Log Service SLS and use SLS\'s real-time consumption feature for near-real-time retrieval of historical events.'."\n"
+ .'For specific operations, see [Create Single-Account Trail](~~28810~~), [Create Multi-Account Trail](~~160661~~), and [Real-Time Consumption](~~28997~~).'."\n"
+ ."\n"
+ .'> This interface (2017-12-04 version API LookupEvents) will be deprecated. It is recommended to use the 2020-07-06 version API. For more information, see [LookupEvents](~~185722~~).',
+ 'requestParamsDescription' => 'For the description of subfields within Event, see [Operation Event Structure Definition](~~28819~~).',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'translator' => 'machine',
+ ],
+ ],
+ 'endpoints' => [
+ [
+ 'regionId' => 'ap-northeast-2-pop',
+ 'endpoint' => 'actiontrail.ap-northeast-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-beijing-finance-pop',
+ 'endpoint' => 'actiontrail.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-beijing-gov-1',
+ 'endpoint' => 'actiontrail.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-beijing-nu16-b01',
+ 'endpoint' => 'actiontrail.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-edge-1',
+ 'endpoint' => 'actiontrail.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-fujian',
+ 'endpoint' => 'actiontrail.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-haidian-cm12-c01',
+ 'endpoint' => 'actiontrail.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hangzhou-bj-b01',
+ 'endpoint' => 'actiontrail.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hangzhou-internal-prod-1',
+ 'endpoint' => 'actiontrail.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hangzhou-internal-test-1',
+ 'endpoint' => 'actiontrail.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hangzhou-internal-test-2',
+ 'endpoint' => 'actiontrail.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hangzhou-internal-test-3',
+ 'endpoint' => 'actiontrail.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hangzhou-test-306',
+ 'endpoint' => 'actiontrail.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hongkong-finance-pop',
+ 'endpoint' => 'actiontrail.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-qingdao-nebula',
+ 'endpoint' => 'actiontrail.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shanghai-et15-b01',
+ 'endpoint' => 'actiontrail.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shanghai-et2-b01',
+ 'endpoint' => 'actiontrail.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shanghai-inner',
+ 'endpoint' => 'actiontrail.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shanghai-internal-test-1',
+ 'endpoint' => 'actiontrail.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shenzhen-inner',
+ 'endpoint' => 'actiontrail.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shenzhen-st4-d01',
+ 'endpoint' => 'actiontrail.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shenzhen-su18-b01',
+ 'endpoint' => 'actiontrail.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-wuhan',
+ 'endpoint' => 'actiontrail.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-yushanfang',
+ 'endpoint' => 'actiontrail.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-zhangbei-na61-b01',
+ 'endpoint' => 'actiontrail.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-zhangjiakou-na62-a01',
+ 'endpoint' => 'actiontrail.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-zhengzhou-nebula-1',
+ 'endpoint' => 'actiontrail.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'eu-west-1-oxs',
+ 'endpoint' => 'actiontrail.ap-northeast-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'rus-west-1-pop',
+ 'endpoint' => 'actiontrail.ap-northeast-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-qingdao',
+ 'endpoint' => 'actiontrail.cn-qingdao.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-beijing',
+ 'endpoint' => 'actiontrail.cn-beijing.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-chengdu',
+ 'endpoint' => 'actiontrail.cn-chengdu.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-zhangjiakou',
+ 'endpoint' => 'actiontrail.cn-zhangjiakou.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-huhehaote',
+ 'endpoint' => 'actiontrail.cn-huhehaote.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hangzhou',
+ 'endpoint' => 'actiontrail.cn-hangzhou.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shanghai',
+ 'endpoint' => 'actiontrail.cn-shanghai.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shenzhen',
+ 'endpoint' => 'actiontrail.cn-shenzhen.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hongkong',
+ 'endpoint' => 'actiontrail.cn-hongkong.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-southeast-1',
+ 'endpoint' => 'actiontrail.ap-southeast-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-southeast-3',
+ 'endpoint' => 'actiontrail.ap-southeast-3.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-southeast-5',
+ 'endpoint' => 'actiontrail.ap-southeast-5.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-northeast-1',
+ 'endpoint' => 'actiontrail.ap-northeast-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'eu-west-1',
+ 'endpoint' => 'actiontrail.eu-west-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'us-west-1',
+ 'endpoint' => 'actiontrail.us-west-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'us-east-1',
+ 'endpoint' => 'actiontrail.us-east-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'eu-central-1',
+ 'endpoint' => 'actiontrail.eu-central-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'me-east-1',
+ 'endpoint' => 'actiontrail.me-east-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shanghai-finance-1',
+ 'endpoint' => 'actiontrail.cn-shanghai-finance-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-north-2-gov-1',
+ 'endpoint' => 'actiontrail.cn-north-2-gov-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-wulanchabu',
+ 'endpoint' => 'actiontrail.cn-wulanchabu.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-nanjing',
+ 'endpoint' => 'actiontrail.cn-nanjing.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-heyuan',
+ 'endpoint' => 'actiontrail.cn-heyuan.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-guangzhou',
+ 'endpoint' => 'actiontrail.cn-guangzhou.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-northeast-2',
+ 'endpoint' => 'actiontrail.ap-northeast-2.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-southeast-7',
+ 'endpoint' => 'actiontrail.ap-southeast-7.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'na-south-1',
+ 'endpoint' => 'actiontrail.na-south-1.aliyuncs.com',
+ ],
+ ],
+];
generated by cgit v1.2.3 (git 2.46.0) at 2026-03-07 14:32:49 +0000