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

Debugging

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua comodidade, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeContactList	A operação a ser executada. Defina o valor como DescribeContactList.
PageSize	Integer	No	10	O número de entradas a retornar por página. Valor padrão: 100.
PageNumber	Integer	No	1	O número da página a retornar. Valor padrão: 1.
ContactName	String	No	Alice	O nome do contato de alerta.
ChanelType	String	No	Mail	O método de notificação de alerta. Valores válidos: Mail: e-mails DingWebHook: chatbots do DingTalk
ChanelValue	String	No	Alice@example.com	O valor especificado para o método de notificação de alerta. Nota Este parâmetro é obrigatório somente se o parâmetro `ChanelType` estiver definido como `Mail`.

Response parameters

Parameter	Type	Example	Description
Code	String	200	O código de status HTTP. Nota O código de status 200 indica que a chamada foi bem-sucedida.
Message	String	The Request is not authorization.	A mensagem de erro.
RequestId	String	06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83	O ID da solicitação.
Total	Integer	15	O número total de entradas retornadas.
Success	Boolean	true	Indica se a chamada foi bem-sucedida. Valores válidos: true: a chamada foi bem-sucedida. false: a chamada falhou.
Contacts	Array of Contact		Os contatos de alerta.
Contact
UpdateTime	Long	1552356159000	O timestamp da última atualização do contato de alerta. Unidade: milissegundos.
Name	String	Alice	O nome do contato de alerta.
CreateTime	Long	1552356159000	O timestamp de criação do contato de alerta. Unidade: milissegundos.
Lang	String	zh-cn	O idioma em que as informações de alerta são exibidas. Valores válidos: zh-cn: chinês simplificado en: inglês
Desc	String	ECS alert contact	A descrição do contato de alerta.
ContactGroups	Array of String	{ "ContactGroup": [ "ECS_Group", "Jim" ] }	Os grupos de contatos de alerta.
Channels	Object		O método de notificação de alerta.
Mail	String	Alice@example.com	O endereço de e-mail do contato de alerta.
AliIM	String	Alice	O id do TradeManager do contato de alerta.
DingWebHook	String	https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****	A URL do webhook do chatbot do DingTalk.
SMS	String	1333333****	O número de telefone do contato de alerta.
ChannelsState	Object		O status do método de notificação de alerta. Valores válidos: PENDING e OK. O endereço de e-mail precisa ser ativado após ser adicionado como valor do método de notificação de alerta. O valor PENDING indica que o endereço de e-mail não está ativado. O valor OK indica que o endereço de e-mail está ativado.
Mail	String	PENDING	O status do endereço de e-mail. Valores válidos: PENDING: o endereço de e-mail não está ativado. As notificações de alerta só podem ser enviadas para esse endereço após a ativação. OK: o endereço de e-mail está ativado e pode receber notificações de alerta.
AliIM	String	OK	O status do id do TradeManager. Valor válido: OK. O valor OK indica que o id do TradeManager é válido e pode receber notificações de alerta. Nota Este parâmetro só pode ser retornado no site da China (aliyun.com).
DingWebHook	String	OK	O status do chatbot do DingTalk. Valor válido: OK. O valor OK indica que o chatbot do DingTalk está normal e as notificações de alerta podem ser recebidas em um grupo do DingTalk.
SMS	String	OK	O status do número de telefone. Valores válidos: PENDING: o número de telefone não está ativado. As notificações de alerta só podem ser enviadas por mensagem de texto após a ativação do número. OK: o número de telefone está ativado e pode receber notificações de alerta. Nota Este parâmetro só pode ser retornado no site da China (aliyun.com).

Examples

Exemplos de requisição

http(s)://[Endpoint]/?Action=DescribeContactList
&<Common request parameters>

Exemplos de resposta bem-sucedida

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeContactListResponse>
		<RequestId>A1267F27-942F-40EE-9254-57FE16E3C9AB</RequestId>
		<Contacts>
			<Contact>
				<Desc>Contact Desc</Desc>
				<ContactGroups>
					<ContactGroup>ECS_Group</ContactGroup>
					<ContactGroup>Jim</ContactGroup>
				</ContactGroups>
				<ChannelsState>
					<SMS>PENDING</SMS>
					<Mail>OK</Mail>
				</ChannelsState>
				<CreateTime>1583307692000</CreateTime>
				<UpdateTime>1589441072000</UpdateTime>
				<Channels>
					<Mail>alice@example.com</Mail>
					<SMS>155*******</SMS>
				</Channels>
				<Name>Alice</Name>
				<Lang>zh-cn</Lang>
			</Contact>
		</Contacts>
		<Total>25</Total>
		<Code>200</Code>
		<Success>true</Success>
</DescribeContactListResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "A1267F27-942F-40EE-9254-57FE16E3C9AB",
  "Contacts" : {
    "Contact" : [ {
      "Desc" : "Contact Desc",
      "ContactGroups" : {
        "ContactGroup" : [ "ECS_Group", "Jim" ]
      },
      "ChannelsState" : {
        "SMS" : "PENDING",
        "Mail" : "OK"
      },
      "CreateTime" : 1583307692000,
      "UpdateTime" : 1589441072000,
      "Channels" : {
        "Mail" : "alice@example.com",
        "SMS" : "155*******"
      },
      "Name" : "Alice",
      "Lang" : "zh-cn"
    } ]
  },
  "Total" : 25,
  "Code" : "200",
  "Success" : true
}

Error codes

Para obter uma lista de códigos de erro, acesse o API Error Center.