EnableAgentRuntime-阿里云帮助中心

Operation description

During the public preview, the sandbox and Edge Routine features are free of charge.

Before you begin

Before you use this feature, authorize the service-linked role. The service-linked role used is AliyunServiceRoleForRDSAISupabase.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

rdsai:EnableAgentRuntime

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID of the instance.	cn-beijing
InstanceName	string	Yes	The instance ID of the AI application.	ra-supabase-8moov5lxba****
VSwitchId	string	No	The vSwitch ID used to create an endpoint. If this parameter is not specified, the vSwitch of the Supabase instance is used by default. Important The endpoint is created only once. When the first Supabase instance in a VPC enables the sandbox and Edge Routine function capabilities, the system performs automatic creation of the endpoint. When subsequent Supabase instances in the same VPC enable these capabilities, the existing endpoint is reused and no new endpoint is created.	vsw-9dp2hkpm22gxscfgy****
SecurityGroupId	string	No	The security group ID used to create an endpoint. If not specified: The system performs automatic creation of a security group named sg-aliyun-rds-created-supabase-sandbox in the VPC where the instance resides. No manual operation is required. If specified: Make sure that the specified security group allows the CIDR block of the VPC where the Supabase instance resides in both the inbound and outbound directions. Otherwise, network connectivity issues may occur. Important The endpoint is created only once. When the first Supabase instance in a VPC enables the sandbox and Edge Routine function capabilities, the system performs automatic creation of the endpoint. When subsequent Supabase instances in the same VPC enable these capabilities, the existing endpoint is reused and no new endpoint is created.	sg-bp179qkbvlj8ym*****
ClientToken	string	No	The idempotency parameter.	0c593ea1-3bea-11e9-b96b-88e9fe637760

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	FE9C65D7-930F-57A5-A207-8C396329****
InstanceName	string	The instance ID of the AI application.	ra-supabase-8moov5lxba****

Examples

Success response

JSON format

{
  "RequestId": "FE9C65D7-930F-57A5-A207-8C396329****",
  "InstanceName": "ra-supabase-8moov5lxba****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.
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.
400	MissingServiceLinkedRole	%s.
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.