ListModelServices - 查询所有模型服务

更新时间:

查询所有模型服务

接口说明

使用说明

本接口用于查看所有模型服务信息。

QPS 限制

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

调试

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

授权信息

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

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

请求参数

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

地域 ID。

cn-hangzhou
DBInstanceIdstring

实例 ID。

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

每页记录数,取值说明:

  • 20
  • 50
  • 100

默认值:20

30
PageNumberinteger

页码。

1

返回参数

名称类型描述示例值
object
PageNumberinteger

当前页码。

1
PageRecordCountinteger

当前页记录数。

1
TotalRecordCountinteger

总记录数。

2
RequestIdstring

请求 ID。

ABB39CC3-4488-4857-905D-2E4A051D0521
ModelServicesarray<object>

模型服务列表

modelServiceInfosobject

模型服务列表

Statusstring

API 执行状态,取值如下:

  • success:执行成功。
  • fail:执行失败。
success
Descriptionstring

描述信息。

test description
ModelNamestring

设备型号名称。

sambert-zhiying-v1
ApiKeystring

API Key 内容

mI3F7B18vgfqJjUtWmgITw==
SecurityIPListstring

IP 白名单分组下的 IP 列表,最多 1000 个以逗号隔开,有以下三种格式:

  • 0.0.0.0/0
  • 10.23.12.24(IP)
  • 10.23.12.24/24(CIDR 模式,无类域间路由,/24表示了地址中前缀的长度,范围为[1,32]
0.0.0.0/0
PublicConnUrlstring

公网连接地址。

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

创建时间。

2024-09-28T02:18:39Z
ModelServiceIdstring

模型服务 ID。

mx-xxxxxxxxx
PrivateConnUrlstring

私网连接地址。

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

模型部署使用的 AINode 列表。

aiNodesstring

AINode 名称。

ai-xxxxxxxxx
ModelParamsobject

模型服务参数(暂未开放)。

string

暂未开放。

暂未开放。

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "PageRecordCount": 1,
  "TotalRecordCount": 2,
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "ModelServices": [
    {
      "Status": "success",
      "Description": "test description",
      "ModelName": "sambert-zhiying-v1",
      "ApiKey": "mI3F7B18vgfqJjUtWmgITw==",
      "SecurityIPList": "0.0.0.0/0",
      "PublicConnUrl": "http://ms-xxxxxxx-o.xxxx.rds.aliyuncs.com",
      "CreateTime": "2024-09-28T02:18:39Z",
      "ModelServiceId": "mx-xxxxxxxxx",
      "PrivateConnUrl": "http://ms-xxxxxxx.xxxx.rds.aliyuncs.com",
      "AiNodes": [
        "ai-xxxxxxxxx"
      ],
      "ModelParams": {
        "key": "暂未开放。"
      }
    }
  ]
}

错误码

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