DescribeModelApis - 查询模型 API - 云原生数据库 PolarDB

查询模型 API

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

polardb:DescribeModelApis

none

*全部资源

*

无

请求语法

POST  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
GwClusterId	string	是	网关实例 ID。	pg-xxxxxxxxxx
ModelApiIds	string	否	模型 APIID。	mi-xxx,mi-xxxx
Name	string	否	模型 API 名称	testName
ModelCategory	string	否	分类：枚举值： text embedding rerank	text
PageNumber	integer	否	页码。	1
PageSize	integer	否	每页记录数，取值范围如下： 30 50 100 默认值为 30。	30
PathPrefix	string	否	API 路径前缀	/test
Protocol	string	否	协议,枚举值： openai anthropic bailian vllm	openai
Status	string	否	模型 API 状态	Enable
RegionId	string	否	地域 ID。	cn-beijing

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	C61892A4-0850-4516-9E26-44D96C1782DE
TotalRecordCount	integer	总记录数。	1
PageRecordCount	integer	本页记录数。	30
PageNumber	integer	页码。	1
PageSize	integer	每页记录数，取值为 30、50 或 100。默认值为 30。	30
Items	array<object>	模型 API 列表
	object	模型 API 对象
ModelApiId	string	模型 APIID。	mi-xxxx
Name	string	模型 API 名称	testName
Category	string	分类：枚举值： text embedding rerank	text
Status	string	模型 API 状态	Enable
Protocol	string	协议,枚举值： openai anthropic bailian vllm	openai
PathPrefix	string	API 路径前缀	tests/models/
RecordInput	string	输入点数	10
RecordOutput	string	输出点数	10
RouteRules	string	路由规则列表（JSON 数组字符串）	[ { "RuleName": "string", "FallbackMode": "failover", "MatchModelListJson": "[]", "providerBalancerAlgorithm": "round-robin", "Providers": [ { "ModelServiceName": "string", "Weight": "0", "model_protocol": "vllm" "ModelList": "[]" } ], "FallbackProviders": [ { "ModelServiceName": "string", "model_protocol": "anthropic", "Weight": "10", "ModelList": "[]" } ] } ]
GmtCreated	string	创建时间	2024-10-16 16:46:20

示例

正常返回示例

JSON格式

{
  "RequestId": "C61892A4-0850-4516-9E26-44D96C1782DE",
  "TotalRecordCount": 1,
  "PageRecordCount": 30,
  "PageNumber": 1,
  "PageSize": 30,
  "Items": [
    {
      "ModelApiId": "mi-xxxx",
      "Name": "testName",
      "Category": "text",
      "Status": "Enable",
      "Protocol": "openai",
      "PathPrefix": "tests/models/",
      "RecordInput": "10",
      "RecordOutput": "10",
      "RouteRules": "[\n  {\n    \"RuleName\": \"string\",\n    \"FallbackMode\": \"failover\",\n    \"MatchModelListJson\": \"[]\",\n    \"providerBalancerAlgorithm\": \"round-robin\",\n    \"Providers\": [\n      {\n        \"ModelServiceName\": \"string\",\n        \"Weight\": \"0\",\n        \"model_protocol\": \"vllm\"\n        \"ModelList\": \"[]\"\n      }\n    ],\n    \"FallbackProviders\": [\n      {\n        \"ModelServiceName\": \"string\",\n        \"model_protocol\": \"anthropic\",\n        \"Weight\": \"10\",\n        \"ModelList\": \"[]\"\n      }\n    ]\n  }\n]",
      "GmtCreated": "2024-10-16 16:46:20\n"
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。