獲取模板列表,包括模板名稱、架構圖地址、架構圖序列化文件地址等。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
bpstudio:ListTemplate | get |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
NextToken | integer | 是 | 頁碼 | 1 |
MaxResults | integer | 是 | 分頁大小 | 10 |
OrderType | long | 否 | 排序字段:
| 1 |
Keyword | string | 否 | 搜索模板名稱關鍵字 | “CADT” |
Type | string | 是 | “public”代表開放模板,“private”代表私有模板。 | private |
TagList | integer | 否 | 模板的標簽 | 2 |
ResourceGroupId | string | 否 | 資源組 ID | rg-acfmyjt3c5om3hi |
返回參數
示例
正常返回示例
JSON
格式
{
"TotalCount": 100,
"Message": "Success",
"NextToken": 1,
"RequestId": "A07FFDF2-78FA-1B48-9E38-88E833A93187",
"Data": [
{
"ImageURL": "bp-studio-template/sr-U37UD2YQCRJ75X5V.png",
"TagId": 1,
"TagName": "官方模板",
"Name": "cadt-name",
"TemplateId": "CJQ6H0XUEQ20IYJQ",
"CreateTime": "2021-03-18 16:41:31",
"ResourceGroupId": "rg-acfmyjt3c5om3hi"
}
],
"Code": 200
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
200 | Success | The transaction is successful. | 交易成功 |
400 | ParameterEmpty | You must specify the request parameter. | 您必須指定請求參數。 |
404 | EntityNotExist.ResourceId | The resource does not exist. | 資源不存在 |
404 | EntityNotExist.ResourceGroup | The resource group does not exist. | 資源組不存在 |
500 | ServiceError | A server error occurred. Please try again later. | 服務器異常,請稍后再試 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-05-25 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |