DescribeSandboxTemplates - 查询可用于创建沙箱的模板列表-云数据库 RDS(RDS)-阿里云帮助中心

查询用于创建Supabase沙箱的沙箱模板列表。

接口说明

适用引擎

RDS Supabase

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

rdsai:DescribeSandboxTemplates

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域。	cn-beijing
InstanceName	string	是	AI 应用的实例 ID。	ra-supabase-8moov5lxba****
BranchName	string	否
TemplateName	string	否	沙箱模板名称。	code-interpreter
PageSize	integer	否	每页记录数。	10
PageNumber	integer	否	页码。	1
MaxResults	integer	否	备用参数，无需关注。	None
NextToken	string	否	分页 token。	gAAAAABo-D-ze1Zog63nWMa8eDDMkqUoBB5-FDsHDUMiNIDSDZeP9g0LwJEozulOPG_LbsGwLRgmDFvTHZeSU90YsukT0pHtnA==

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	FE9C65D7-930F-57A5-A207-8C396329****
TotalCount	integer	TotalCount 本次请求条件下的数据总量。	20
MaxResults	integer	备用参数，无需关注。	None
PageNumber	integer	页码。	1
PageSize	integer	每页记录数。	10
SandboxTemplates	array<object>	沙箱模板列表。
	object	沙箱模板
Name	string	沙箱模板名称	code-interpreter
TemplateId	string	沙箱模板 id，使用该模板创建沙箱时指定。	code-interpreter-asdxxxx
Description	string	沙箱模板描述。	code-interpreter-vpc
DefaultCpu	string	使用该模板创建出来的沙箱的 cpu 个数。	2
DefaultMemory	string	使用该模板创建出来的沙箱的内存大小。	4Gi
EnableVpcAccess	string	使用该模板创建出来的沙箱，是否可以访问 Supabase 所在 vpc 内的资源。	true
Replicas	integer
CreatedBy	string
NextToken	string	用来表示当前开始读取的位置。置空表示从头开始。	AAAAAc3HCuYhJi/wvpk4xOr0VLYz/NvD85HpgBeRBCusEIeVQ0dHZH9jr+NP3X9Jx0iSoql55b9nd4PIDm252/a0f+U=

示例

正常返回示例

JSON格式

{
  "RequestId": "FE9C65D7-930F-57A5-A207-8C396329****",
  "TotalCount": 20,
  "MaxResults": 0,
  "PageNumber": 1,
  "PageSize": 10,
  "SandboxTemplates": [
    {
      "Name": "code-interpreter",
      "TemplateId": "code-interpreter-asdxxxx",
      "Description": "code-interpreter-vpc",
      "DefaultCpu": "2",
      "DefaultMemory": "4Gi",
      "EnableVpcAccess": "true",
      "Replicas": 0,
      "CreatedBy": ""
    }
  ],
  "NextToken": "AAAAAc3HCuYhJi/wvpk4xOr0VLYz/NvD85HpgBeRBCusEIeVQ0dHZH9jr+NP3X9Jx0iSoql55b9nd4PIDm252/a0f+U="
}

错误码

HTTP status code	错误码	错误信息	描述
400	IncorrectInstanceState	Current instance status does not support this operation.	当前实例状态不支持该操作
400	InvalidGroupName	Specified group name is not valid.	分组名称无效
400	InvalidParameter	The provided parameter is invalid.	无效的参数。
404	UserNotFound	User does not exist.	用户不存在。

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

变更历史

更多信息，参考变更详情。