Deploy an AI Model Service with CreateModelService API - AnalyticDB for PostgreSQL

Creates a model service.

Operation description

Before you call this API, make sure you understand the billing methods and pricing of AnalyticDB for PostgreSQL.

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

gpdb:CreateModelService

create

*DBInstance

acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The ID of the instance. Note You can call the DescribeDBInstances API to query the IDs of all AnalyticDB for PostgreSQL instances in a specific region.	gp-xxxxxxxxx
ModelName	string	Yes	The name of the model.	Qwen3-Embedding-8B
Description	string	No	The description of the model service.	test
SecurityIPList	string	No	The IP whitelist. A value of `127.0.0.1` blocks all external IP addresses from accessing the service. After the service is created, you can call the ModifySecurityIps API to modify the IP whitelist.	127.0.0.1
AiNodes	array	Yes	A list of AI nodes for model deployment.
	string	No	The name of the AI node.	ai-xxxxxx
ModelParams	object	No	The model parameters. This feature is not yet supported.	暂未开放
ResourceGroupId	string	No	The ID of the resource group to which the instance belongs. For more information about how to obtain a resource group ID, see View the basic information of a resource group.	rg-bp67acfmxazb4p****
ClientToken	string	No	A token that ensures the idempotency of the request. For more information, see How to ensure idempotence.	0c593ea1-3bea-11e9-b96b-88**********
Replicas	integer	No	The number of replicas for the model service.	1
InferenceEngine	string	No	The inference engine. Currently, only `vllm` is supported.	vllm
EnablePublicConnection	boolean	No

Response elements

Element	Type	Description	Example
	object	The response object.
ModelServiceId	string	The ID of the model service.	ms-xxxxxxxxx
RequestId	string	The request ID.	ABB39CC3-4488-4857-905D-2E4A051D0521

Examples

Success response

JSON format

{
  "ModelServiceId": "ms-xxxxxxxxx",
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.