DescribeModelService-阿里云帮助中心

Queries a model service.

Operation description

You can call this operation to query the details of a model service.

Rate limit

The maximum number of queries per second (QPS) per user for this operation is 1,000. If the number of calls exceeds the limit, throttling is triggered. Throttling may affect your business. Call this operation as needed.

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:DescribeModelService

get

*DBInstance

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID. Note You can call the DescribeDBInstances operation to query the details of all AnalyticDB for PostgreSQL instances in a region, including the instance ID.	gp-xxxxxxxxx
ModelServiceId	string	Yes	The model service ID.	mx-xxxxxxxxx

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	ABB39CC3-4488-4857-905D-2E4A051D0521
ModelServiceId	string	The model service ID.	ms-xxxxxxxxx
ModelName	string	The model name.	Qwen3-Embedding-8B
Status	string	The model service status.	- deployming - active
PublicConnectUrl	string	The public network connection string.	http://ms-xxxxxxx-o.xxxx.rds.aliyuncs.com
PrivateConnectUrl	string	The internal network connection string.	http://ms-xxxxxxx.xxxx.rds.aliyuncs.com
SecurityIpList	string	The list of IP addresses in the IP whitelist, separated by commas.	127.0.0.1
CreateTime	string	The creation time.	2019-09-08T16:00:00Z
ApiKey	string	The API key.	cx/Y57lTNf*********
Description	string	The description.	test
ModelParams	object	The model parameters.	Not yet available.
AiNodes	array	The list of AI nodes.
	string	The AI node name.	ai-xxxxxxxxx

Examples

Success response

JSON format

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "ModelServiceId": "ms-xxxxxxxxx",
  "ModelName": "Qwen3-Embedding-8B",
  "Status": "- deployming\n- active",
  "PublicConnectUrl": "http://ms-xxxxxxx-o.xxxx.rds.aliyuncs.com",
  "PrivateConnectUrl": "http://ms-xxxxxxx.xxxx.rds.aliyuncs.com",
  "SecurityIpList": "127.0.0.1",
  "CreateTime": "2019-09-08T16:00:00Z",
  "ApiKey": "cx/Y57lTNf*********",
  "Description": "test",
  "ModelParams": {
    "test": "test",
    "test2": 1
  },
  "AiNodes": [
    "ai-xxxxxxxxx"
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.