Lista as regras de coleta de logs dos serviços da Alibaba Cloud.
Descrição da operação
Esta operação de API está disponível apenas nos endpoints das seguintes regiões: China (Shanghai), Singapura e Heyuan Automotive Compliance Cloud (cn-heyuan-acdr-1).
Experimente agora
Testar
Autorização RAM
Sintaxe da solicitação
GET /collectionpolicy HTTP/1.1
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| productCode |
string |
Não |
O código do serviço da Alibaba Cloud. |
oss |
| dataCode |
string |
Não |
O código do tipo de log. |
access_log |
| policyName |
string |
Não |
O nome da regra de coleta. |
your_log_policy |
| size |
integer |
Não |
O número de regras de coleta a serem retornadas em cada página. Valor padrão: 50. Valor máximo: 100. |
50 |
| offset |
integer |
Não |
A linha a partir da qual a consulta começa. Valor padrão: 0. |
0 |
| instanceId |
string |
Não |
O ID da instância. Especifique este parâmetro para consultar regras que correspondam a uma instância específica. Se você usar este parâmetro, também deverá especificar productCode e dataCode. |
your-test-bucket1 |
| centralProject |
string |
Não |
O projeto de destino para o envio centralizado de dados. Especifique este parâmetro para consultar o número de regras configuradas para enviar dados para este projeto. |
your-central-project1 |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
O corpo da resposta. |
||
| totalCount |
integer |
O número total de regras de coleta. |
1 |
| currentCount |
integer |
O número de regras de coleta retornadas na página atual. |
1 |
| data |
array<object> |
As regras de coleta retornadas na página atual. |
|
|
array<object> |
Os detalhes da regra de coleta. |
||
| productCode |
string |
O código do serviço da Alibaba Cloud. |
oss |
| dataCode |
string |
O código do tipo de log. |
access_log |
| policyName |
string |
O nome da regra de coleta. |
your_log_policy |
| enabled |
boolean |
Indica se a regra de coleta está ativada. |
true |
| policyConfig |
object |
A configuração da regra de coleta. |
|
| resourceMode |
string |
The resource collection mode. |
all |
| regions |
array |
The regions to which the instances belong. |
|
|
string |
The region ID. |
cn-hangzhou |
|
| instanceIds |
array |
The IDs of the instances. |
|
|
string |
The instance ID. |
your-test-bucket1 |
|
| resourceTags |
object |
The resource tags. |
{"tag1":"value1","tag2":"value2"} |
| centralizeEnabled |
boolean |
Indica se o envio centralizado de dados está ativado. |
false |
| centralizeConfig |
object |
A configuração para o envio centralizado de dados. |
|
| destRegion |
string |
The destination region for centralized data shipping. |
cn-beijing |
| destProject |
string |
The destination project for centralized data shipping. |
your-sls-project-in-beijing |
| destLogstore |
string |
The destination Logstore for centralized data shipping. |
your-sls-logstore-in-beijing |
| destTTL |
integer |
The data retention period of the destination Logstore for centralized data shipping. Unit: days. |
0 |
| resourceDirectory |
object |
A configuração do diretório de recursos. Este parâmetro estará vazio se nenhuma configuração estiver disponível. |
|
| accountGroupType |
string |
The mode for selecting accounts in the resource directory. Valid values: all and custom. |
all,custom |
| members |
array |
The list of member accounts. This parameter is returned only if accountGroupType is set to custom. |
|
|
string |
The ID of the Alibaba Cloud account. |
165***********50 |
|
| dataConfig |
object |
Configurações para tipos de log globais, como sls. Este parâmetro estará vazio para outros tipos de log. |
|
| dataRegion |
string |
The region where global logs are first collected. This parameter is used only for global log types, such as sls. |
cn-hangzhou |
| dataProject |
string |
The project for global logs. This parameter is used only for global log types, such as sls. If this parameter is empty, logs are collected to the default project of the account in the region specified by dataRegion. |
"" |
| internalPolicy |
boolean |
Indica se a política é uma política integrada. Políticas integradas não podem ser modificadas ou excluídas. |
false |
| policyUid |
string |
O ID da conta da Alibaba Cloud que possui a regra de coleta. Se um administrador do diretório de recursos ou um administrador delegado criar a regra, este será o ID da conta desse administrador. |
148***********50 |
| statistics |
array<object> |
Estatísticas retornadas com base nas condições de consulta. |
|
|
array<object> |
Estatísticas das regras de coleta, agrupadas por productCode. |
||
| productCode |
string |
O código do serviço da Alibaba Cloud. |
oss |
| policySourceList |
array<object> |
A lista de origens das regras de coleta. |
|
|
object |
A origem da regra de coleta. |
||
| policyUid |
string |
The ID of the Alibaba Cloud account that owns the collection rule. If a resource directory administrator or delegated administrator creates the rule, this is the ID of that administrator's account. |
148***********50 |
| policyName |
string |
The name of the collection rule. |
policy_name1_from148 |
Exemplos
Resposta de sucesso
JSON formato
{
"totalCount": 1,
"currentCount": 1,
"data": [
{
"productCode": "oss",
"dataCode": "access_log",
"policyName": "your_log_policy",
"enabled": true,
"policyConfig": {
"resourceMode": "all",
"regions": [
"cn-hangzhou"
],
"instanceIds": [
"your-test-bucket1\n"
],
"resourceTags": {
"tag1": "value1",
"tag2": "value2"
}
},
"centralizeEnabled": false,
"centralizeConfig": {
"destRegion": "cn-beijing\n",
"destProject": "your-sls-project-in-beijing\n",
"destLogstore": "your-sls-logstore-in-beijing\n",
"destTTL": 0
},
"resourceDirectory": {
"accountGroupType": "all,custom",
"members": [
"165***********50"
]
},
"dataConfig": {
"dataRegion": "cn-hangzhou",
"dataProject": "\"\""
},
"internalPolicy": false,
"policyUid": "148***********50"
}
],
"statistics": [
{
"productCode": "oss",
"policySourceList": [
{
"policyUid": "148***********50",
"policyName": "policy_name1_from148"
}
]
}
]
}
Códigos de erro
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.