すべてのプロダクト
Search
ドキュメントセンター

CloudOps Orchestration Service:GetTemplate

最終更新日:Dec 23, 2025

テンプレートとその内容を取得します。

今すぐお試しください

この 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:GetTemplate

get

*template

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

  • oos:tag
  • oos:TLSVersion
なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

任意

リージョン ID。

cn-hangzhou

TemplateName

string

必須

テンプレートの名前。名前の長さは最大 200 文字で、英字、数字、ハイフン (-)、アンダースコア (_) を使用できます。

MyTemplate

TemplateVersion

string

任意

テンプレートのバージョン。フォーマットは v の後に数字が続きます。有効な値:v1 から v200

v1

レスポンスフィールド

フィールド

説明

object

Content

string

テンプレートのコンテンツ。

"FormatVersion: OOS-2019-06-01\nDescription:\n en: Creates an ECS image\n zh-cn: 创建一个ECS镜像\n name-en: Create Image\n name-zh-cn: 创建镜像\n categories:\n - image_manage\n - application_manage\nParameters:\n regionId:\n Type: String\n Label:\n en: RegionId\n zh-cn: 地域ID\n AssociationProperty: RegionId\n Default: '{{ ACS::RegionId }}'\n instanceId:\n Label:\n en: InstanceId\n zh-cn: ECS实例ID\n Type: String\n AssociationProperty: ALIYUN::ECS::Instance::InstanceId\n AssociationPropertyMetadata:\n RegionId: regionId\n imageName:\n Label:\n en: ImageName\n zh-cn: 新镜像的名称\n Type: String\n Description:\n en:

Note:

  • Length is 2~128 English or Chinese characters
  • must start with big or small letters or Chinese, not http:// and https://.
  • Can contain numbers, colons (:), underscores (_), or dashes (-).
\n zh-cn:

注意:

  • 长度为2~128个英文或中文字符
  • 必须以大小字母或中文开头,不能以http://和https://开头。
  • 可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。
\n tags:\n Label:\n en: Tags\n zh-cn: 镜像标签\n Type: Json\n AssociationProperty: Tags\n AssociationPropertyMetadata:\n ShowSystem: false\n Default: []\n OOSAssumeRole:\n Label:\n en: OOSAssumeRole\n zh-cn: OOS扮演的RAM角色\n Type: String\n Default: OOSServiceRole\nRamRole: '{{ OOSAssumeRole }}'\nTasks:\n- Name: createImage\n Action: ACS::ECS::CreateImage\n Description:\n en: Create new image with the specified image name and instance ID\n zh-cn: 通过指定实例ID和镜像名称创建新的镜像\n Properties:\n regionId: '{{ regionId }}'\n imageName: '{{ imageName }}__on_{{ ACS::ExecutionId }}_at_{{ Acs::CurrentDate }}'\n instanceId: '{{ instanceId }}'\n tags: '{{tags}}'\n Outputs:\n imageId:\n ValueSelector: imageId\n Type: String\nOutputs:\n imageId:\n Type: String\n Value: '{{ createImage.imageId }}'\nMetadata:\n ALIYUN::OOS::Interface:\n ParameterGroups:\n - Parameters:\n - regionId\n - instanceId\n Label:\n default:\n zh-cn: 选择实例\n en: Select Ecs Instances\n - Parameters:\n - imageName\n - tags\n Label:\n default:\n zh-cn: 镜像设置\n en: Image Configure\n - Parameters:\n - OOSAssumeRole\n Label:\n default:\n zh-cn: 高级选项\n en: Control Options"

RequestId

string

リクエスト ID。

5BBE2663-A18E-5261-9BBB-F4832F5294D9

Template

object

テンプレートのメタデータ。

Hash

string

テンプレートコンテンツの SHA-256 ハッシュ。

40fb5e3e08ef6c8a499ff7cd8441194f518028ad08338a84cb70c023a64576f1

UpdatedDate

string

テンプレートが更新された時間。

2022-04-26T08:37:07Z

UpdatedBy

string

テンプレートを更新したユーザー。

ACS

TemplateType

string

テンプレートのタイプ。

Automation

Tags

object

テンプレートのタグ。最大 20 個のキーと値のペアがサポートされます。

{"k1":"k2","k2":"v2"}

TemplateName

string

テンプレートの名前。

ACS-ECS-CreateImage

TemplateVersion

string

テンプレートのバージョン。フォーマットは v の後に 1 から始まる数字が続きます。

v15

TemplateFormat

string

テンプレートのフォーマット。これはシステムフィールドです。有効な値:JSON および YAML。

YAML

Description

string

テンプレートの説明。

"{\"en\": \"Creates an ECS image\", \"zh-cn\": \"创建一个ECS镜像\", \"name-en\": \"Create Image\", \"name-zh-cn\": \"创建镜像\", \"categories\": [\"image_manage\", \"application_manage\"]}"

ResourceGroupId

string

リソースグループ ID。

rg-acfmxsn4m4******

CreatedBy

string

テンプレートを作成したユーザー。

ACS

CreatedDate

string

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

2019-05-16T10:26:14Z

VersionName

string

バージョンの名前。

version15

TemplateId

string

テンプレート ID。

t-4bdb1745c171401883a2

HasTrigger

boolean

テンプレートにトリガーが含まれているかどうかを示します。

false

ShareType

string

テンプレートの共有タイプ。ユーザーが作成したテンプレートの共有タイプはプライベートです。

Public

SharedAccounts

string

テンプレートが共有されているアカウント。

["12345678"]

成功レスポンス

JSONJSON

{
  "Content": "\"FormatVersion: OOS-2019-06-01\\nDescription:\\n  en:  Creates an ECS image\\n  zh-cn: 创建一个ECS镜像\\n  name-en: Create Image\\n  name-zh-cn: 创建镜像\\n  categories:\\n    - image_manage\\n    - application_manage\\nParameters:\\n  regionId:\\n    Type: String\\n    Label:\\n      en: RegionId\\n      zh-cn: 地域ID\\n    AssociationProperty: RegionId\\n    Default: '{{ ACS::RegionId }}'\\n  instanceId:\\n    Label:\\n      en: InstanceId\\n      zh-cn: ECS实例ID\\n    Type: String\\n    AssociationProperty: ALIYUN::ECS::Instance::InstanceId\\n    AssociationPropertyMetadata:\\n      RegionId: regionId\\n  imageName:\\n    Label:\\n      en: ImageName\\n      zh-cn: 新镜像的名称\\n    Type: String\\n    Description:\\n      en: 
Note:  
Length is 2~128 English or Chinese characters 
must start with big or small letters or Chinese, not http:// and https://.  
Can contain numbers, colons (:), underscores (_), or dashes (-).  \\n      zh-cn: 
注意:  
长度为2~128个英文或中文字符 
必须以大小字母或中文开头,不能以http://和https://开头。 
可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。 \\n  tags:\\n    Label:\\n      en: Tags\\n      zh-cn: 镜像标签\\n    Type: Json\\n    AssociationProperty: Tags\\n    AssociationPropertyMetadata:\\n      ShowSystem: false\\n    Default: []\\n  OOSAssumeRole:\\n    Label:\\n      en: OOSAssumeRole\\n      zh-cn: OOS扮演的RAM角色\\n    Type: String\\n    Default: OOSServiceRole\\nRamRole: '{{ OOSAssumeRole }}'\\nTasks:\\n- Name: createImage\\n  Action: ACS::ECS::CreateImage\\n  Description:\\n    en: Create new image with the specified image name and instance ID\\n    zh-cn: 通过指定实例ID和镜像名称创建新的镜像\\n  Properties:\\n    regionId: '{{ regionId }}'\\n    imageName: '{{ imageName }}__on_{{ ACS::ExecutionId }}_at_{{ Acs::CurrentDate }}'\\n    instanceId: '{{ instanceId }}'\\n    tags: '{{tags}}'\\n  Outputs:\\n    imageId:\\n      ValueSelector: imageId\\n      Type: String\\nOutputs:\\n  imageId:\\n    Type: String\\n    Value: '{{ createImage.imageId }}'\\nMetadata:\\n  ALIYUN::OOS::Interface:\\n    ParameterGroups:\\n      - Parameters:\\n          - regionId\\n          - instanceId\\n        Label:\\n          default:\\n            zh-cn: 选择实例\\n            en: Select Ecs Instances\\n      - Parameters:\\n          - imageName\\n          - tags\\n        Label:\\n          default:\\n            zh-cn: 镜像设置\\n            en: Image Configure\\n      - Parameters:\\n          - OOSAssumeRole\\n        Label:\\n          default:\\n            zh-cn: 高级选项\\n            en: Control Options\"",
  "RequestId": "5BBE2663-A18E-5261-9BBB-F4832F5294D9",
  "Template": {
    "Hash": "40fb5e3e08ef6c8a499ff7cd8441194f518028ad08338a84cb70c023a64576f1",
    "UpdatedDate": "2022-04-26T08:37:07Z",
    "UpdatedBy": "ACS",
    "TemplateType": "Automation",
    "Tags": {
      "k1": "k2",
      "k2": "v2"
    },
    "TemplateName": "ACS-ECS-CreateImage",
    "TemplateVersion": "v15",
    "TemplateFormat": "YAML",
    "Description": "\"{\\\"en\\\": \\\"Creates an ECS image\\\", \\\"zh-cn\\\": \\\"创建一个ECS镜像\\\", \\\"name-en\\\": \\\"Create Image\\\", \\\"name-zh-cn\\\": \\\"创建镜像\\\", \\\"categories\\\": [\\\"image_manage\\\", \\\"application_manage\\\"]}\"",
    "ResourceGroupId": "rg-acfmxsn4m4******",
    "CreatedBy": "ACS",
    "CreatedDate": "2019-05-16T10:26:14Z",
    "VersionName": "version15",
    "TemplateId": "t-4bdb1745c171401883a2",
    "HasTrigger": false,
    "ShareType": "Public",
    "SharedAccounts": "[\"12345678\"]"
  }
}

エラーコード

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

変更履歴

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