Lists AI services.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| DBInstanceId |
string |
Yes |
The ID of the AnalyticDB for PostgreSQL instance. Note
To view details of all AnalyticDB for PostgreSQL instances in a region, including their instance IDs, call the DescribeDBInstances operation. |
gp-xxxxxxxxx |
| Type |
string |
Yes |
The type of the AI service. Valid value: drama. |
drama |
| PageSize |
string |
No |
The number of entries to return on each page. Valid values:
Default value: 20. |
20 |
| PageNumber |
string |
No |
The page number of the returned page. |
1 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The ID of the request. |
ABB39CC3-4488-4857-905D-2E4A051D0521 |
| PageNumber |
string |
The page number of the current page. |
1 |
| PageRecordCount |
string |
The number of entries on the current page. |
1 |
| TotalRecordCount |
string |
The total number of entries. |
1 |
| Services |
array<object> |
The list of AI services. |
|
|
object |
The details of an AI service. |
||
| ServiceId |
string |
The ID of the AI service. |
drama-123456 |
| ServiceAccount |
string |
The service account. |
dramauser |
| Status |
string |
The status of the AI service. Valid values:
|
active |
| Description |
string |
The description of the AI service. |
dramatest |
| PublicWorkbenchUrl |
string |
The public endpoint of the Workbench. |
8.8.8.8 |
| PrivateWorkbenchUrl |
string |
The private endpoint of the Workbench. |
192.168.0.1 |
| PublicApiDevUrl |
string |
The public endpoint for API debugging. |
8.8.8.8/api-docs |
| PrivateApiDevUrl |
string |
The private endpoint for API debugging. |
192.168.0.1/api-docs |
| SecurityIpList |
string |
The list of IP addresses in the IP address whitelist group. Separate multiple IP addresses with commas. |
127.0.0.1 |
| CreateTime |
string |
The time when the AI service was created. |
2026-03-01T00:00:00Z |
Examples
Success response
JSON format
{
"RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
"PageNumber": "1",
"PageRecordCount": "1",
"TotalRecordCount": "1",
"Services": [
{
"ServiceId": "drama-123456",
"ServiceAccount": "dramauser",
"Status": "active",
"Description": "dramatest",
"PublicWorkbenchUrl": "8.8.8.8",
"PrivateWorkbenchUrl": "192.168.0.1",
"PublicApiDevUrl": "8.8.8.8/api-docs",
"PrivateApiDevUrl": "192.168.0.1/api-docs",
"SecurityIpList": "127.0.0.1",
"CreateTime": "2026-03-01T00:00:00Z"
}
]
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.