ListModelServices - AnalyticDB - Alibaba Cloud Documentation Center

Queries all model services.

Operation description

Usage notes

This interface is used to view all model service information.

QPS limit

You can call this operation up to 1,000 times per second per account. Exceeding the limit will trigger API rate limiting, which may impact your business. Please call the API responsibly.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
gpdb:ListModelServices	get	*DBInstance `acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID of the cluster.	cn-hangzhou
DBInstanceId	string	Yes	The ID of the instance. Note You can call the DescribeDBInstances operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.	gp-xxxxxxxxx
PageSize	integer	No	The number of entries per page. Valid values: 20 50 100 Default value: 20.	30
PageNumber	integer	No	The page number of the returned page.	1

Response parameters

Parameter	Type	Description	Example
	object
PageNumber	integer	The page number of the returned page.	1
PageRecordCount	integer	The number of entries per page.	1
TotalRecordCount	integer	The total number of entries returned.	2
RequestId	string	Request ID.	ABB39CC3-4488-4857-905D-2E4A051D0521
ModelServices	array<object>	Model services.
modelServiceInfos	object	Model services.
Status	string	The status of the operation. Valid values: success fail	success
Description	string	The description.	test description
ModelName	string	The model name.	sambert-zhiying-v1
ApiKey	string	The API key.	mI3F7B18vgfqJjUtWmgITw==
SecurityIPList	string	The IP addresses listed in the whitelist. Up to 1,000 IP addresses are contained in a whitelist and separated by commas (,). The IP addresses must use one of the following formats: 0.0.0.0/0 10.23.12.24(IP) 10.23.12.24/24 (This is a CIDR block. The value`/24`indicates the network prefix length, which must be an integer and in the range of `[1,32]`.)	0.0.0.0/0
PublicConnUrl	string	Public endpoint.	http://ms-xxxxxxx-o.xxxx.rds.aliyuncs.com
CreateTime	string	The creation time.	2024-09-28T02:18:39Z
ModelServiceId	string	Model service ID.	mx-xxxxxxxxx
PrivateConnUrl	string	Private Endpoint.	http://ms-xxxxxxx.xxxx.rds.aliyuncs.com
AiNodes	array	A list of AI nodes for model deployment.
aiNodes	string	The name of the AI node.	ai-xxxxxxxxx
ModelParams	object	Model service parameters (not available).
	string	Not available.

Examples

Sample success responses

JSONformat

{
  "PageNumber": 1,
  "PageRecordCount": 1,
  "TotalRecordCount": 2,
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "ModelServices": [
    {
      "Status": "success",
      "Description": "test description",
      "ModelName": "sambert-zhiying-v1",
      "ApiKey": "mI3F7B18vgfqJjUtWmgITw==",
      "SecurityIPList": "0.0.0.0/0",
      "PublicConnUrl": "http://ms-xxxxxxx-o.xxxx.rds.aliyuncs.com",
      "CreateTime": "2024-09-28T02:18:39Z",
      "ModelServiceId": "mx-xxxxxxxxx",
      "PrivateConnUrl": "http://ms-xxxxxxx.xxxx.rds.aliyuncs.com",
      "AiNodes": [
        "ai-xxxxxxxxx"
      ],
      "ModelParams": {
        "key": ""
      }
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.