DescribeContactList - - Centre de documentation Alibaba Cloud

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeContactList	Opération à effectuer. Définissez la valeur sur DescribeContactList.
PageSize	Integer	No	10	Nombre d'entrées à renvoyer par page. Valeur par défaut : 100.
PageNumber	Integer	No	1	Numéro de la page à renvoyer. Valeur par défaut : 1.
ContactName	String	No	Alice	Nom du contact d'alerte.
ChanelType	String	No	Mail	Méthode de notification d'alerte. Valeurs possibles : Mail : e-mails DingWebHook : robots de discussion DingTalk
ChanelValue	String	No	Alice@example.com	Valeur associée à la méthode de notification d'alerte. Remarque Ce paramètre est obligatoire uniquement si le paramètre `ChanelType` est défini sur `Mail`.

Paramètres de réponse

Parameter	Type	Example	Description
Code	String	200	Code d'état HTTP. Remarque Le code 200 indique que l'appel a réussi.
Message	String	The Request is not authorization.	Message d'erreur.
RequestId	String	06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83	ID de la requête.
Total	Integer	15	Nombre total d'entrées renvoyées.
Success	Boolean	true	Indique si l'appel a réussi. Valeurs possibles : true : appel réussi. false : échec de l'appel.
Contacts	Array of Contact		Contacts d'alerte.
Contact
UpdateTime	Long	1552356159000	Horodatage de la dernière mise à jour du contact d'alerte. Unité : millisecondes.
Name	String	Alice	Nom du contact d'alerte.
CreateTime	Long	1552356159000	Horodatage de la création du contact d'alerte. Unité : millisecondes.
Lang	String	zh-cn	Langue d'affichage des informations d'alerte. Valeurs possibles : zh-cn : chinois simplifié en : anglais
Desc	String	ECS alert contact	Description du contact d'alerte.
ContactGroups	Array of String	{ "ContactGroup": [ "ECS_Group", "Jim" ] }	Groupes de contacts d'alerte.
Channels	Object		Méthode de notification d'alerte.
Mail	String	Alice@example.com	Adresse e-mail du contact d'alerte.
AliIM	String	Alice	ID TradeManager du contact d'alerte.
DingWebHook	String	https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****	URL webhook du robot de discussion DingTalk.
SMS	String	1333333****	Numéro de téléphone du contact d'alerte.
ChannelsState	Object		État de la méthode de notification d'alerte. Valeurs possibles : PENDING et OK. L'adresse e-mail doit être activée après son ajout en tant que valeur pour la méthode de notification d'alerte. La valeur PENDING indique que l'adresse e-mail n'est pas activée. La valeur OK indique que l'adresse e-mail est activée.
Mail	String	PENDING	État de l'adresse e-mail. Valeurs possibles : PENDING : l'adresse e-mail n'est pas activée. Les notifications d'alerte ne peuvent être envoyées à cette adresse qu'après activation. OK : l'adresse e-mail est activée et peut recevoir des notifications d'alerte.
AliIM	String	OK	État de l'ID TradeManager. Valeur possible : OK. Cette valeur indique que l'ID TradeManager est valide et peut recevoir des notifications d'alerte. Remarque Ce paramètre n'est renvoyé que sur le site China (aliyun.com).
DingWebHook	String	OK	État du robot de discussion DingTalk. Valeur possible : OK. Cette valeur indique que le robot de discussion DingTalk fonctionne normalement et peut recevoir des notifications d'alerte dans un groupe DingTalk.
SMS	String	OK	État du numéro de téléphone. Valeurs possibles : PENDING : le numéro de téléphone n'est pas activé. Les notifications d'alerte ne peuvent être envoyées par SMS à ce numéro qu'après activation. OK : le numéro de téléphone est activé et peut recevoir des notifications d'alerte. Remarque Ce paramètre n'est renvoyé que sur le site China (aliyun.com).

Exemples

Exemple de requête

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

Exemple de réponse réussie

Format XML

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>

Format JSON

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
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, visitez le Centre d'erreurs de l'API.