All Products
Search

This Product

    Resource Orchestration Service:GetTemplateParameterConstraints

    Document Center

    Resource Orchestration Service:GetTemplateParameterConstraints

    Last Updated:Dec 16, 2025

    Menanyakan nilai-nilai valid dari parameter dalam sebuah template.

    Deskripsi operasi

    Description

    Topik ini memberikan contoh cara menanyakan nilai-nilai valid untuk parameter ZoneInfo dalam sebuah template yang ditujukan untuk wilayah China (Hangzhou). Template tersebut adalah { "ROSTemplateFormatVersion": "2015-09-01", "Parameters": { "ZoneInfo": { "Type": "String" }, "InstanceType": { "Type": "String" } }, "Resources": { "ECS": { "Type": "ALIYUN::ECS::Instance", "Properties": { "ZoneId": { "Ref": "ZoneInfo" }, "InstanceType": { "Ref": "InstanceType" } } } } }.

    Untuk informasi lebih lanjut mengenai parameter yang dapat ditanyakan dan konten template, lihat Query parameter constraints.

    Coba sekarang

    Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

    Test

    RAM authorization

    Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

    • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

    • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

    • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

    • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

      • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

      • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

    • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

    • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    ros:GetTemplateParameterConstraints

    get

    *All Resource

    *

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    TemplateBody

    string

    No

    Struktur isi template. Isi template harus memiliki panjang 1 hingga 524.288 byte. Jika panjang isi template melebihi batas atas, disarankan untuk menggunakan metode HTTP POST + Body Param guna meneruskan parameter dalam badan permintaan agar menghindari kegagalan permintaan akibat URL yang terlalu panjang.

    Catatan

    Anda hanya dapat menentukan salah satu dari parameter berikut: TemplateBody, TemplateURL, TemplateId, dan TemplateScratchId.

    { "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

    Yes

    ID wilayah. Anda dapat memanggil operasi DescribeRegions untuk menanyakan daftar wilayah terbaru.

    cn-hangzhou
    TemplateURL

    string

    No

    URL file yang berisi isi template. URL tersebut harus mengarah ke template yang berada di server web HTTP atau HTTPS, atau di Bucket OSS Alibaba Cloud, seperti oss://ros/template/demo atau oss://ros/template/demo?RegionId=cn-hangzhou. Template harus memiliki panjang 1 hingga 524.288 byte. Jika wilayah OSS tidak ditentukan, nilai default-nya sama dengan parameter RegionId.

    Catatan

    Anda hanya dapat menentukan salah satu dari parameter TemplateBody, TemplateURL, dan TemplateId.

    oss://ros-template/demo
    TemplateId

    string

    No

    ID template. Parameter ini berlaku untuk Template bersama dan template pribadi.

    Catatan

    Anda hanya dapat menentukan salah satu dari parameter TemplateBody, TemplateURL, dan TemplateId.

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

    string

    No

    Versi template. Jika Anda tidak menentukan parameter ini, versi terbaru yang akan digunakan.

    Catatan

    TemplateVersion hanya berlaku ketika TemplateId ditentukan.

    v1
    Parameters

    array<object>

    No

    Parameter yang didefinisikan dalam template.

    object

    No

    ParameterKey

    string

    Yes

    Nama parameter yang didefinisikan dalam template.

    Catatan

    Parameter Parameters bersifat opsional. Jika Anda menentukan Parameters, Anda harus menentukan ParameterKey.

    ZoneInfo
    ParameterValue

    string

    Yes

    Nilai parameter yang didefinisikan dalam template.

    Catatan

    Parameter Parameters bersifat opsional. Jika Anda menentukan Parameters, Anda harus menentukan ParameterValue.

    cn-hangzhou-h
    ParametersKeyFilter

    array

    No

    Daftar parameter yang akan ditanyakan.

    string

    No

    Parameter yang akan ditanyakan.

    ZoneInfo
    ClientToken

    string

    No

    Token klien yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menghasilkan token tersebut di sisi klien, tetapi harus memastikan bahwa token tersebut unik di antara permintaan yang berbeda. Token dapat memiliki panjang hingga 64 karakter, dan boleh mengandung huruf, angka, tanda hubung (-), serta garis bawah (_). Untuk informasi selengkapnya, lihat How to ensure idempotence.

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

    array

    No

    Ketergantungan antar parameter.

    string

    No

    Urutan ketergantungan parameter.

    Catatan

    Secara default, ketergantungan parameter ditentukan oleh parameter Metadata dalam template.

    ["ZoneId", "InstanceType"]
    StackId

    string

    No

    ID stack.

    Jika Anda menentukan parameter ini, kendala parameter untuk skenario peningkatan dan penurunan akan ditanyakan.

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

    Elemen respons

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    ID permintaan.

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

    array<object>

    Informasi mengenai kendala parameter.

    array<object>

    ParameterKey

    string

    Nama parameter.

    ZoneInfo
    Type

    string

    Tipe parameter.

    String
    AllowedValues

    array

    Daftar nilai valid parameter.

    string

    Nilai valid parameter.

    cn-hangzhou-h
    Behavior

    string

    Perilaku parameter. Nilai yang valid:

    • NoLimit: Parameter tidak memiliki batasan pada nilai validnya.

    • NotSupport: Nilai valid parameter tidak dapat ditanyakan.

    • QueryError: Permintaan gagal.

    Catatan

    Jika AllowedValues tidak dikembalikan, Behavior dan BehaviorReason akan dikembalikan untuk menunjukkan perilaku parameter dan alasan di balik perilaku tersebut.

    NoLimit
    BehaviorReason

    string

    Alasan di balik perilaku parameter.

    No resource property refer to the parameter
    AssociationParameterNames

    array

    Nama parameter yang terkait.

    string

    Nama parameter yang terkait.

    InstanceType
    IllegalValueByParameterConstraints

    array

    Nilai-nilai yang tidak sesuai dengan kendala parameter.

    Catatan

    Jika AllowedValues dikembalikan, IllegalValueByParameterConstraints dan IllegalValueByRules akan dikembalikan untuk menunjukkan nilai-nilai tidak valid yang difilter oleh kendala parameter dan aturan template.

    any

    Nilai yang tidak sesuai dengan kendala parameter.

    Catatan

    Jika AllowedValues dikembalikan, nilai-nilai tidak valid yang difilter oleh kendala parameter dan aturan template akan dikembalikan dalam parameter IllegalValueByParameterConstraints dan IllegalValueByRules.

    cn-hangzhou-h
    IllegalValueByRules

    array

    Nilai-nilai yang tidak sesuai dengan aturan template.

    Catatan

    Jika AllowedValues dikembalikan, IllegalValueByParameterConstraints dan IllegalValueByRules akan dikembalikan untuk menunjukkan nilai-nilai tidak valid yang difilter oleh kendala parameter dan aturan template.

    any

    Nilai yang tidak sesuai dengan aturan template.

    Catatan

    Jika AllowedValues dikembalikan, nilai-nilai tidak valid yang difilter oleh kendala parameter dan aturan template akan dikembalikan dalam parameter IllegalValueByParameterConstraints dan IllegalValueByRules.

    cn-hangzhou-h
    NotSupportResources

    array<object>

    Detail resource yang tidak didukung.

    object

    Detail resource yang tidak didukung.

    Parameter ini dikembalikan ketika nilai Behavior adalah NotSupport.

    ResourceType

    string

    Tipe resource.

    ALIYUN::ECS::InstanceGroup
    PropertyName

    string

    Nama properti resource.

    InstanceName
    QueryErrors

    array<object>

    Detail kegagalan permintaan.

    object

    Detail kegagalan permintaan.

    Parameter ini dikembalikan ketika nilai Behavior adalah QueryError.

    ErrorMessage

    string

    Detail error.

    ALIYUN::ECS::InstanceGroup
    ResourceName

    string

    Nama resource.

    MyECS
    ResourceType

    string

    Tipe resource.

    InstanceType is needed while query DataDisk
    OriginalConstraints

    array<object>

    Informasi mengenai kendala asli.

    object

    Informasi mengenai kendala asli.

    ResourceName

    string

    Nama resource yang didefinisikan dalam template.

    MyECS
    AllowedValues

    array

    Daftar nilai valid parameter.

    any

    Nilai valid parameter.

    cn-hangzhou-a
    ResourceType

    string

    Tipe resource.

    ALIYUN::ECS::InstanceGroup

    PropertyName

    string

    Nama properti.

    ZoneId
    Behavior

    string

    Perilaku parameter.

    QueryError
    BehaviorReason

    string

    Alasan di balik perilaku parameter.

    No resource property refer to the parameter
    PropertiesData

    string

    Parameter kueri yang digunakan selama proses penanyaan kendala parameter.

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

    string

    Informasi permintaan dari operasi yang dipanggil untuk menanyakan kendala parameter layanan cloud.

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

    array<object>

    Detail timeout kueri.

    object

    Detail timeout kueri.

    ResourceType

    string

    Tipe resource.

    ALIYUN::RDS::DBInstance
    ResourceName

    string

    Nama resource.

    rds
    ErrorMessage

    string

    Pesan error.

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

    Contoh

    Respons sukses

    JSONformat

    {
  "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"
        }
      ]
    }
  ]
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.