文档

GetTemplate - 获取模板信息

更新时间:

获取模板图片及架构图相关信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
bpstudio:GetTemplateRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
TemplateIdstring

模板 ID

XFKR6WYRVS24S07R
Regionstring

模板区域

cn-hangzhou
ResourceGroupIdstring

资源组 ID

rg-aekzhfgmw4e6fwq

返回参数

名称类型描述示例值
object
Messagestring

错误信息

Success
RequestIdstring

请求 ID

A07FFDF2-78FA-1B48-9E38-88E833A93187
Dataobject

模板详情

Descriptionstring

模板描述

ImageURLstring

模板架构图片文件路径

bp-studio-template/sr-U37UD2YQCRJ75X5V.png
Namestring

模板名称

cadt-template
TemplateIdstring

模板 ID

XFKR6WYRVS24S07R
CreateTimestring

创建时间

2020-09-22 17:08:31
ResourceGroupIdstring

资源组 ID

rg-aekzhfgmw4e6fwq
Variablesobject []

模板变量详情

Attributestring

变量名

instance_name
DataTypestring

变量类型

String
DefaultValuestring

默认值

cadt-app-01
Variablestring

变量值

${name}
Codeinteger

返回码

200

示例

正常返回示例

JSON格式

{
  "Message": "Success",
  "RequestId": "A07FFDF2-78FA-1B48-9E38-88E833A93187",
  "Data": {
    "Description": "无",
    "ImageURL": "bp-studio-template/sr-U37UD2YQCRJ75X5V.png",
    "Name": "cadt-template",
    "TemplateId": "XFKR6WYRVS24S07R",
    "CreateTime": "2020-09-22 17:08:31",
    "ResourceGroupId": "rg-aekzhfgmw4e6fwq",
    "Variables": [
      {
        "Attribute": "instance_name",
        "DataType": "String",
        "DefaultValue": "cadt-app-01",
        "Variable": "${name}"
      }
    ]
  },
  "Code": 200
}

错误码

HTTP status code错误码错误信息描述
200SuccessThe transaction is successful.交易成功
400ParameterEmptyYou must specify the request parameter.-
404EntityNotExist.ResourceGroupThe resource group does not exist.资源组不存在
404EntityNotExist.ResourceIdThe resource does not exist.资源不存在
500ServiceErrorA server error occurred. Please try again later.服务器异常,请稍后再试

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-05-25OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:200
    删除错误码:400
    删除错误码:404
    删除错误码:500
出参OpenAPI 返回结构发生变更
2023-03-30OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:200
    删除错误码:400
    删除错误码:404
    删除错误码:500
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈