すべてのプロダクト
Search

このプロダクト

    Direct Mail:QueryReceiverByParam

    ドキュメントセンター

    Direct Mail:QueryReceiverByParam

    最終更新日:Mar 31, 2026

    受信者リストを取得します。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dm:QueryReceiverByParam

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    PageNo

    integer

    任意

    このパラメーターは下位互換性のために維持されている非推奨フィールドのため、省略できます。

    ページ番号。

    1
    PageSize

    integer

    任意

    ページサイズ。デフォルト値： 100。

    このパラメーターを省略すると、すべての結果が返されます。ただし、PageNo パラメーターは非推奨であるため、ページネーションに対する PageSize の効果は限定的です。

    10
    KeyWord

    string

    任意

    受信者リストを検索するためのキーワード。省略した場合、すべての受信者リストが返されます。

    mesh-notification
    Status

    integer

    任意

    このパラメーターは下位互換性のために維持されている非推奨フィールドのため、省略できます。

    リストのステータス。有効な値：

    • 0：アップロード中

    • 1：アップロード完了

    1

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    NextStart

    string

    より多くの結果が利用可能であることを示すトークン。次のページの結果を取得するには、次のリクエストの NextStart パラメーターにこのトークンを含める必要があります。

    6aec200853#102#1638894326#test@example.com
    PageSize

    integer

    ページごとに返されるエントリ数。

    10
    RequestId

    string

    リクエスト ID。

    10A1AD70-E48E-476D-98D9-39BD92193837
    TotalCount

    integer

    総数。

    15
    data

    object

    receiver

    array<object>

    受信者リストの詳細。

    object

    受信者リストの詳細。

    ReceiversAlias

    string

    受信者リストのエイリアス。

    10***@example.com
    ReceiversName

    string

    受信者リスト名。

    TKP000442-333
    CreateTime

    string

    作成時間。

    2019-09-29T13:28Z
    ReceiverId

    string

    受信者リスト ID。

    0c910a7143044b1e116719eb678907b3
    UtcCreateTime

    integer

    UTC (協定世界時) での作成時間。

    1569734892
    ReceiversStatus

    string

    このフィールドは下位互換性のために維持されている非推奨フィールドです。

    リストのステータス。有効な値：

    • 0：アップロード中

    • 1：アップロード完了

    0
    Count

    string

    受信元アドレス数。

    3
    Desc

    string

    説明。

    通知

    例

    成功レスポンス

    JSONJSON

    {
  "NextStart": "6aec200853#102#1638894326#test@example.com",
  "PageSize": 10,
  "RequestId": "10A1AD70-E48E-476D-98D9-39BD92193837",
  "TotalCount": 15,
  "data": {
    "receiver": [
      {
        "ReceiversAlias": "10***@example.com",
        "ReceiversName": "TKP000442-333",
        "CreateTime": "2019-09-29T13:28Z",
        "ReceiverId": "0c910a7143044b1e116719eb678907b3",
        "UtcCreateTime": 1569734892,
        "ReceiversStatus": "0",
        "Count": "3",
        "Desc": "通知"
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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