DescribeModelOperator - 查看 RDS AI 助手旗舰版基础信息和用量

更新时间:
复制 MD 格式

查看 RDS AI 助手旗舰版基础信息和用量。

接口说明

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

rdsai:DescribeModelOperator

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

Region

string

单元

cn-beijing

InstanceId

string

实例名

rds_copilot***_public_cn-*********6

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

Id of the request

FE9C65D7-930F-57A5-A207-8C396329241C

Success

boolean

请求结果。

true

Message

string

返回信息。

success

Data

object

请求结果。

TotalQuota

integer

当前周期总量(如当月总量)

200000000

UsedQuota

integer

当前周期用量(如当月用量)

1000000

AutoRenew

boolean

实例是否自动续费,取值:

  • true:是。

  • false(默认):否。

False

InstanceId

string

实例名

rds_copilot***_public_cn-*********6

InstanceClass

string

实例规格

xlarge

Status

string

模块状态

active/creating

StartTime

integer

实例开始时间(格式:Timestamp)

1772439028000

EndTime

integer

实例结束时间(格式:Timestamp)

1775145600000

ApiKey

string

系统 API Key

sk-rds-xxx

BaseUrl

string

模型调用 url

http://xxx.yy/v1

ChargeType

string

付费类型。

PREPAY / POSTPAY

DailyUsage

array<object>

每日用量列表

object

Date

string

日期(精确到天)

2026-03-31

Usage

integer

Token 用量

100000

KeyUsageList

array<object>

每个 key 的独立用量(包含已删除 key)

array<object>

ApiKey

string

API Key

sk-rds-*****

KeyName

string

API Key 名

api-*****

KeyType

string

KEY 类型

fixed

KeyUsed

string

Token 总使用量

100000

DailyUsage

array<object>

API KEY 每日用量

object

Date

string

日期(精确到天)

2026-03-31

Usage

string

使用的 Token 数量

2000

UsedQuota

string

已使用的 Token 配额

2000000

Deleted

boolean

API KEY 是否已删除

fase

PrefixCacheEnabled

boolean

是否已开启前缀路由保持功能

false

SessionIds

array

用于路由保持的 header 列表,以小写字母、数字、分隔符(-)组成

string

具体的路由保持 header 字段

mo-sessionid

示例

正常返回示例

JSON格式

{
  "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,
    "SessionIds": [
      "mo-sessionid"
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述

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. UID并没有有效订单

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情