All Products
Search
Document Center

AnalyticDB:DescribeAIService

Last Updated:Mar 19, 2026

Retrieves the details of an AI service.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

DBInstanceId

string

Yes

The ID of the instance.

Note

To view details of all instances in a region, including their IDs, call the DescribeDBInstances operation.

gp-xxxxxxxxx

Type

string

Yes

The type of service. Only drama is supported.

drama

ServiceId

string

Yes

The ID of the service.

drama-123456

Response elements

Element

Type

Description

Example

object

RequestId

string

The ID of the request.

ABB39CC3-4488-4857-905D-2E4A051D0521

ServiceId

string

The ID of the service.

drama-123456

ServiceAccount

string

The service account.

dramauser

Status

string

The status of the service. Valid values:

  • deploying: The service is being deployed.

  • active: The service is running.

active

Description

string

The description of the service.

dramatest

PublicWorkbenchUrl

string

The public endpoint of the Workbench.

8.8.8.8

PrivateWorkbenchUrl

string

The internal 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 internal endpoint for API debugging.

192.168.0.1/api-docs

SecurityIpList

string

A comma-separated list of IP addresses in the IP address whitelist group.

127.0.0.1

CreateTime

string

The time when the service was created.

2026-03-01T00:00:00Z

Examples

Success response

JSON format

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "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\n",
  "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.