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"
    }
  ]
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。