全部產品
Search
文件中心

CloudOps Orchestration Service:GetTemplate - 擷取模版

更新時間:Dec 23, 2025

擷取一個模版,包括內容。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

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

模板內容的 SHA256

40fb5e3e08ef6c8a499ff7cd8441194f518028ad08338a84cb70c023a64576f1

UpdatedDate

string

模板更新時間

2022-04-26T08:37:07Z

UpdatedBy

string

模板更新者

ACS

TemplateType

string

模板類型

Automation

Tags

object

標籤鍵及值,索引值對數量限制為 1 至 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

模板共用類型。目前使用者建立的模板的共用類型均為 Private。

Public

SharedAccounts

string

已共用的帳號

["12345678"]

樣本

正常返回樣本

JSON格式

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情