DescribeControlPolicy - Cloud Firewall: Central de Documentação do Alibaba Cloud

Obtém informações sobre todas as políticas de controle de acesso.

Descrição da operação

Esta operação realiza uma consulta paginada para obter informações sobre políticas de controle de acesso.

Limite de QPS

O limite de consultas por segundo (QPS) para esta operação é de 10 para um único usuário. Se você exceder esse limite, as chamadas de API serão limitadas. Isso pode afetar seus negócios. Planeje suas chamadas de acordo.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

yundun-cloudfirewall:DescribeControlPolicy

get

*ControlPolicyOrder

acs:cloudfirewall::{#accountId}:controlpolicy/{#AclUuid}/controlpolicyorder/{#Direction}

*ControlPolicy

acs:cloudfirewall::{#accountId}:controlpolicy/{#AclUuid}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Lang	string	Não	O idioma da mensagem de resposta. Valores válidos: zh (padrão): Chinês en: Inglês	zh
Lang	string	Não	O idioma da mensagem de resposta. Valores válidos: zh (padrão): Chinês en: Inglês	zh
Direction	string	Não	A direção do tráfego controlada pela política de controle de acesso. Valores válidos: in: Tráfego de entrada de uma origem externa para um destino interno. out: Tráfego de saída de uma origem interna para um destino externo. Valores válidos: in : Tráfego de entrada de uma origem externa para um destino interno. out : Tráfego de saída de uma origem interna para um destino externo.	in
CurrentPage	string	Sim	O número da página a ser retornada. Valor padrão: 1.	1
PageSize	string	Sim	O número de entradas a serem retornadas em cada página.	10
Source	string	Não	O endereço de origem na política de controle de acesso. Consultas aproximadas são suportadas. O valor deste parâmetro varia com base no valor do parâmetro `SourceType`. Se `SourceType` for `net`, o valor deste parâmetro é um bloco CIDR. Exemplo: 192.0.XX.XX/24. Se `SourceType` for `group`, o valor deste parâmetro é o nome de um catálogo de endereços de origem. Exemplo: `db\_group`. Se você deixar este parâmetro vazio, todos os endereços de origem serão consultados. Se `SourceType` for `location`, o valor deste parâmetro é uma região de origem. Exemplo: `Beijing` ou `beijing`. Você pode usar o nome em chinês ou em inglês para a consulta. Nota Se você não definir este parâmetro, todos os tipos de endereços de origem serão consultados.	192.0.XX.XX
Destination	string	Não	O endereço de destino na política de controle de acesso. Consultas aproximadas são suportadas. O valor deste parâmetro varia com base no valor do parâmetro `DestinationType`. Se `DestinationType` for `net`, o valor deste parâmetro é um bloco CIDR. Exemplo: 10.0.3.0/24. Se `DestinationType` for `domain`, o valor deste parâmetro é um nome de domínio. Exemplo: aliyun. Se `DestinationType` for `group`, o valor deste parâmetro é o nome de um catálogo de endereços. Exemplo: db_group. Se `DestinationType` for `location`, o valor deste parâmetro é um nome de região. Para mais informações sobre os códigos de região, consulte AddControlPolicy. Exemplo: `["BJ11", "ZB"]`. Nota Se você não definir este parâmetro, todos os tipos de endereços de destino serão consultados.	192.0.XX.XX
Description	string	Não	A descrição da política de controle de acesso. Consultas aproximadas são suportadas. Nota Se você não definir este parâmetro, as descrições de todas as políticas serão consultadas.	test
Proto	string	Não	O tipo de protocolo do tráfego na política de controle de acesso. Valores válidos: TCP UDP ICMP ANY (todos os tipos de protocolo) Nota Se você não definir este parâmetro, todos os tipos de protocolo serão consultados.	TCP
AclAction	string	Não	A ação que o Cloud Firewall executa no tráfego. Valores válidos: accept: Permitir drop: Negar log: Monitorar Nota Se você não definir este parâmetro, todos os tipos de ação serão consultados.	accept
Release	string	Não	O status da política de controle de acesso. Valores válidos: true: A política de controle de acesso está ativada. false: A política de controle de acesso está desativada.	true
AclUuid	string	Não	O ID exclusivo da política de controle de acesso.	00281255-d220-4db1-8f4f-c4df221a****
IpVersion	string	Não	A versão de IP suportada. Valores válidos: 4 (padrão): Endereço IPv4 6: Endereço IPv6 Valores válidos: 4 : IPv4 6 : IPv6	6
RepeatType	string	Não	O tipo de recorrência para o período de validade da política de controle de acesso. Valores válidos: Permanent (padrão): Sempre None: Uma vez Daily: Diariamente Weekly: Semanalmente Monthly: Mensalmente Valores válidos: Daily : Diariamente. Monthly : Mensalmente. Permanent : Sempre. Weekly : Semanalmente. None : Uma vez.	Permanent

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
PageNo	string	O número da página retornada.	1
PageSize	string	O número de entradas retornadas por página.	10
RequestId	string	O ID da solicitação.	CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2****
TotalCount	string	O número total de políticas de controle de acesso.	100
Policys	array<object>	As informações sobre as políticas de controle de acesso.
	object	Os detalhes da política de controle de acesso.
Direction	string	A direção do tráfego da política de controle de acesso. Valores válidos: in: tráfego de entrada out: tráfego de saída	in
Order	integer	A prioridade da política de controle de acesso. O valor de prioridade começa em 1 e aumenta sequencialmente. Um valor menor indica uma prioridade maior.	1
SourceType	string	O tipo de endereço de origem na política de controle de acesso. Valores válidos: net: bloco CIDR de origem group: catálogo de endereços de origem location: região de origem	net
ApplicationName	string	O tipo de aplicativo suportado pela política de controle de acesso. Use `ApplicationNameList` em vez disso. Valores válidos: FTP HTTP HTTPS Memcache MongoDB MQTT MySQL RDP Redis SMTP SMTPS SSH SSL VNC ANY (todos os tipos de aplicativo)	HTTP
HitTimes	integer	O número de acertos da política de controle de acesso.	100
Description	string	A descrição da política de controle de acesso.	test
SourceGroupType	string	O tipo do catálogo de endereços de origem na política de controle de acesso. Valores válidos: ip: Um catálogo de endereços IP que contém um ou mais blocos CIDR. tag: Um catálogo de endereços baseado em tags de ECS que contém os endereços IP das instâncias ECS com uma ou mais tags. domain: Um catálogo de endereços de nomes de domínio que contém um ou mais nomes de domínio. threat: Um catálogo de endereços de inteligência contra ameaças que contém um ou mais endereços IP ou nomes de domínio maliciosos. backsrc: Um catálogo de endereços de URL de origem que contém as URLs de origem de uma ou mais instâncias Anti-DDoS ou WAF.	ip
DnsResultTime	integer	O carimbo de data/hora da resolução de DNS. O valor é um carimbo de data/hora UNIX. Unidade: segundos.	1579261141
DnsResult `deprecated`	string	O resultado da resolução de DNS.	192.0.XX.XX,192.0.XX.XX
Proto	string	O tipo de protocolo do tráfego na política de controle de acesso. Valores válidos: ANY TCP UDP ICMP	TCP
DestinationGroupType	string	O tipo do catálogo de endereços de destino na política de controle de acesso. Valores válidos: ip: Um catálogo de endereços IP que contém um ou mais blocos CIDR. tag: Um catálogo de endereços baseado em tags de ECS que contém os endereços IP das instâncias ECS com uma ou mais tags. domain: Um catálogo de endereços de nomes de domínio que contém um ou mais nomes de domínio. threat: Um catálogo de endereços de inteligência contra ameaças que contém um ou mais endereços IP ou nomes de domínio maliciosos. backsrc: Um catálogo de endereços de URL de origem que contém as URLs de origem de uma ou mais instâncias Anti-DDoS ou WAF.	ip
Destination	string	O endereço de destino na política de controle de acesso. O valor deste parâmetro varia com base no valor do parâmetro `DestinationType`. Valores válidos: Se DestinationType for net, o endereço de destino é um bloco CIDR. Exemplo: 192.0.XX.XX/24. Se DestinationType for domain, o endereço de destino é um nome de domínio. Exemplo: aliyuncs.com. Se DestinationType for group, o endereço de destino é o nome de um catálogo de endereços. Exemplo: db_group. Se DestinationType for location, o endereço de destino é um nome de região. Para mais informações sobre os códigos de região, consulte AddControlPolicy. Exemplo: ["BJ11", "ZB"].	192.0.XX.XX/24
HitLastTime	integer	O carimbo de data/hora do último acerto. O valor é um carimbo de data/hora UNIX. Unidade: segundos.	1579261141
DestPortGroup	string	O nome do catálogo de endereços de porta de destino para o tráfego na política de controle de acesso.	my_port_group
AclUuid	string	O ID exclusivo da política de controle de acesso.	00281255-d220-4db1-8f4f-c4df221a****
DestPortType	string	O tipo de porta de destino para o tráfego na política de controle de acesso. Valores válidos: port: porta group: catálogo de endereços de porta	port
Source	string	O endereço de origem na política de controle de acesso. Valores válidos: Se SourceType for `net`, o endereço de origem é um bloco CIDR. Exemplo: 192.0.XX.XX/24. Se SourceType for `group`, o endereço de origem é o nome de um catálogo de endereços de origem. Exemplo: db_group. Se SourceType for `location`, o endereço de origem é uma região. Para mais informações sobre os códigos de região, consulte AddControlPolicy. Exemplo: ["BJ11", "ZB"].	192.0.XX.XX/24
DestinationType	string	O tipo de endereço de destino na política de controle de acesso. Valores válidos: net: bloco CIDR de destino group: catálogo de endereços de destino domain: nome de domínio de destino location: região de destino	net
DestPort	string	A porta de destino para o tráfego na política de controle de acesso.	80
IpVersion	integer	A versão de IP suportada. Valores válidos: 4: Endereço IPv4 6: Endereço IPv6	6
AclAction	string	A ação que o Cloud Firewall executa no tráfego. Valores válidos: accept: Permitir drop: Negar log: Monitorar	accept
Release	string	O status da política de controle de acesso. A política é ativada por padrão após ser criada. Valores válidos: true: A política de controle de acesso está ativada. false: A política de controle de acesso está desativada.	true
ApplicationId	string	O ID do aplicativo para o tráfego na política de controle de acesso.	10***
DestinationGroupCidrs	array	A lista de blocos CIDR no catálogo de endereços de destino da política de controle de acesso.
	string	O bloco CIDR no catálogo de endereços de destino da política de controle de acesso.	192.0.XX.XX/24
DestPortGroupPorts	array	A lista de portas no catálogo de endereços de porta de destino.
	string	A porta no catálogo de endereços de porta de destino.	80/80
SourceGroupCidrs	array	A lista de blocos CIDR no catálogo de endereços de origem da política de controle de acesso.
	string	O bloco CIDR no catálogo de endereços de origem da política de controle de acesso.	192.0.XX.XX/24
ApplicationNameList	array	A lista de nomes de aplicativos.
	string	A lista de tipos de aplicativo suportados pela política de controle de acesso. Valores válidos: FTP HTTP HTTPS Memcache MongoDB MQTT MySQL RDP Redis SMTP SMTPS SSH SSL VNC ANY (todos os tipos de aplicativo)	HTTP
SpreadCnt	integer	O número de entradas de especificação que a política de controle de acesso consome. Esta é a soma das entradas consumidas por cada política. O número de entradas para uma única política é calculado como: Número de endereços de origem (blocos CIDR ou regiões) × Número de endereços de destino (blocos CIDR, regiões ou nomes de domínio) × Número de intervalos de portas × Número de aplicativos.	10000
CreateTime	integer	A hora em que a política foi criada. O valor é um carimbo de data/hora UNIX. Unidade: segundos.	1761062400
ModifyTime	integer	A hora em que a política foi modificada pela última vez. O valor é um carimbo de data/hora UNIX. Unidade: segundos.	1761062400
RepeatType	string	O tipo de recorrência para o período de validade da política de controle de acesso. Valores válidos: Permanent (padrão): Sempre None: Uma vez Daily: Diariamente Weekly: Semanalmente Monthly: Mensalmente Valores válidos: Daily : Diariamente. Monthly : Mensalmente. Permanent : Sempre. Weekly : Semanalmente. None : Uma vez.	Permanent
RepeatDays	array	A coleção de datas recorrentes para o período de validade da política de controle de acesso. Se `RepeatType` for `Permanent`, `None` ou `Daily`, `RepeatDays` é uma coleção vazia. Exemplo: [] Se `RepeatType` for `Weekly`, `RepeatDays` não pode estar vazio. Exemplo: [0, 6] Nota Se `RepeatType` estiver definido como `Weekly`, `RepeatDays` não pode conter valores duplicados. Se `RepeatType` for `Monthly`, `RepeatDays` não pode estar vazio. Exemplo: [1, 31] Nota Se `RepeatType` estiver definido como `Monthly`, `RepeatDays` não pode conter valores duplicados.
	integer	A data recorrente para o período de validade da política de controle de acesso. Nota Se `RepeatType` estiver definido como `Weekly`, o intervalo de valores é de 0 a 6. A semana começa no domingo. Se `RepeatType` estiver definido como `Monthly`, o intervalo de valores é de 1 a 31.	1
RepeatStartTime	string	A hora de início recorrente para o período de validade da política de controle de acesso. Exemplo: `08:00`. A hora deve ser na hora cheia ou na meia hora, e pelo menos 30 minutos antes da hora de término recorrente. Nota Se `RepeatType` for `Permanent` ou `None`, `RepeatStartTime` estará vazio. Se `RepeatType` for `Daily`, `Weekly` ou `Monthly`, este parâmetro é obrigatório. A hora está no formato HH:mm (24 horas). Exemplos: `08:00` e `23:30`.	08:00
RepeatEndTime	string	A hora de término recorrente para o período de validade da política de controle de acesso. Exemplo: `23:30`. A hora deve ser na hora cheia ou na meia hora, e pelo menos 30 minutos depois da hora de início recorrente. Nota Se `RepeatType` for `Permanent` ou `None`, `RepeatEndTime` estará vazio. Se `RepeatType` for `Daily`, `Weekly` ou `Monthly`, este parâmetro é obrigatório. A hora está no formato HH:mm (24 horas). Exemplos: `08:00` e `23:30`.	23:30
StartTime	integer	A hora de início do período de validade da política de controle de acesso. O valor é um carimbo de data/hora UNIX. A hora deve ser na hora cheia ou na meia hora, e pelo menos 30 minutos antes da hora de término. Nota Se `RepeatType` for `Permanent`, `StartTime` estará vazio. Se `RepeatType` for `None`, `Daily`, `Weekly` ou `Monthly`, este parâmetro é obrigatório.	1694761200
EndTime	integer	A hora de término do período de validade da política de controle de acesso. O valor é um carimbo de data/hora UNIX. A hora deve ser na hora cheia ou na meia hora, e pelo menos 30 minutos depois da hora de início. Nota Se `RepeatType` for `Permanent`, `EndTime` estará vazio. Se `RepeatType` for `None`, `Daily`, `Weekly` ou `Monthly`, este parâmetro é obrigatório.	1694764800
DomainResolveType	string	O método de resolução de nome de domínio da política de controle de acesso. Valores válidos: FQDN: Baseado em FQDN DNS: Resolução dinâmica baseada em DNS FQDN_AND_DNS: Resolução dinâmica baseada em FQDN e DNS	FQDN

Exemplos

Resposta de sucesso

JSON formato

{
  "PageNo": "1",
  "PageSize": "10",
  "RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2****",
  "TotalCount": "100",
  "Policys": [
    {
      "Direction": "in",
      "Order": 1,
      "SourceType": "net",
      "ApplicationName": "HTTP",
      "HitTimes": 100,
      "Description": "test",
      "SourceGroupType": "ip",
      "DnsResultTime": 1579261141,
      "DnsResult": "192.0.XX.XX,192.0.XX.XX",
      "Proto": "TCP",
      "DestinationGroupType": "ip",
      "Destination": "192.0.XX.XX/24",
      "HitLastTime": 1579261141,
      "DestPortGroup": "my_port_group",
      "AclUuid": "00281255-d220-4db1-8f4f-c4df221a****",
      "DestPortType": "port",
      "Source": "192.0.XX.XX/24",
      "DestinationType": "net",
      "DestPort": "80",
      "IpVersion": 6,
      "AclAction": "accept",
      "Release": "true",
      "ApplicationId": "10***",
      "DestinationGroupCidrs": [
        "192.0.XX.XX/24"
      ],
      "DestPortGroupPorts": [
        "80/80"
      ],
      "SourceGroupCidrs": [
        "192.0.XX.XX/24"
      ],
      "ApplicationNameList": [
        "HTTP"
      ],
      "SpreadCnt": 10000,
      "CreateTime": 1761062400,
      "ModifyTime": 1761062400,
      "RepeatType": "Permanent",
      "RepeatDays": [
        1
      ],
      "RepeatStartTime": "08:00",
      "RepeatEndTime": "23:30",
      "StartTime": 1694761200,
      "EndTime": 1694764800,
      "DomainResolveType": "FQDN"
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	ErrorParametersUid	The aliUid parameter is invalid.	The aliUid parameter is invalid.
400	ErrorParametersPageSizeOrNo	Either pageSize or pageNo is invalid.	Either pageSize or pageNo is invalid.
400	ErrorParameterIpVersion	The IP version is invalid.	The IP version is invalid.
400	ErrorParametersDirection	The direction is invalid.	The direction is invalid.
400	ErrorDBSelect	An error occurred while querying database.	An error occurred while querying database.
400	ErrorUnmarshalJSON	An error occurred while parsing JSON.	An error occurred while decoding JSON.
400	ErrorUUIDNew	The UUID is invalid.	The UUID is invalid.
400	ErrorParametersAppId	The AppId parameter is incorrect.	The AppId parameter is invalid.
400	ErrorParametersSource	The source is invalid.	The source is invalid.
400	ErrorDomainResolve	An error occurred while resolving the domain.	An error occurred while resolving the domain.
400	ErrorParametersDestination	The Destination parameter is invalid.	The Destination parameter is invalid.
400	ErrorParametersProto	The protocol is invalid.	The protocol is invalid.
400	ErrorParametersDestPort	The dst_port is invalid.	The dst_port is invalid.
400	ErrorParametersAction	The action is invalid.	The action is invalid.
400	ErrorParameters	Parameters error.	Parameter error.
400	ErrorMarshalJSON	An error occurred while encoding JSON.	An error occurred while encoding JSON.
400	ErrorParametersAclUuid	Specified parameter AclUuid is not valid.	Specified parameter AclUuid is not valid.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.