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

Consulta os contatos de alerta em um grupo de contatos de alerta.

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:DescribeContactListByContactGroup

get

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ContactGroupName	string	Sim	O nome do grupo de contatos de alerta.	CloudMonitor

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Code	string	O código de status. Nota 200 indica sucesso.	200
Message	string	A mensagem de erro.	The group is not exists.
RequestId	string	O ID da solicitação.	06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83
Success	boolean	Indica se a operação foi bem-sucedida. Valores válidos: true: Sucesso. false: Falha.	true
Contacts	object
Contact	array<object>	Os contatos de alerta.
	array<object>	Os contatos de alerta.
UpdateTime	integer	O carimbo de data/hora em que o contato de alerta foi atualizado. Unidade: milissegundos.	1552323252000
Name	string	O nome do contato de alerta.	Alice
CreateTime	integer	O carimbo de data/hora em que o contato de alerta foi criado. Unidade: milissegundos.	1552314252000
Desc	string	A descrição do grupo de contatos de alerta.	ECS
Channels	object	Os canais de alerta.
Mail	string	O endereço de e-mail do contato de alerta.	alice@example.com
AliIM	string	O nome do TradeManager do contato de alerta. Nota Este parâmetro é aplicável apenas ao site da China.	Alice
DingWebHook	string	A URL do webhook do contato de alerta.	https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****
SMS	string	O número de telefone celular do contato de alerta. Nota Este parâmetro é aplicável apenas ao site da China.	1333333****

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "200",
  "Message": "The group is not exists.",
  "RequestId": "06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83",
  "Success": true,
  "Contacts": {
    "Contact": [
      {
        "UpdateTime": 1552323252000,
        "Name": "Alice",
        "CreateTime": 1552314252000,
        "Desc": "ECS",
        "Channels": {
          "Mail": "alice@example.com",
          "AliIM": "Alice",
          "DingWebHook": "https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****",
          "SMS": "1333333****"
        }
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	%s	%s
500	%s	%s
500	InternalError	The request processing has failed due to some unknown error.
403	%s	%s
404	%s	%s

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.