DescribeModelOperator-阿里云帮助中心

View basic information and usage for the RDS AI Assistant Ultimate Edition.

Operation description

Supported engines

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

rdsai:DescribeModelOperator

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The instance ID.	rds_copilot*_public_cn-*******6

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	FE9C65D7-930F-57A5-A207-8C396329241C
Success	boolean	Indicates whether the request was successful.	true
Message	string	The response message.	success
Data	object	The response data.
TotalQuota	integer	The total quota for the current cycle, such as the monthly quota.	200000000
UsedQuota	integer	The usage in the current cycle, such as the monthly usage.	1000000
AutoRenew	boolean	Indicates whether auto-renewal is enabled for the instance. Valid values: true: Enabled. false (default): Disabled.	False
InstanceId	string	The instance ID.	rds_copilot*_public_cn-*******6
InstanceClass	string	The instance type.	xlarge
Status	string	The status.	active/creating
StartTime	integer	The UNIX timestamp, in milliseconds, indicating when the instance started.	1772439028000
EndTime	integer	The UNIX timestamp, in milliseconds, indicating when the instance expires.	1775145600000
ApiKey	string	The API key.	sk-rds-xxx
BaseUrl	string	The endpoint URL for model requests.	http://xxx.yy/v1
ChargeType	string	The billing method. Valid values: `PREPAY` (subscription) and `POSTPAY` (pay-as-you-go).	PREPAY / POSTPAY
DailyUsage	array<object>	The daily token usage.
	object
Date	string	The date of the usage record.	2026-03-31
Usage	integer	The number of tokens used on this date.	100000
KeyUsageList	array<object>	The usage of each API key, including deleted keys.
	array<object>
ApiKey	string	The API key.	sk-rds-*****
KeyName	string	The name of the API key.	api-*****
KeyType	string	The type of the API key.	fixed
KeyUsed	string	The total number of tokens used by this API key.	100000
DailyUsage	array<object>	The daily usage for the API key.
	object
Date	string	The date of the usage record.	2026-03-31
Usage	string	The number of tokens used by the API key on this date.	2000
UsedQuota	string	The token usage for the current cycle.	2000000
Deleted	boolean	Indicates whether the API key has been deleted.	fase
PrefixCacheEnabled	boolean	Indicates whether prefix caching is enabled.

Examples

Success response

JSON format

{
  "RequestId": "FE9C65D7-930F-57A5-A207-8C396329241C",
  "Success": true,
  "Message": "success",
  "Data": {
    "TotalQuota": 200000000,
    "UsedQuota": 1000000,
    "AutoRenew": true,
    "InstanceId": "rds_copilot***_public_cn-*********6",
    "InstanceClass": "xlarge",
    "Status": "active/creating",
    "StartTime": 1772439028000,
    "EndTime": 1775145600000,
    "ApiKey": "sk-rds-xxx",
    "BaseUrl": "http://xxx.yy/v1",
    "ChargeType": "PREPAY / POSTPAY",
    "DailyUsage": [
      {
        "Date": "2026-03-31",
        "Usage": 100000
      }
    ],
    "KeyUsageList": [
      {
        "ApiKey": "sk-rds-*****",
        "KeyName": "api-*****",
        "KeyType": "fixed",
        "KeyUsed": "100000",
        "DailyUsage": [
          {
            "Date": "2026-03-31",
            "Usage": "2000"
          }
        ],
        "UsedQuota": "2000000",
        "Deleted": true
      }
    ],
    "PrefixCacheEnabled": false
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	MoInvalidIpWhitelistError	Invalid IP address or CIDR in whitelist.
400	MoDomainNotReadyError	Domain is not ready yet, please try again later.
403	InvalidUserOrder	There is no valid order for this UID.	There is no valid order for this UID

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.