DescribeContactList - - Centre de documentation Alibaba Cloud

Consulte la liste des contacts d'alerte.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

cms:DescribeContactList

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
PageSize	integer	Non	Le nombre d'entrées par page. Valeur par défaut : 100.	10
PageNumber	integer	Non	Le numéro de la page actuelle. Valeur par défaut : 1.	1
ContactName	string	Non	Le nom du contact d'alerte.	Alice
ChanelType	string	Non	La méthode de notification d'alerte. Valeurs valides : Mail : e-mail. DingWebHook : robot de discussion DingTalk.	Mail
ChanelValue	string	Non	La valeur de la méthode de notification d'alerte. Remarque Ce paramètre est requis uniquement lorsque ChanelType est défini sur Mail.	Alice@example.com

Éléments de réponse

Élément	Type	Description	Exemple
	object	Aucun.
Code	string	Le code d'état. Remarque 200 indique un succès.	200
Message	string	Le message d'erreur.	La requête n'est pas autorisée
RequestId	string	L'identifiant de la requête.	06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83
Total	integer	Le nombre total d'enregistrements.	15
Success	boolean	Indique si l'opération a réussi. Valeurs valides : true : succès. false : échec.	true
Contacts	object
Contact	array<object>	Les méthodes de notification d'alerte.
	array<object>	Aucun.
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. Remarque 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. Remarque This parameter is applicable only to the China site.	OK

Exemples

JSON format

{
  "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"
        }
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur
400	InvalidParameter	%s
500	InternalError	The request processing has failed due to some unknown error.
403	InvalidAuthorization	%s
404	ResourceNotFound	%s

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.