获取一个模版,包括内容。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
oos:GetTemplate | get | *template acs:oos:{#regionId}:{#accountId}:template/{#templateName} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 否 | 地域 ID | cn-hangzhou |
TemplateName | string | 是 | 模板名称。内容限制为字母、数字、中划线、下划线,长度 200 字符。 | MyTemplate |
TemplateVersion | string | 否 | 模板版本。格式:“v”+数字。取值范围:v1-v200。 | v1 |
返回参数
示例
正常返回示例
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: <p class=\\\"p\\\">Note:</p> <ul class=\\\"ul\\\"> <li class=\\\"li\\\">Length is 2~128 English or Chinese characters</li> <li class=\\\"li\\\"><font color='red'>must start with big or small letters or Chinese, not http:// and https://. </font></li> <li class=\\\"li\\\">Can contain numbers, colons (:), underscores (_), or dashes (-). </li> </ul>\\n zh-cn: <p class=\\\"p\\\">注意:</p> <ul class=\\\"ul\\\"> <li class=\\\"li\\\">长度为2~128个英文或中文字符</li> <li class=\\\"li\\\"><font color='red'>必须以大小字母或中文开头,不能以http://和https://开头。</font></li> <li class=\\\"li\\\">可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。</li> </ul>\\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"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-07-09 | API 内部配置变更,不影响调用 | 查看变更详情 |