DescribeModelApis - PolarDB - Alibaba Cloud Documentation Center

API Kueri Model

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

polardb:DescribeModelApis

none

*全部资源

*

None

Sintaks permintaan

POST  HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
GwClusterId	string	Yes	ID instance gateway.	pg-xxxxxxxxxx
ModelApiIds	string	No	ID dari API model. Pisahkan beberapa ID dengan koma.	mi-xxx,mi-xxxx
Name	string	No	Nama dari API model.	testName
ModelCategory	string	No	Kategori model. Nilai yang valid: text embedding rerank	text
PageNumber	integer	No	Nomor halaman.	1
PageSize	integer	No	Jumlah entri per halaman. Nilai yang valid: 30 50 100 Nilai default adalah 30.	30
PathPrefix	string	No	Awalan path API.	/test
Protocol	string	No	Protokol. Nilai yang valid: openai anthropic bailian vllm	openai
Status	string	No	Status API model.	Enable
RegionId	string	No	ID region.	cn-beijing

Elemen respons

Element	Type	Description	Example
	object	Data yang dikembalikan.
RequestId	string	ID permintaan.	C61892A4-0850-4516-9E26-44D96C1782DE
TotalRecordCount	integer	Jumlah total record yang cocok dengan kueri.	1
PageRecordCount	integer	Jumlah record yang dikembalikan pada halaman saat ini.	30
PageNumber	integer	Nomor halaman.	1
PageSize	integer	Jumlah record yang dikembalikan per halaman. Nilai yang valid: 30, 50, dan 100. Nilai default: 30.	30
Items	array<object>	Daftar objek API Model.
	object	Objek API Model.
ModelApiId	string	ID API Model.	mi-xxxx
Name	string	Nama API Model.	testName
Category	string	Kategori model. Nilai yang valid: text embedding rerank	text
Status	string	Status API Model.	Enable
Protocol	string	Protokol. Nilai yang valid: openai anthropic bailian vllm	openai
PathPrefix	string	Awalan path API.	tests/models/
RecordInput	string	Jumlah record input.	10
RecordOutput	string	Jumlah record output.	10
RouteRules	string	Array JSON berisi aturan routing, diformat sebagai string.	[ { "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	Waktu pembuatan.	2024-10-16 16:46:20

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.