すべてのプロダクト
Search

このプロダクト

    :GetTemplateParameterConstraints

    ドキュメントセンター

    :GetTemplateParameterConstraints

    最終更新日:Jun 03, 2026

    テンプレートのパラメーターの有効な値を取得します。

    操作説明

    説明

    このトピックでは、China (Hangzhou) リージョンに特有のテンプレート内の ZoneInfo パラメーターの有効な値をクエリする方法の例を示します。テンプレートは { "ROSTemplateFormatVersion": "2015-09-01", "Parameters": { "ZoneInfo": { "Type": "String" }, "InstanceType": { "Type": "String" } }, "Resources": { "ECS": { "Type": "ALIYUN::ECS::Instance", "Properties": { "ZoneId": { "Ref": "ZoneInfo" }, "InstanceType": { "Ref": "InstanceType" } } } } } です。

    クエリ可能なパラメーターとテンプレートの内容の詳細については、「パラメーター制約のクエリ」をご参照ください。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    ros:GetTemplateParameterConstraints

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    TemplateBody

    string

    任意

    テンプレート本文の構造。テンプレート本文の長さは 1～524,288 バイトである必要があります。テンプレート本文の長さが上限を超えた場合、URL が長すぎてリクエストが失敗することを避けるために、HTTP POST + Body Param メソッドを使用してリクエストボディでパラメーターを渡すことを推奨します。

    説明

    TemplateBody、TemplateURL、TemplateId、TemplateScratchId パラメーターのうち、いずれか 1 つのみ指定できます。

    { "ROSTemplateFormatVersion": "2015-09-01", "Parameters": { "ZoneInfo": { "Type": "String" }, "InstanceType": { "Type": "String" } }, "Resources": { "ECS": { "Type": "ALIYUN::ECS::Instance", "Properties": { "ZoneId": { "Ref": "ZoneInfo" }, "InstanceType": { "Ref": "InstanceType" } } } } }
    RegionId

    string

    必須

    リージョン ID。DescribeRegions API を呼び出して、最新のリージョンリストを照会できます。

    cn-hangzhou
    TemplateURL

    string

    任意

    テンプレート本文を含むファイルの URL。URL は、HTTP または HTTPS ウェブサーバー、あるいは Alibaba Cloud OSS バケット (例: oss://ros/template/demo、oss://ros/template/demo?RegionId=cn-hangzhou) にあるテンプレートを指している必要があります。テンプレートの長さは 1～524,288 バイトである必要があります。OSS リージョンが指定されていない場合、デフォルトでは RegionId パラメーターと同じになります。

    説明

    TemplateBody、TemplateURL、TemplateId、TemplateScratchId パラメーターのうち、いずれか 1 つのみ指定できます。

    oss://ros-template/demo
    TemplateId

    string

    任意

    テンプレートの ID。このパラメーターは、共有テンプレートとプライベートテンプレートに適用されます。

    説明

    TemplateBody、TemplateURL、TemplateId、TemplateScratchId パラメーターのうち、いずれか 1 つのみ指定できます。

    5ecd1e10-b0e9-4389-a565-e4c15efc****
    TemplateVersion

    string

    任意

    テンプレートのバージョン。このパラメーターを指定しない場合、最新バージョンが使用されます。

    説明

    TemplateVersion は、TemplateId が指定されている場合にのみ有効です。

    v1
    Parameters

    array<object>

    任意

    テンプレートで定義されているパラメーター。

    object

    任意

    ParameterKey

    string

    必須

    テンプレートで定義されたパラメーターの名前。

    説明

    Parameters パラメーターはオプションです。Parameters を指定する場合は、ParameterKey を指定する必要があります。

    ZoneInfo
    ParameterValue

    string

    必須

    テンプレートで定義されたパラメーターの値。

    説明

    Parameters パラメーターはオプションです。Parameters を指定する場合は、ParameterValue を指定する必要があります。

    cn-hangzhou-h
    ParametersKeyFilter

    array

    任意

    照会するパラメーターのリスト。

    string

    任意

    照会するパラメーター。

    ZoneInfo
    ClientToken

    string

    任意

    リクエストのべき等性を保証するために使用するクライアントトークン。クライアントを使用してトークンを生成できますが、トークンが異なるリクエスト間で一意であることを確認する必要があります。トークンは最大 64 文字で、文字、数字、ハイフン (-)、アンダースコア (_) を使用できます。詳細については、「べき等性を確保する方法」をご参照ください。

    123e4567-e89b-12d3-a456-42665544****
    ParametersOrder

    array

    任意

    パラメーターの依存関係。

    string

    任意

    パラメーターの依存関係の順序。

    説明

    デフォルトでは、パラメーターの依存関係はテンプレートの Metadata パラメーターで指定されます。

    ["ZoneId", "InstanceType"]
    StackId

    string

    任意

    スタックの ID。

    このパラメーターを指定すると、アップグレードまたはダウングレードシナリオのパラメーター制約を照会できます。

    c754d2a4-28f1-46df-b557-9586173a****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエストの ID。

    9816785B-BCF8-514D-8B76-C1EC2BC954FC
    ParameterConstraints

    array<object>

    パラメーター制約に関する情報。

    array<object>

    ParameterKey

    string

    パラメーター名。

    ZoneInfo
    Type

    string

    パラメーターのタイプ。

    String
    AllowedValues

    array

    パラメーターの有効な値のリスト。

    string

    パラメーターの有効な値。

    cn-hangzhou-h
    Behavior

    string

    パラメーターの動作。有効な値：

    • NoLimit：パラメーターの有効な値に制限はありません。

    • NotSupport：パラメーターの有効な値は照会できません。

    • QueryError：クエリが失敗しました。

    説明

    AllowedValues が返されない場合、Behavior と BehaviorReason が返され、パラメーターの動作とその理由が示されます。

    NoLimit
    BehaviorReason

    string

    パラメーターの動作の理由。

    No resource property refer to the parameter
    AssociationParameterNames

    array

    関連パラメーター名。

    string

    関連パラメーター名。

    InstanceType
    IllegalValueByParameterConstraints

    array

    パラメーター制約に一致しない値。

    説明

    AllowedValues が返される場合、IllegalValueByParameterConstraints と IllegalValueByRules が返され、パラメーター制約とテンプレートルールによって除外された無効な値が示されます。

    any

    パラメーター制約に一致しない値。

    説明

    AllowedValues が返される場合、パラメーター制約とテンプレートルールによって除外された無効な値は、IllegalValueByParameterConstraints および IllegalValueByRules パラメーターで返されます。

    cn-hangzhou-h
    IllegalValueByRules

    array

    テンプレートルールに一致しない値。

    説明

    AllowedValues が返される場合、IllegalValueByParameterConstraints と IllegalValueByRules が返され、パラメーター制約とテンプレートルールによって除外された無効な値が示されます。

    any

    テンプレートルールに一致しない値。

    説明

    AllowedValues が返される場合、パラメーター制約とテンプレートルールによって除外された無効な値は、IllegalValueByParameterConstraints および IllegalValueByRules パラメーターで返されます。

    cn-hangzhou-h
    NotSupportResources

    array<object>

    サポートされていないリソースの詳細。

    object

    サポートされていないリソースの詳細。

    このパラメーターは、Behavior の値が NotSupport の場合に返されます。

    ResourceType

    string

    リソースタイプ。

    ALIYUN::ECS::InstanceGroup
    PropertyName

    string

    リソースプロパティ名。

    InstanceName
    QueryErrors

    array<object>

    クエリの失敗の詳細。

    object

    クエリの失敗の詳細。

    このパラメーターは、Behavior の値が QueryError の場合に返されます。

    ErrorMessage

    string

    エラー詳細。

    ALIYUN::ECS::InstanceGroup
    ResourceName

    string

    リソース名。

    MyECS
    ResourceType

    string

    リソースタイプ。

    InstanceType is needed while query DataDisk
    OriginalConstraints

    array<object>

    元の制約に関する情報。

    object

    元の制約に関する情報。

    ResourceName

    string

    テンプレートで定義されているリソース名。

    MyECS
    AllowedValues

    array

    パラメーターの有効な値のリスト。

    any

    パラメーターの有効な値。

    cn-hangzhou-a
    ResourceType

    string

    リソースタイプ。

    ALIYUN::ECS::InstanceGroup

    PropertyName

    string

    プロパティ名。

    ZoneId
    Behavior

    string

    パラメーターの動作。

    QueryError
    BehaviorReason

    string

    パラメーターの動作の理由。

    No resource property refer to the parameter
    PropertiesData

    string

    パラメーター制約のクエリ中に使用されるクエリパラメーター。

    { "ZoneId":"cn-hangzhou-h", "SystemDiskCategory":"cloud_essd" }
    RequestInfo

    string

    クラウドサービスのパラメーター制約を照会するために呼び出される操作のリクエスト情報。

    ecs:2014-05-26:DescribeAvailableResource:4C5B6929-EB64-5086-A821-9CCB553A5AE9
    QueryTimeoutDetails

    array<object>

    クエリタイムアウトの詳細。

    object

    クエリタイムアウトの詳細。

    ResourceType

    string

    リソースタイプ。

    ALIYUN::RDS::DBInstance
    ResourceName

    string

    リソース名。

    rds
    ErrorMessage

    string

    エラーメッセージ。

    query property SlaveZoneIds.* in resource rds error, error message: query 8 seconds timeout

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "9816785B-BCF8-514D-8B76-C1EC2BC954FC",
  "ParameterConstraints": [
    {
      "ParameterKey": "ZoneInfo",
      "Type": "String",
      "AllowedValues": [
        "cn-hangzhou-h"
      ],
      "Behavior": "NoLimit",
      "BehaviorReason": "No resource property refer to the parameter",
      "AssociationParameterNames": [
        "InstanceType"
      ],
      "IllegalValueByParameterConstraints": [
        "cn-hangzhou-h"
      ],
      "IllegalValueByRules": [
        "cn-hangzhou-h"
      ],
      "NotSupportResources": [
        {
          "ResourceType": "ALIYUN::ECS::InstanceGroup",
          "PropertyName": "InstanceName"
        }
      ],
      "QueryErrors": [
        {
          "ErrorMessage": "ALIYUN::ECS::InstanceGroup",
          "ResourceName": "MyECS",
          "ResourceType": "InstanceType is needed while query DataDisk"
        }
      ],
      "OriginalConstraints": [
        {
          "ResourceName": "MyECS",
          "AllowedValues": [
            "cn-hangzhou-a"
          ],
          "ResourceType": "ALIYUN::ECS::InstanceGroup\n",
          "PropertyName": "ZoneId",
          "Behavior": "QueryError",
          "BehaviorReason": "No resource property refer to the parameter",
          "PropertiesData": "{\n    \"ZoneId\":\"cn-hangzhou-h\",\n    \"SystemDiskCategory\":\"cloud_essd\"\n}",
          "RequestInfo": "ecs:2014-05-26:DescribeAvailableResource:4C5B6929-EB64-5086-A821-9CCB553A5AE9"
        }
      ],
      "QueryTimeoutDetails": [
        {
          "ResourceType": "ALIYUN::RDS::DBInstance",
          "ResourceName": "rds",
          "ErrorMessage": "query property SlaveZoneIds.* in resource rds error, error message: query 8 seconds timeout"
        }
      ]
    }
  ]
}

    エラーコード

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

    変更履歴

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