QueryReceiverDetail API で受信者リストの詳細を取得 - Direct Mail

今すぐお試しください

この 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:QueryReceiverDetail

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ReceiverId	string	必須	受信者リストの ID です。(`CreateReceiver` API を使用して受信者リストを作成する際に返されます)。	1235
PageSize	integer	任意	ページあたりの項目数です。デフォルト値：10	10
KeyWord	string	任意	受信者のアドレスです。長さは 0～50 です。	b***@example.net
NextStart	string	任意	次の項目の開始位置です。デフォルト値：0	0

レスポンスフィールド

フィールド	型	説明	例
	object
DataSchema	string	受信者の Data のフィールド名です。	UserName,NickName,Gender,Birthday,Mobile
NextStart	string	ページネーションに使用されます。結果がさらにある場合は、返されたこの値を次のリクエストの NextStart に設定します。	90f0243616#40test@example.com
RequestId	string	リクエスト ID	10A1AD70-E48E-476D-98D9-39BD92193837
TotalCount	integer	総数です (非推奨のフィールドであり、下位互換性のために保持されています)。	361
data	object
detail	array<object>	詳細情報
	object	詳細情報
Data	string	内容	{'Domains': ['a.example.net', 'b.example.net', 'c.example.net', 'd.example.net']}
UtcCreateTime	integer	UTC フォーマットでの作成時間です。	1569734892
Email	string	受信者のアドレス	a***@example.net
CreateTime	string	作成時間	2019-09-29T13:28Z

例

成功レスポンス

JSONJSON

{
  "DataSchema": "UserName,NickName,Gender,Birthday,Mobile",
  "NextStart": "90f0243616#40test@example.com",
  "RequestId": "10A1AD70-E48E-476D-98D9-39BD92193837",
  "TotalCount": 361,
  "data": {
    "detail": [
      {
        "Data": "{'Domains': ['a.example.net', 'b.example.net', 'c.example.net', 'd.example.net']}",
        "UtcCreateTime": 1569734892,
        "Email": "a***@example.net",
        "CreateTime": "2019-09-29T13:28Z"
      }
    ]
  }
}

エラーコード

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

変更履歴

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