QueryTaskByParam 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:QueryTaskByParam

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PageNo	integer	任意	ページ番号。デフォルト値：1。	1
PageSize	integer	任意	ページあたりのエントリ数。デフォルト値：10。	10
KeyWord	string	任意	クエリのキーワード。このパラメーターを空のままにすると、すべてのタスクが返されます。	mesh-notification-788717
Status	integer	任意	タスクステータス。このパラメーターを空のままにすると、すべての状態のタスクが返されます。	0

レスポンスフィールド

フィールド	型	説明	例
	object
PageSize	integer	ページあたりのエントリ数。	10
RequestId	string	リクエスト ID。	10A1AD70-E48E-476D-98D9-39BD92193837
PageNumber	integer	ページ番号。	3
TotalCount	integer	エントリの総数。	15
data	object
task	array<object>	返されたデータ。
	object
ReceiversName	string	受信者名。	TKP000442-333
TagName	string	タグ。	202201
TaskStatus	string	タスクステータス。値が 1 の場合は、メールが送信されたことを示します。	1
CreateTime	string	タスクが作成された時刻。	2022-04-18T10:36Z
RequestCount	string	リクエスト数。	1
AddressType	string	アドレスタイプ。1：送信元アドレス。0：ランダムアドレス。	0
UtcCreateTime	integer	タスクが作成された時刻 (UTC 形式)。	1569734892
TemplateName	string	テンプレート名。	Short Simple
TaskId	string	タスク ID。	1054296
IpPoolId	string	専用 IP アドレスプールの ID。	xxx
IpPoolName	string	専用 IP アドレスプールの名前。	测试专属IP地址池1
ConfigSetId	string	構成セットの ID。	xxx
ConfigSetName	string	構成セットの名前。	xxx

例

成功レスポンス

JSONJSON

{
  "PageSize": 10,
  "RequestId": "10A1AD70-E48E-476D-98D9-39BD92193837",
  "PageNumber": 3,
  "TotalCount": 15,
  "data": {
    "task": [
      {
        "ReceiversName": "TKP000442-333",
        "TagName": "202201",
        "TaskStatus": "1",
        "CreateTime": "2022-04-18T10:36Z",
        "RequestCount": "1",
        "AddressType": "0",
        "UtcCreateTime": 1569734892,
        "TemplateName": "Short Simple",
        "TaskId": "1054296",
        "IpPoolId": "xxx",
        "IpPoolName": "测试专属IP地址池1",
        "ConfigSetId": "xxx",
        "ConfigSetName": "xxx"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidKeyword.Malformed	The specified keyword is wrongly formed.
400	InvalidStatus.Malformed	The specified status is wrongly formed.
500	InternalError	The request processing has failed due to some unknown error.

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

変更履歴

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