すべてのプロダクト
Search

このプロダクト

    Direct Mail:QueryTemplateByParam

    ドキュメントセンター

    Direct Mail:QueryTemplateByParam

    最終更新日:Jun 25, 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:QueryTemplateByParam

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    PageNo

    integer

    任意

    現在のページ番号。デフォルト値: 1。

    1
    PageSize

    integer

    任意

    ページあたりのエントリ数。デフォルト値: 20。

    20
    KeyWord

    string

    任意

    テンプレート名のキーワード。デフォルトでは、すべてのテンプレートに対してページングクエリが実行されます。

    test
    Status

    integer

    任意

    非推奨。下位互換性のために保持されています。

    Abandoned, historical reasons for compatibility
    FromType

    integer

    任意

    非推奨。下位互換性のために保持されています。

    Abandoned, historical reasons for compatibility

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答。

    PageSize

    integer

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

    20
    RequestId

    string

    リクエスト ID。

    10Axxxxxxxxxxxx37
    PageNumber

    integer

    現在のページ番号。

    1
    TotalCount

    integer

    エントリの総数。

    21
    data

    object

    template

    array<object>

    テンプレート情報のフォーマット配列。

    object

    テンプレート情報のフォーマット。

    TemplateComment

    string

    テンプレートの審査コメント。

    pass
    UtcCreatetime

    integer

    テンプレートが作成された時間。時間は UTC です。

    1661830382
    Smsrejectinfo

    integer

    このパラメーターは非推奨です。過去の互換性のために保持されています。

    Abandoned, historical reasons for compatibility
    SmsTemplateCode

    integer

    このパラメーターは非推奨です。過去の互換性のために保持されています。

    Abandoned, historical reasons for compatibility
    CreateTime

    string

    テンプレートが作成された時間。

    2019-09-29T13:28Z
    TemplateStatus

    string

    テンプレートのステータス。有効な値：

    • 0：テンプレートはドラフトです。

    • 1：テンプレートは承認待ちです。

    • 2：テンプレートは承認済みです。

    • 3：テンプレートは拒否済みです。

    2
    TemplateType

    integer

    このパラメーターは非推奨です。過去の互換性のために保持されています。

    Abandoned, historical reasons for compatibility
    TemplateName

    string

    テンプレート名。

    test
    SmsStatus

    integer

    このパラメーターは非推奨です。過去の互換性のために保持されています。

    Abandoned, historical reasons for compatibility
    TemplateId

    string

    テンプレート ID。

    3xxxx8

    例

    成功レスポンス

    JSONJSON

    {
  "PageSize": 20,
  "RequestId": "10Axxxxxxxxxxxx37",
  "PageNumber": 1,
  "TotalCount": 21,
  "data": {
    "template": [
      {
        "TemplateComment": "pass",
        "UtcCreatetime": 1661830382,
        "Smsrejectinfo": 0,
        "SmsTemplateCode": 0,
        "CreateTime": "2019-09-29T13:28Z",
        "TemplateStatus": "2",
        "TemplateType": 0,
        "TemplateName": "test",
        "SmsStatus": 0,
        "TemplateId": "3xxxx8"
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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