DescribeModelApis - PolarDB: Central de Documentação do Alibaba Cloud

Consulta APIs de modelo.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

polardb:DescribeModelApis

none

*All Resource

*

Nenhuma

Sintaxe da solicitação

POST  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
GwClusterId	string	Sim	O ID da instância do gateway.	pg-xxxxxxxxxx
ModelApiIds	string	Não	Os IDs das APIs de modelo. Separe múltiplos IDs com uma vírgula.	mi-xxx,mi-xxxx
Name	string	Não	O nome da API de modelo.	testName
ModelCategory	string	Não	A categoria do modelo. Valores válidos: text embedding rerank	text
PageNumber	integer	Não	O número da página.	1
PageSize	integer	Não	O número de entradas por página. Valores válidos: 30 50 100 O valor padrão é 30.	30
PathPrefix	string	Não	O prefixo do caminho da API.	/test
Protocol	string	Não	O protocolo. Valores válidos: openai anthropic bailian vllm	openai
Status	string	Não	O status da API de modelo.	Enable
RegionId	string	Não	O ID da região.	cn-beijing

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados retornados.
RequestId	string	O ID da solicitação.	C61892A4-0850-4516-9E26-44D96C1782DE
TotalRecordCount	integer	O número total de registros que correspondem à consulta.	1
PageRecordCount	integer	O número de registros retornados na página atual.	30
PageNumber	integer	O número da página.	1
PageSize	integer	O número de registros a serem retornados em cada página. Valores válidos: 30, 50 e 100. Valor padrão: 30.	30
Items	array<object>	Uma lista de objetos de API de modelo.
	object	Um objeto de API de modelo.
ModelApiId	string	O ID da API de modelo.	mi-xxxx
Name	string	O nome da API de modelo.	testName
Category	string	A categoria do modelo. Valores válidos: text embedding rerank	text
Status	string	O status da API de modelo.	Enable
Protocol	string	O protocolo. Valores válidos: openai anthropic bailian vllm	openai
PathPrefix	string	O prefixo do caminho da API.	tests/models/
RecordInput	string	O número de registros de entrada.	10
RecordOutput	string	O número de registros de saída.	10
RouteRules	string	Um array JSON de regras de roteamento, formatado como uma 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	A hora de criação.	2024-10-16 16:46:20

Exemplos

Resposta de sucesso

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

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.