DescribeGroupedContainerInstances - Security Center: Central de Documentação do Alibaba Cloud

Consulta a lista de contêineres com base no tipo de grupo especificado.

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-sas:DescribeGroupedContainerInstances

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Criteria	string	Não	As condições para pesquisar ativos. Este parâmetro está no formato JSON. Separe várias condições com vírgulas (,). Exemplo: `[{"name":"riskStatus","value":"YES"},{"name":"riskLevel","value":"2"}]`. Nota Você pode pesquisar ativos por ID da instância, nome da instância, ID da VPC, região, endereço IP público e outras condições. Chame DescribeCriteria para consultar as condições de pesquisa suportadas.	[{"name":"riskStatus","value":"YES"},{"name":"riskLevel","value":"2"}]
LogicalExp	string	Não	A relação lógica entre várias condições de pesquisa. Valores válidos: OR: As condições de pesquisa são avaliadas com um OR lógico. AND: As condições de pesquisa são avaliadas com um AND lógico.	OR
GroupField	string	Sim	O tipo de grupo a ser consultado. Valores válidos: pod: pod appName: nome do aplicativo namespace: namespace clusterId: ID do cluster image: imagem.	pod
FieldValue	string	Não	A condição de pesquisa para o tipo de grupo especificado. Defina a condição de pesquisa com base no tipo especificado por GroupField: Se GroupField estiver definido como pod: especifique o nome do pod a ser consultado. Se GroupField estiver definido como appName: especifique o nome do aplicativo a ser consultado. Se GroupField estiver definido como namespace: especifique o namespace a ser consultado. Se GroupField estiver definido como clusterId: especifique o ID do cluster a ser consultado. Se GroupField estiver definido como image: especifique o nome da imagem a ser consultado. Nota Todas as condições de pesquisa anteriores suportam correspondência aproximada.	cas-adad-qeqwe
PageSize	integer	Não	O número de ativos de contêiner a serem exibidos em cada página quando a paginação é usada. Valor padrão: 20, o que indica que 20 ativos de contêiner são exibidos em cada página. Nota Não deixe PageSize vazio.	20
CurrentPage	integer	Não	O número da página a ser retornada. Valor padrão: 1, o que indica que a primeira página é retornada.	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação. O ID é um identificador exclusivo que a Alibaba Cloud gera para a solicitação e pode ser usado para solucionar problemas.	4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D
PageInfo	object	As informações de paginação.
CurrentPage	integer	O número da página atual em uma consulta paginada.	1
PageSize	integer	O número de ativos de contêiner exibidos em cada página em uma consulta paginada. Valor padrão: 20, o que indica que 20 ativos de contêiner são exibidos em cada página.	20
TotalCount	integer	O número total de ativos de contêiner retornados.	25
Count	integer	O número de ativos de contêiner exibidos na página atual em uma consulta paginada.	20
GroupedContainerInstanceList	array<object>	A lista de informações de ativos de contêiner retornada.
	object	As informações do ativo de contêiner.
RiskLevel	string	O nível de risco. Valores válidos: high: alto medium: médio low: baixo.	low
HostIp	string	O endereço IP do host do cluster de contêineres.	172.114.XX.XX
Pod	string	O nome do pod.	csi-plugin-2n****
RiskStatus	string	O status de risco. Valores válidos: NO: Sem risco. YES: Em risco.	NO
CreateTime	integer	O timestamp de criação do cluster, em milissegundos.	1600076893000
Namespace	string	O namespace do cluster.	kube-system
CusterState	string	O status de execução do cluster. Valores válidos: running: O cluster está em execução. stopped: O cluster está parado. deleted: O cluster foi excluído. delete_failed: Falha ao excluir o cluster. failed: Falha ao criar o cluster.	running
InstanceId	string	O ID da instância do servidor.	i-8vb9ul5xec4tua4q****
RegionId	string	O ID da região na qual a instância reside.	cn-hangzhou
AppName	string	O nome do aplicativo.	oss-liveness-probe
InstanceCount	integer	O número de pods, aplicativos, clusters ou namespaces retornados.	9
ClusterType	string	O tipo do cluster. Valores válidos: Kubernetes: cluster Kubernetes dedicado ManagedKubernetes: cluster gerenciado padrão (cluster de borda) Ask: cluster serverless padrão.	ManagedKubernetes
ClusterName	string	O nome do cluster.	test
PodIp	string	O endereço IP do pod.	172.114.XX.XX
VulCount	integer	O número de vulnerabilidades detectadas no pod, aplicativo, namespace ou cluster atual.	1
AlarmCount	integer	O número de alertas detectados no pod, aplicativo, namespace ou cluster atual.	1
RiskInstanceCount	integer	O número de instâncias que estão em risco.	1
ClusterId	string	O ID do cluster.	cf3824769c85441b4bf3****
Image	string	A imagem do contêiner.	registry-vpc.ap-southeast-5.aliyuncs.com/log-service-release/sls-connector:1.1.77
ImageRepoNamespace	string	O namespace do repositório de imagens.	name001
ImageRepoName	string	O nome do repositório de imagens.	test-003
ImageRepoTag	string	A tag do repositório de imagens.	dev-20220512-2
ImageDigest	string	O valor do digest da imagem.	58e58c013f70bbfde140c8a55c1078074b3483479428d4069aa946827fd566cf
ImageUuid	string	O UUID da imagem.	e4bdec1d9ba7e0967111a7ea467c****
HcCount	integer	O número total de verificações de linha de base detectadas no pod, aplicativo, namespace ou cluster atual.	20
SyncOpen	integer	A chave de sincronização de auditoria de logs do cluster. Valores válidos: 0: desativado 1: ativado.	1
SyncStatus	integer	O status de sincronização de auditoria de logs do cluster. Valores válidos: 0: falha na sincronização 1: sincronização bem-sucedida.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 25,
    "Count": 20
  },
  "GroupedContainerInstanceList": [
    {
      "RiskLevel": "low",
      "HostIp": "172.114.XX.XX",
      "Pod": "csi-plugin-2n****",
      "RiskStatus": "NO",
      "CreateTime": 1600076893000,
      "Namespace": "kube-system",
      "CusterState": "running",
      "InstanceId": "i-8vb9ul5xec4tua4q****",
      "RegionId": "cn-hangzhou",
      "AppName": "oss-liveness-probe",
      "InstanceCount": 9,
      "ClusterType": "ManagedKubernetes",
      "ClusterName": "test",
      "PodIp": "172.114.XX.XX",
      "VulCount": 1,
      "AlarmCount": 1,
      "RiskInstanceCount": 1,
      "ClusterId": "cf3824769c85441b4bf3****",
      "Image": "registry-vpc.ap-southeast-5.aliyuncs.com/log-service-release/sls-connector:1.1.77",
      "ImageRepoNamespace": "name001",
      "ImageRepoName": "test-003",
      "ImageRepoTag": "dev-20220512-2",
      "ImageDigest": "58e58c013f70bbfde140c8a55c1078074b3483479428d4069aa946827fd566cf",
      "ImageUuid": "e4bdec1d9ba7e0967111a7ea467c****",
      "HcCount": 20,
      "SyncOpen": 1,
      "SyncStatus": 1
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	IllegalParam	Illegal param
500	ServerError	ServerError
403	NoPermission	caller has no permission

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.