DescribeContactList 操作を呼び出して、アラート連絡先のリストをクエリします。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cms:DescribeContactList |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| PageSize |
integer |
任意 |
ページあたりのエントリ数。 デフォルト値: 100。 |
10 |
| PageNumber |
integer |
任意 |
現在のページ番号。 デフォルト値: 1。 |
1 |
| ContactName |
string |
任意 |
アラート連絡先の名前。 |
Alice |
| ChanelType |
string |
任意 |
アラート通知方法。有効な値:
|
|
| ChanelValue |
string |
任意 |
アラート通知方法の値。 説明
このパラメーターは、 |
Alice@example.com |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
なし。 |
||
| Code |
string |
状態コード。 説明
200 は成功を示します。 |
200 |
| Message |
string |
エラーメッセージ。 |
The Request is not authorization. |
| RequestId |
string |
リクエスト ID。 |
06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83 |
| Total |
integer |
レコードの総数。 |
15 |
| Success |
boolean |
操作が成功したかどうかを示します。有効な値:
|
true |
| Contacts |
object |
||
| Contact |
array<object> |
アラート通知方法。 |
|
|
array<object> |
なし。 |
||
| UpdateTime |
integer |
アラート連絡先が更新されたときのタイムスタンプ。 単位:ミリ秒。 |
1552356159000 |
| Name |
string |
アラート連絡先の名前。 |
Alice |
| CreateTime |
integer |
アラート連絡先が作成されたときのタイムスタンプ。 単位:ミリ秒。 |
1552356159000 |
| Lang |
string |
アラート情報が表示される言語。有効な値:
|
zh-cn |
| Desc |
string |
説明。 |
ECS |
| ContactGroups |
object |
||
| ContactGroup |
array |
なし。 |
|
|
string |
アラートグループ。 |
{ "ContactGroup": [ "ECS_Group", "Jim" ] } |
|
| Channels |
object |
アラート通知方法。 |
|
|
string |
アラート連絡先のメールアドレス。 |
Alice@example.com |
|
| AliIM |
string |
アラート連絡先の TradeManager ID。 |
Alice |
| DingWebHook |
string |
DingTalk チャットボットの Webhook URL。 |
https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112**** |
| SMS |
string |
アラート連絡先の電話番号。 |
1333333**** |
| ChannelsState |
object |
アラート通知方法のステータス。有効な値:PENDING および OK。 メールアドレスは、アラート通知方法に指定された値として追加された後、アクティブ化する必要があります。値 PENDING はメールアドレスがアクティブ化されていないことを示します。値 OK はメールアドレスがアクティブ化されていることを示します。 |
|
|
string |
メールアドレスのステータス。有効な値:
|
PENDING |
|
| AliIM |
string |
TradeManager ID のステータス。 有効な値:OK。値 OK は、TradeManager ID が有効で、アラート通知を受信できることを示します。 説明
このパラメーターは、Alibaba Cloud 中国サイト (aliyun.com) にのみ適用されます。 |
OK |
| DingWebHook |
string |
DingTalk チャットボットのステータス。 有効な値:OK。値 OK は、DingTalk チャットボットが正常であり、DingTalk グループでアラート通知を受信できることを示します。 |
OK |
| SMS |
string |
電話番号のステータス。有効な値:
説明
このパラメーターは、Alibaba Cloud 中国サイト (aliyun.com) にのみ適用されます。 |
OK |
例
成功レスポンス
JSONJSON
{
"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"
}
}
]
}
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidParameter | %s | |
| 500 | InternalError | The request processing has failed due to some unknown error. | |
| 403 | InvalidAuthorization | %s | |
| 404 | ResourceNotFound | %s |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。