DescribeTrails - Query trails in a region - ActionTrail: Central de Documentação do Alibaba Cloud

O exemplo a seguir consulta trilhas de conta única na conta atual do Alibaba Cloud. A resposta exibe uma trilha chamada test-4.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Execute esta operação no OpenAPI Explorer para gerar amostras de código SDK automaticamente.

Parâmetros de solicitação

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeTrails	A operação a ser executada. Defina este parâmetro como DescribeTrails.
IncludeShadowTrails	Boolean	No	true	Especifica se as trilhas sombra devem ser retornadas. Valores válidos: false (padrão): não retorna trilhas sombra. true: retorna trilhas sombra.
NameList	String	No	audit-log,trail-test2	Nomes das trilhas a consultar. Separe vários nomes com vírgulas (,).
IncludeOrganizationTrail	Boolean	No	false	Indica se trilhas de múltiplas contas devem ser consultadas. Valores válidos: true: consulta trilhas de múltiplas contas. false (padrão): consulta apenas trilhas de conta única.

Parâmetros de resposta

Parameter	Type	Example	Description
RequestId	String	10313D41-C40A-4D53-ACA0-0190334DF81C	ID da solicitação.
TrailList	Array of TrailList		Lista de trilhas retornada.
TrailRegion	String	All	Região onde a trilha entrega eventos. Valores válidos: All (padrão): todas as regiões. cn-hangzhou: apenas China (Hangzhou). cn-beijing: apenas China (Pequim).
Status	String	Enable	Status da trilha. Valores válidos: Disable: desativada. Enable: ativada. Fresh: criada, mas ainda não ativada.
UpdateTime	String	1619407012000	Última atualização da configuração da trilha.
HomeRegion	String	cn-hangzhou	Região de origem da trilha.
CreateTime	String	1614580048000	Momento de criação da trilha.
OssKeyPrefix	String	trail1	Prefixo dos arquivos de log armazenados no bucket do OSS.
EventRW	String	Write	Tipo de eventos entregues. Valores válidos: Write (padrão): eventos de escrita. Read: eventos de leitura. All: eventos de leitura e escrita.
StartLoggingTime	String	1619407012000	Momento em que a trilha foi ativada pela última vez.
MnsTopicArn	String	acs:mns:cn-hangzhou:1111:/topics/your-topic-name	ARN do tópico do Message Service (MNS) que recebe notificações do ActionTrail. Formato: `acs:mns:<Region>:<Account ID>:/topics/<Topic name>`. Quando especificado, uma mensagem é enviada a este tópico MNS sempre que um evento é entregue ao OSS.
RoleName	String	aliyunactiontraildefaultrole	Função RAM assumida pelo ActionTrail.
SlsProjectArn	String	acs:log:cn-hangzhou:159498693826****:project/alice-audit-log	ARN do projeto do Log Service para o qual os eventos são entregues.
IsOrganizationTrail	Boolean	false	Indica se a trilha é de múltiplas contas. Valores válidos: false (padrão): trilha de conta única. true: trilha de múltiplas contas.
SlsWriteRoleArn	String	acs:ram::159498693826****:role/aliyunserviceroleforactiontrail	ARN da função assumida pelo ActionTrail para entregar logs ao projeto do Log Service.
StopLoggingTime	String	1617674944000	Momento em que a trilha foi desativada pela última vez.
Name	String	test-4	Nome da trilha.
OssBucketName	String	secloud	Bucket do OSS para o qual os eventos são entregues.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=DescribeTrails
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeTrailsResponse>
    <RequestId>10313D41-C40A-4D53-ACA0-0190334DF81C</RequestId>
    <TrailList>
        <Status>Enable</Status>
        <MnsTopicArn>acs:mns:cn-hangzhou:1111:/topics/your-topic-name</MnsTopicArn>
        <HomeRegion>cn-hangzhou</HomeRegion>
        <StartLoggingTime>1619407012000</StartLoggingTime>
        <CreateTime>1614580048000</CreateTime>
        <StopLoggingTime>1617674944000</StopLoggingTime>
        <SlsWriteRoleArn>acs:ram::159498693826****:role/aliyunserviceroleforactiontrail</SlsWriteRoleArn>
        <TrailRegion>All</TrailRegion>
        <Name>test-4</Name>
        <IsOrganizationTrail>false</IsOrganizationTrail>
        <SlsProjectArn>acs:log:cn-hangzhou:159498693826****:project/alice-audit-log</SlsProjectArn>
        <RoleName>aliyunactiontraildefaultrole</RoleName>
        <EventRW>Write</EventRW>
        <UpdateTime>1619407012000</UpdateTime>
        <OssKeyPrefix>trail1</OssKeyPrefix>
        <OssBucketName>secloud</OssBucketName>
    </TrailList>
</DescribeTrailsResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "10313D41-C40A-4D53-ACA0-0190334DF81C",
  "TrailList" : [ {
    "Status" : "Enable",
    "MnsTopicArn" : "acs:mns:cn-hangzhou:1111:/topics/your-topic-name",
    "HomeRegion" : "cn-hangzhou",
    "StartLoggingTime" : 1619407012000,
    "CreateTime" : 1614580048000,
    "StopLoggingTime" : 1617674944000,
    "SlsWriteRoleArn" : "acs:ram::159498693826****:role/aliyunserviceroleforactiontrail",
    "TrailRegion" : "All",
    "Name" : "test-4",
    "IsOrganizationTrail" : false,
    "SlsProjectArn" : "acs:log:cn-hangzhou:159498693826****:project/alice-audit-log",
    "RoleName" : "aliyunactiontraildefaultrole",
    "EventRW" : "Write",
    "UpdateTime" : 1619407012000,
    "OssKeyPrefix" : "trail1",
    "OssBucketName" : "secloud"
  } ]
}

Códigos de erro

HTTP status code	Error code	Error message	Description
400	InvalidTrailNameException	The specified Trail name is invalid.	O nome da trilha especificado é inválido. Utilize um nome de trilha válido.
400	InvalidQueryParameter	The specified query parameter is invalid.	Um ou mais parâmetros de solicitação são inválidos.

Para obter uma lista de códigos de erro, visite o API Error Center.