ListMcpServers - DataWorks: Central de Documentação do Alibaba Cloud

Obtém uma lista paginada de servidores MCP.

Descrição da operação

Solicitação

Esta operação obtém uma lista paginada de todos os servidores MCP em sua conta. Você pode filtrar a lista por palavra-chave de pesquisa e nível de visibilidade, e controlar a paginação especificando o número máximo de resultados e um token da próxima página.

Q: Opcional. A palavra-chave de pesquisa para uma pesquisa aproximada nos nomes dos servidores MCP.
Visibility: Opcional. Os níveis de visibilidade para filtrar os resultados. Você pode especificar vários níveis, como TENANT, PROJECT ou USER.
MaxResults: Opcional. O número máximo de resultados a serem retornados por página. Por padrão, nenhum limite é aplicado.
NextToken: Opcional. O token da próxima página de uma resposta anterior. Use este parâmetro para obter a próxima página de resultados.

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

dataworks:ListMcpServers

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Q	string	Não	A palavra-chave de pesquisa para uma pesquisa aproximada nos nomes dos servidores MCP.	mcp
Visibility	array	Não	Os níveis de visibilidade para filtrar os resultados. Você pode especificar vários níveis.	-
	string	Não	O nível de visibilidade. Valores válidos: TENANT (visível dentro da conta), PROJECT (visível para projetos especificados) e USER (visível para usuários especificados). Valores válidos: PROJECT : 指定项目可见 USER : 指定用户可见 TENANT : 账号内可见	TENANT
MaxResults	integer	Não	O número máximo de resultados a serem retornados por página.	20
NextToken	string	Não	O token da próxima página de uma resposta anterior. Use este token para obter a próxima página de resultados. Deixe este parâmetro vazio para a primeira solicitação.	12345

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O objeto de resposta.
RequestId	string	O ID da solicitação.	824F80BA-1778-5D8A-BAFF-668A4D9C4CC7
PagingInfo	object	As informações de paginação.
TotalCount	integer	O número total de entradas que correspondem aos critérios de filtro.	100
McpServers	array<object>	Uma lista de objetos de servidor MCP.
	array<object>
CreatorId	string	O ID do criador.	805298765622151
ModifierId	string	O ID do usuário que modificou o servidor pela última vez.	123456
Name	string	O nome do servidor MCP.	my-mcp-server
Config	object	A configuração de conexão do servidor MCP.
Url	string	O endereço de serviço do servidor MCP.	https://example.com/mcp/sse
Transport	string	O protocolo de transporte.	SSE
CustomHeaders	object	Os cabeçalhos personalizados.	{}
Visibility	string	O nível de visibilidade.	TENANT
GmtCreateTime	string	O horário de criação, como um timestamp em milissegundos.	1780555634000
GmtModifiedTime	string	O horário da última modificação, como um timestamp em milissegundos.	1780555634000
MaxResults	integer	O número máximo de resultados retornados na página atual.	100
NextToken	string	O token para a próxima página de resultados. Um valor nulo indica que todos os resultados foram retornados.	2

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "824F80BA-1778-5D8A-BAFF-668A4D9C4CC7",
  "PagingInfo": {
    "TotalCount": 100,
    "McpServers": [
      {
        "CreatorId": "805298765622151",
        "ModifierId": "123456",
        "Name": "my-mcp-server",
        "Config": {
          "Url": "https://example.com/mcp/sse",
          "Transport": "SSE",
          "CustomHeaders": {}
        },
        "Visibility": "TENANT",
        "GmtCreateTime": "1780555634000",
        "GmtModifiedTime": "1780555634000"
      }
    ],
    "MaxResults": 100,
    "NextToken": "2"
  }
}

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.