DescribeSandboxTemplates-阿里云帮助中心

Lists the sandbox templates you can use to create Supabase sandboxes.

Operation description

Applicable engine

RDS Supabase

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-beijing
InstanceName	string	Yes	The ID of the RDS Supabase instance.	ra-supabase-8moov5lxba****
TemplateName	string	No	The name of the sandbox template.	code-interpreter
PageSize	integer	No	The page size.	10
PageNumber	integer	No	The page number.	1
MaxResults	integer	No	This parameter is reserved.	None
NextToken	string	No	The pagination token used to retrieve the next page of results. You do not need to specify this parameter for the first request.	gAAAAABo-D-ze1Zog63nWMa8eDDMkqUoBB5-FDsHDUMiNIDSDZeP9g0LwJEozulOPG_LbsGwLRgmDFvTHZeSU90YsukT0pHtnA==

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	FE9C65D7-930F-57A5-A207-8C396329****
TotalCount	integer	The total number of entries that match the query.	20
MaxResults	integer	This parameter is reserved.	None
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries returned on the current page.	10
SandboxTemplates	array<object>	A list of sandbox templates.
	object	Details of a sandbox template.
Name	string	The name of the sandbox template.	code-interpreter
TemplateId	string	The ID of the sandbox template. Use this ID when you create a sandbox.	code-interpreter-asdxxxx
Description	string	The description of the sandbox template.	code-interpreter-vpc
DefaultCpu	string	The default number of CPUs for a sandbox created from this template.	2
DefaultMemory	string	The default memory size for a sandbox created from this template.	4Gi
EnableVpcAccess	string	Specifies whether sandboxes created from this template can access resources in the VPC of the parent RDS Supabase instance.	true
NextToken	string	The token to retrieve the next page of results. If this parameter is empty, all results have been returned.	AAAAAc3HCuYhJi/wvpk4xOr0VLYz/NvD85HpgBeRBCusEIeVQ0dHZH9jr+NP3X9Jx0iSoql55b9nd4PIDm252/a0f+U=

Examples

Success response

JSON format

{
  "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"
    }
  ],
  "NextToken": "AAAAAc3HCuYhJi/wvpk4xOr0VLYz/NvD85HpgBeRBCusEIeVQ0dHZH9jr+NP3X9Jx0iSoql55b9nd4PIDm252/a0f+U="
}

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectInstanceState	Current instance status does not support this operation.	The operation is not supported in the current instance state.
400	InvalidGroupName	Specified group name is not valid.	Invalid group name
400	InvalidParameter	The provided parameter is invalid.	Invalid parameter.
404	UserNotFound	User does not exist.	User does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.