すべてのプロダクト
Search
ドキュメントセンター

Cloud Monitor:DescribeContactList

最終更新日:Jun 14, 2026

DescribeContactList 操作を呼び出して、アラート連絡先のリストをクエリします。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cms:DescribeContactList

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

PageSize

integer

任意

ページあたりのエントリ数。

デフォルト値: 100。

10

PageNumber

integer

任意

現在のページ番号。

デフォルト値: 1。

1

ContactName

string

任意

アラート連絡先の名前。

Alice

ChanelType

string

任意

アラート通知方法。有効な値:

  • Mail: メール。

  • DingWebHook: DingTalk チャットボット。

Mail

ChanelValue

string

任意

アラート通知方法の値。

説明

このパラメーターは、ChanelTypeMail にセットされている場合にのみ必須です。

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: 成功。

  • false: 失敗。

true

Contacts

object

Contact

array<object>

アラート通知方法。

array<object>

なし。

UpdateTime

integer

アラート連絡先が更新されたときのタイムスタンプ。

単位:ミリ秒。

1552356159000

Name

string

アラート連絡先の名前。

Alice

CreateTime

integer

アラート連絡先が作成されたときのタイムスタンプ。

単位:ミリ秒。

1552356159000

Lang

string

アラート情報が表示される言語。有効な値:

  • zh-cn:簡体字中国語

  • en:英語

zh-cn

Desc

string

説明。

ECS

ContactGroups

object

ContactGroup

array

なし。

string

アラートグループ。

{ "ContactGroup": [ "ECS_Group", "Jim" ] }

Channels

object

アラート通知方法。

Mail

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 はメールアドレスがアクティブ化されていることを示します。

Mail

string

メールアドレスのステータス。有効な値:

  • PENDING:メールアドレスはアクティブ化されていません。メールアドレスがアクティブ化された後にのみ、アラート通知をそのメールアドレスに送信できます。

  • OK:メールアドレスはアクティブ化されており、アラート通知を受信できます。

PENDING

AliIM

string

TradeManager ID のステータス。

有効な値:OK。値 OK は、TradeManager ID が有効で、アラート通知を受信できることを示します。

説明

このパラメーターは、Alibaba Cloud 中国サイト (aliyun.com) にのみ適用されます。

OK

DingWebHook

string

DingTalk チャットボットのステータス。

有効な値:OK。値 OK は、DingTalk チャットボットが正常であり、DingTalk グループでアラート通知を受信できることを示します。

OK

SMS

string

電話番号のステータス。有効な値:

  • PENDING:電話番号はアクティブ化されていません。電話番号がアクティブ化された後にのみ、ショートメッセージを使用してアラート通知を電話番号に送信できます。

  • OK:電話番号はアクティブ化されており、アラート通知を受信できます。

説明

このパラメーターは、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

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。