DescribeModelService - 查询模型服务

更新时间:

查询模型服务

接口说明

使用说明

本接口用于查看模型服务的详细信息。

QPS 限制

本接口的单用户 QPS 限制默认为 1000 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
gpdb:DescribeModelServiceget
*DBInstance
acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。

说明 您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情,包括实例 ID。
gp-xxxxxxxxx
ModelServiceIdstring

模型服务 id

mx-xxxxxxxxx

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

ABB39CC3-4488-4857-905D-2E4A051D0521
ModelServiceIdstring

模型服务 ID。

ms-xxxxxxxxx
ModelNamestring

模型名称。

Qwen3-Embedding-8B
Statusstring

模型服务状态。

- deployming - active
PublicConnectUrlstring

公网连接串。

http://ms-xxxxxxx-o.xxxx.rds.aliyuncs.com
PrivateConnectUrlstring

内网连接串。

http://ms-xxxxxxx.xxxx.rds.aliyuncs.com
SecurityIpListstring

IP 白名单分组下的 IP 列表,以逗号隔开

127.0.0.1
CreateTimestring

创建时间。

2019-09-08T16:00:00Z
ApiKeystring

API Key 内容

cx/Y57lTNf*********
Descriptionstring

描述信息。

test
ModelParamsobject

模型参数。

暂未开放
AiNodesarray

AINode 列表。

aiNodesstring

AINode 名称。

ai-xxxxxxxxx

示例

正常返回示例

JSON格式

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "ModelServiceId": "ms-xxxxxxxxx",
  "ModelName": "Qwen3-Embedding-8B",
  "Status": "- deployming\n- active",
  "PublicConnectUrl": "http://ms-xxxxxxx-o.xxxx.rds.aliyuncs.com",
  "PrivateConnectUrl": "http://ms-xxxxxxx.xxxx.rds.aliyuncs.com",
  "SecurityIpList": "127.0.0.1",
  "CreateTime": "2019-09-08T16:00:00Z",
  "ApiKey": "cx/Y57lTNf*********",
  "Description": "test",
  "ModelParams": {
    "test": "test",
    "test2": 1
  },
  "AiNodes": [
    "ai-xxxxxxxxx"
  ]
}

错误码

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