DescribeContactGroupList - Cloud Monitor: Central de Documentação do Alibaba Cloud

Consulta a lista de grupos de contatos de alerta chamando a operação DescribeContactGroupList.

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

cms:DescribeContactGroupList

get

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PageSize	integer	Não	O número de registros por página.	10
PageNumber	integer	Não	O número da página.	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Code	string	O código de status. Um valor de 200 indica sucesso.	200
Message	string	A mensagem retornada.	sucesso
RequestId	string	O ID da solicitação. O Alibaba Cloud gera um identificador exclusivo para cada solicitação de API. Você pode usar esse ID para solucionar problemas.	916EE694-03C2-47B6-85EE-5054E3C168D3
Total	integer	O número total de registros.	22
Success	boolean	Indica se a operação foi bem-sucedida. Valores válidos: true: Bem-sucedida. false: Falha.	true
ContactGroups	object
ContactGroup	array	A lista de grupos de contatos de alerta.
	string	O grupo de contatos de alerta.	Contato de alerta de conta em nuvem
ContactGroupList	object
ContactGroup	array<object>	A lista de grupos de contatos de alerta.
	array<object>	O grupo de contatos de alerta.
Describe	string	A descrição do grupo de contatos de alerta.	Devops-OpsTeam
UpdateTime	integer	A hora em que o grupo de contatos foi atualizado pela última vez, no formato ISO 8601 (como 2025-03-04T02:12:06Z) no fuso horário UTC.	2025-03-04T02:12:06Z
CreateTime	integer	A hora em que o grupo de contatos foi criado, no formato ISO 8601 (como 2023-06-07T03:52:30Z) no fuso horário UTC.	2023-06-07T03:52:30Z
EnabledWeeklyReport	boolean	Indica se o recurso de relatório semanal está ativado.	false
Name	string	O nome.	nome
EnableSubscribed	boolean	Indica se o recurso de assinatura de relatório semanal está ativado. Valores válidos: true: Ativado. false: Desativado.	false
Contacts	object
Contact	array	Lista de contatos.
	string	Contato.	135xxxx8066

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "200",
  "Message": "success",
  "RequestId": "916EE694-03C2-47B6-85EE-5054E3C168D3",
  "Total": 22,
  "Success": true,
  "ContactGroups": {
    "ContactGroup": [
      "云账号报警联系人"
    ]
  },
  "ContactGroupList": {
    "ContactGroup": [
      {
        "Describe": "Devops-运维组",
        "UpdateTime": 0,
        "CreateTime": 0,
        "EnabledWeeklyReport": false,
        "Name": "name",
        "EnableSubscribed": false,
        "Contacts": {
          "Contact": [
            "135xxxx8066"
          ]
        }
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
200	ResourceNotFound	The specified resource is not found.
400	InvalidParameter	Illegal parameters.
500	InternalError	The request processing has failed due to some unknown error.
403	InvalidAuthorization	User not authorized to operate on the specified resource.
404	ResourceNotFound	The specified resource is not found.	O recurso especificado não foi encontrado.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.