GetTemplateParameterConstraints API での OOS テンプレートパラメータ制約のクエリ - CloudOps Orchestration Service (OOS)

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

oos:GetTemplateParameterConstraints

get

*Template

acs:oos:{#regionId}:{#accountId}:template/{#TemplateName}

oos:TLSVersion

なし

リクエストパラメーター

パラメーター	タイプ	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID。	cn-hangzhou
TemplateVersion	string	任意	テンプレートのバージョン。	v1
TemplateContent	string	任意	テンプレートのコンテンツ。コンテンツは JSON または YAML 形式である必要があります。	{ "Description": "Example template, describe instances in some status", "FormatVersion": "OOS-2019-06-01", "Parameters": {}, "Tasks": [{ "Name": "describeInstances", "Action": "ACS::ExecuteAPI", "Description": "desc-en", "Properties": { "Service": "ECS", "API": "DescribeInstances", "Parameters": { "Status": "Running" } } }] }
TemplateName	string	任意	テンプレートの名前。名前に使用できる文字は、英字、数字、ハイフン（-）、およびアンダースコア（_）です。名前は最大 200 文字まで使用できます。	MyTemplate
TemplateURL	string	任意	テンプレート本文を含むファイルの URL。 URL は、Web サーバー（HTTP または HTTPS）上、または Alibaba Cloud Object Storage Service (OSS) バケット内にあるテンプレートを指している必要があります (例: oss://ros/template/demo または oss://ros/template/demo?RegionId=cn-hangzhou)。テンプレートのサイズは最大 524,288 バイトです。 OSS バケットのリージョンを指定しない場合は、RegionId パラメーターで指定されたリージョンが使用されます。説明 TemplateContent、TemplateURL、および TemplateId パラメーターのうち、指定できるのは 1 つだけです。	http://oos-template.cn-hangzhou.oss.aliyun-inc.com/oos-test-template.json
Parameters	string	任意	テンプレートのパラメーター。	{\"endDate\": \"2022-04-13T03:31:20Z\", \"Status\": \"Stopped\"}

レスポンスパラメーター

パラメーター	タイプ	説明	例
	object
RequestId	string	リクエスト ID。	CBEC8072-BEC2-478E-8EAE-E723BA79CF19
ParameterConstraints	object	パラメーターの制約に関する情報。	[ { "Type": "String", "AllowedValues": [ "ecs.n1.tiny", "ecs.r8a.4xlarge", "ecs.n2.xlarge", "ecs.c7.2xlarge", "ecs.c8i.4xlarge", "ecs.g8i.48xlarge", "ecs.c8a.4xlarge", "ecs.i2.4xlarge", "ecs.r8y.2xlarge" ], "AssociationParameterNames": [ "RegionId", "zoneId" ], "ParameterKey": "instanceType" }, { "Type": "String", "AllowedValues": [], "AssociationParameterNames": [ "RegionId", "zoneId", "InstanceType" ], "ParameterKey": "systemDiskCategory" } ]

例

成功レスポンス

JSONJSON

{
  "RequestId": "CBEC8072-BEC2-478E-8EAE-E723BA79CF19",
  "ParameterConstraints": [
    {
      "Type": "String",
      "AllowedValues": [
        "ecs.n1.tiny",
        "ecs.r8a.4xlarge",
        "ecs.n2.xlarge",
        "ecs.c7.2xlarge",
        "ecs.c8i.4xlarge",
        "ecs.g8i.48xlarge",
        "ecs.c8a.4xlarge",
        "ecs.i2.4xlarge",
        "ecs.r8y.2xlarge"
      ],
      "AssociationParameterNames": [
        "RegionId",
        "zoneId"
      ],
      "ParameterKey": "instanceType"
    },
    {
      "Type": "String",
      "AllowedValues": [],
      "AssociationParameterNames": [
        "RegionId",
        "zoneId",
        "InstanceType"
      ],
      "ParameterKey": "systemDiskCategory"
    }
  ]
}

エラーコード

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

変更履歴

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