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

Consulta uma lista 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:DescribeContactList

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PageSize	integer	Não	O número de entradas por página. Valor padrão: 100.	10
PageNumber	integer	Não	O número da página atual. Valor padrão: 1.	1
ContactName	string	Não	O nome do contato de alerta.	Alice
ChanelType	string	Não	O método de notificação de alerta. Valores válidos: Mail: e-mail. DingWebHook: chatbot do DingTalk.	Mail
ChanelValue	string	Não	O valor do método de notificação de alerta. Nota Este parâmetro é obrigatório apenas quando ChanelType é definido como Mail.	Alice@example.com

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Nenhum.
Code	string	O código de status. Nota 200 indica sucesso.	200
Message	string	A mensagem de erro.	The Request is not authorization.
RequestId	string	O ID da solicitação.	06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83
Total	integer	O número total de registros.	15
Success	boolean	Indica se a operação foi bem-sucedida. Valores válidos: true: Bem-sucedida. false: Falha.	true
Contacts	object
Contact	array<object>	Os contatos de alerta.
	array<object>	Nenhum.
UpdateTime	integer	The timestamp when the alert contact was last updated. Unit: milliseconds.	1552356159000
Name	string	The name of the alert contact.	Alice
CreateTime	integer	The timestamp when the alert contact was created. Unit: milliseconds.	1552356159000
Lang	string	The language type of the alert. Valid values: zh-cn: simplified Chinese. en: English.	zh-cn
Desc	string	The description.	ECS
ContactGroups	object
ContactGroup	array	None.
	string	The alert contact groups.	{ "ContactGroup": [ "ECS_Group", "Jim" ] }
Channels	object	The alert notification methods.
Mail	string	The email address.	Alice@example.com
AliIM	string	The TradeManager name.	Alice
DingWebHook	string	The webhook URL of the DingTalk chatbot.	https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****
SMS	string	The mobile phone number.	1333333****
ChannelsState	object	The status of the alert channel. Email addresses must be activated before they can be used. When you add or modify an alert channel, the status is PENDING if the channel is not activated, and OK if the channel is activated. .
Mail	string	The status of the email address. Valid values: PENDING: The alert channel is not activated. Activate it before use. OK: The alert channel is normal and alerts can be sent.	PENDING
AliIM	string	The status of the TradeManager name is normal. Currently, only the value OK is supported. OK indicates that the TradeManager name is normal, the corresponding alert channel is normal, and alerts can be sent. Nota This parameter is applicable only to the China site.	OK
DingWebHook	string	The status of the DingTalk chatbot is normal. Currently, only the value OK is supported. OK indicates that the DingTalk chatbot is normal, the corresponding alert channel is normal, and alerts can be sent.	OK
SMS	string	The status of text messages. Valid values: PENDING: The alert channel is not activated. Activate it before use. OK: The alert channel is normal and alerts can be sent. Nota This parameter is applicable only to the China site.	OK

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "200",
  "Message": "The Request is not authorization.",
  "RequestId": "06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83",
  "Total": 15,
  "Success": true,
  "Contacts": {
    "Contact": [
      {
        "UpdateTime": 1552356159000,
        "Name": "Alice",
        "CreateTime": 1552356159000,
        "Lang": "zh-cn",
        "Desc": "ECS",
        "ContactGroups": {
          "ContactGroup": [
            "{ \"ContactGroup\": [ \t\"ECS_Group\", \"Jim\" ] }"
          ]
        },
        "Channels": {
          "Mail": "Alice@example.com",
          "AliIM": "Alice",
          "DingWebHook": "https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****",
          "SMS": "1333333****"
        },
        "ChannelsState": {
          "Mail": "PENDING",
          "AliIM": "OK",
          "DingWebHook": "OK",
          "SMS": "OK"
        }
      }
    ]
  }
}

Códigos de erro

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

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.