GetTemplate - 获取模板信息

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

bpstudio:GetTemplate

get

*Template

acs:bpstudio::{#accountId}:template/{#TemplateId}

请求参数

名称

类型

必填

描述

示例值

TemplateId

string

模板 ID

XFKR6WYRVS24S07R

Region

string

模板区域

cn-hangzhou

ResourceGroupId

string

资源组 ID

rg-aekzhfgmw4e6fwq

返回参数

名称

类型

描述

示例值

object

Message

string

错误信息

Success

RequestId

string

请求 ID

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

Data

object

模板详情

Description

string

模板描述

ImageURL

string

模板架构图片文件路径

bp-studio-template/sr-U37UD2YQCRJ75X5V.png

Name

string

模板名称

cadt-template

TemplateId

string

模板 ID

XFKR6WYRVS24S07R

CreateTime

string

创建时间

2020-09-22 17:08:31

ResourceGroupId

string

资源组 ID

rg-aekzhfgmw4e6fwq

Variables

array<object>

模板变量详情

object

Attribute

string

变量名

instance_name

DataType

string

变量类型

String

DefaultValue

string

默认值

cadt-app-01

Variable

string

变量值

${name}

Options

string

DocumentUrl

string

场景详情

Code

integer

返回码

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}",
        "Options": ""
      }
    ],
    "DocumentUrl": ""
  },
  "Code": 200
}

错误码

HTTP status code

错误码

错误信息

描述

200 Success The transaction is successful.
400 ParameterEmpty You must specify the request parameter. 您必须指定请求参数。
500 ServiceError A server error occurred. Please try again later. 服务器异常,请稍后再试
404 EntityNotExist.ResourceGroup The resource group does not exist. 资源组不存在
404 EntityNotExist.ResourceId The resource does not exist. 资源不存在

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

变更历史

更多信息,参考变更详情