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 é normalmente usada para consulta paginada de informações de políticas de controle de acesso.

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 tipo de idioma para recebimento de mensagens. Valores válidos:	zh
Direction	string	Não	A direção do tráfego controlada pela política de controle de acesso. Valores válidos: in (entrada) ou out (saída). Você deve especificar pelo menos um dos parâmetros Direction ou AclUuid. Se AclUuid não for especificado, você deve especificar um valor não vazio para Direction. Caso contrário, o erro ErrorParametersDirection será retornado. Valores válidos: in : Inbound, que indica tráfego de fontes externas para recursos internos. out : Outbound, que indica tráfego de recursos internos para destinos externos.	in
CurrentPage	string	Sim	O número da página atual exibida em uma consulta paginada.	1
PageSize	string	Sim	O número máximo de entradas por página exibidas em uma consulta paginada.	10
Source	string	Não	O endereço de origem na política de controle de acesso. Consultas difusas são suportadas. O valor varia dependendo do SourceType (tipo de origem).	192.0.XX.XX
Destination	string	Não	O endereço de destino na política de controle de acesso. Consultas difusas são suportadas. O valor varia dependendo do DestinationType (tipo de destino).	192.0.XX.XX
Description	string	Não	A descrição da política de controle de acesso. Consultas difusas são suportadas.	Permitir acesso ao segmento de rede do escritório
Proto	string	Não	O tipo de protocolo do tráfego na política de controle de acesso. Valores válidos:	TCP
AclAction	string	Não	A ação que o Cloud Firewall executa no tráfego da política de controle de acesso. Valores válidos:	accept
Release	string	Não	O status de ativação da política de controle de acesso. Valores válidos:	true
AclUuid	string	Não	O ID exclusivo da política de controle de acesso. Você deve especificar pelo menos um dos parâmetros AclUuid ou Direction. Se AclUuid for especificado, você poderá consultar a política pelo seu ID.	00281255-d220-4db1-8f4f-c4df221a****
IpVersion	string	Não	A versão do endereço IP suportada. Valores válidos: Valores válidos: 4 : IPv4 6 : IPv6	6
RepeatType	string	Não	O tipo de recorrência do período de validade da política de controle de acesso. Valores válidos: Valores válidos: Daily : todos os dias. Monthly : todos os meses. Permanent : sempre. Weekly : todas as semanas. None : um período único especificado.	Permanent

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
PageNo	string	O número da página atual exibida em uma consulta paginada.	1
PageSize	string	O número máximo de entradas por página exibidas em uma consulta paginada.	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
Order	integer	A prioridade da política de controle de acesso.	1
SourceType	string	O tipo do endereço de origem na política de controle de acesso. Valores válidos:	net
ApplicationName	string	O tipo de aplicativo suportado pela política de controle de acesso. Recomendamos o uso de ApplicationNameList. Valores válidos:	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.	Permitir acesso ao segmento de rede do escritório
SourceGroupType	string	O tipo do catálogo de endereços de origem na política de controle de acesso. Valores válidos:	ip
DnsResultTime	integer	O timestamp da resolução DNS. O valor é um timestamp UNIX em segundos.	1579261141
DnsResult `deprecated`	string	O resultado da resolução DNS.	192.0.XX.XX,192.0.XX.XX
Proto	string	O tipo de protocolo de segurança do tráfego na política de controle de acesso. Valores válidos:	TCP
DestinationGroupType	string	O tipo do catálogo de endereços de destino na política de controle de acesso. Valores válidos:	ip
Destination	string	O endereço de destino na política de controle de acesso. O valor varia dependendo do DestinationType (tipo de destino). Valores válidos:	192.0.XX.XX/24
HitLastTime	integer	A hora mais recente de acertos. O valor está no formato de timestamp UNIX em segundos.	1579261141
DestPortGroup	string	O nome do catálogo de portas de destino 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 da porta de destino na política de controle de acesso. Valores válidos:	port
Source	string	O endereço de origem na política de controle de acesso. Valores válidos:	192.0.XX.XX/24
DestinationType	string	O tipo do endereço de destino na política de controle de acesso. Valores válidos:	net
DestPort	string	A porta de destino do tráfego na política de controle de acesso.	80
IpVersion	integer	A versão do endereço IP suportada. Valores válidos:	6
AclAction	string	A ação que o Cloud Firewall executa no tráfego da política de controle de acesso. Valores válidos:	accept
Release	string	O status de ativação da política de controle de acesso. A política é ativada por padrão após a criação. Valores válidos:	true
ApplicationId	string	O ID do aplicativo do 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 portas de destino.
	string	A porta no catálogo de portas 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 aplicativos suportados pela política de controle de acesso. Valores válidos:	HTTP
SpreadCnt	integer	O número de unidades de cota consumidas pela política de controle de acesso, que corresponde ao número acumulado de unidades de cota consumidas por cada política.	10000
CreateTime	integer	A hora em que a política foi criada. O valor é um timestamp UNIX em segundos, que representa o número de segundos decorridos desde 1º de janeiro de 1970 (UTC).	1761062400
ModifyTime	integer	A hora em que a política foi modificada pela última vez. O valor é um timestamp UNIX em segundos, que representa o número de segundos decorridos desde 1º de janeiro de 1970 (UTC).	1761062400
RepeatType	string	O tipo de recorrência do período de validade da política de controle de acesso. Valores válidos: Valores válidos: Daily : todos os dias. Monthly : todos os meses. Permanent : sempre. Weekly : todas as semanas. None : um período único especificado.	Permanent
RepeatDays	array	A coleção de dias de recorrência para o período de validade da política de controle de acesso.
	integer	O dia de recorrência para o período de validade da política de controle de acesso.	1
RepeatStartTime	string	A hora de início da recorrência do período de validade da política de controle de acesso. Exemplo: 08:00. O valor deve ser na hora cheia ou na meia-hora e deve ser pelo menos 30 minutos anterior à hora de término da recorrência.	08:00
RepeatEndTime	string	A hora de término da recorrência do período de validade da política de controle de acesso. Exemplo: 23:30. O valor deve ser na hora cheia ou na meia-hora e deve ser pelo menos 30 minutos posterior à hora de início da recorrência.	23:30
StartTime	integer	A hora de início do período de validade da política de controle de acesso. O valor é um timestamp UNIX em segundos. O valor deve ser na hora cheia ou na meia-hora e deve ser pelo menos 30 minutos anterior à hora de término.	1694761200
EndTime	integer	A hora de término do período de validade da política de controle de acesso. O valor é um timestamp UNIX em segundos. O valor deve ser na hora cheia ou na meia-hora e deve ser pelo menos 30 minutos posterior à hora de início.	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

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
400	ErrorParametersUid	The aliUid parameter is invalid.
400	ErrorParametersPageSizeOrNo	Either pageSize or pageNo is invalid.
400	ErrorParameterIpVersion	The IP version is invalid.
400	ErrorParametersDirection	The direction is invalid.
400	ErrorDBSelect	An error occurred while querying database.
400	ErrorUnmarshalJSON	An error occurred while parsing JSON.
400	ErrorUUIDNew	The UUID is invalid.
400	ErrorParametersAppId	The AppId parameter is incorrect.
400	ErrorParametersSource	The source is invalid.
400	ErrorDomainResolve	An error occurred while resolving the domain.
400	ErrorParametersDestination	The Destination parameter is invalid.
400	ErrorParametersProto	The protocol is invalid.
400	ErrorParametersDestPort	The dst_port is invalid.
400	ErrorParametersAction	The action is invalid.
400	ErrorParameters	Parameters error.
400	ErrorMarshalJSON	An error occurred while encoding JSON.
400	ErrorParametersAclUuid	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.