DescribeModelApis - PolarDB - Centro de documentación de Alibaba Cloud

Consulta las API de modelos.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

polardb:DescribeModelApis

none

*All Resource

*

Ninguna

Sintaxis de la solicitud

POST  HTTP/1.1

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
GwClusterId	string	Sí	El ID de la instancia de gateway.	pg-xxxxxxxxxx
ModelApiIds	string	No	Los ID de las API de modelos.	mi-xxx,mi-xxxx
Name	string	No	El nombre de la API del modelo.	testName
ModelCategory	string	No	La categoría del modelo. Valores válidos: text embedding rerank	text
PageNumber	integer	No	El número de página.	1
PageSize	integer	No	El número de entradas por página. Valores válidos: 30 50 100 Valor predeterminado: 30.	30
PathPrefix	string	No	El prefijo de ruta de la API.	/test
Protocol	string	No	El protocolo. Valores válidos: openai anthropic bailian vllm	openai
Status	string	No	El estado de la API del modelo.	Enable
RegionId	string	No	El ID de la región.	cn-beijing

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
RequestId	string	El ID de la solicitud.	C61892A4-0850-4516-9E26-44D96C1782DE
TotalRecordCount	integer	El número total de registros.	1
PageRecordCount	integer	El número de registros en la página actual.	30
PageNumber	integer	El número de página.	1
PageSize	integer	El número de entradas por página. Valores válidos: 30, 50 o 100. Valor predeterminado: 30.	30
Items	array<object>	La lista de API de modelos.
	object	El objeto de la API del modelo.
ModelApiId	string	Los ID de las API de modelos.	mi-xxxx
Name	string	El nombre de la API del modelo.	testName
Category	string	La categoría del modelo. Valores válidos: text embedding rerank	text
Status	string	El estado de la API del modelo.	Enable
Protocol	string	El protocolo. Valores válidos: openai anthropic bailian vllm	openai
PathPrefix	string	El prefijo de ruta de la API.	tests/models/
RecordInput	string	El número de tokens de entrada.	10
RecordOutput	string	El número de tokens de salida.	10
RouteRules	string	La lista de reglas de enrutamiento (cadena de matriz 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": "[]" } ] } ]
Config	string
GmtCreated	string	La hora de creación.	2024-10-16 16:46:20

Ejemplos

Respuesta exitosa

JSON Formato

{
  "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]",
      "Config": "",
      "GmtCreated": "2024-10-16 16:46:20\n"
    }
  ]
}

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.