ListServices - Platform For AI: Central de Documentação do Alibaba Cloud

Lista os serviços.

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

eas:ListServices

get

*Service

acs:eas:{#regionId}:{#accountId}:service/*

Nenhuma

Sintaxe da solicitação

GET /api/v2/services HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Sort	string	Não	O campo de ordenação. Campos de timestamp são ordenados em ordem decrescente por padrão.	CreateTime
Order	string	Não	A ordem de classificação. Valores válidos:\n- desc (padrão): ordem decrescente.\n- asc: ordem crescente.	asc
Filter	string	Não	O campo de correspondência aproximada. Apenas a correspondência aproximada por nome do serviço é suportada.	foo
PageNumber	integer	Não	O número da página da lista de serviços. Valor padrão: 1.	1
PageSize	integer	Não	O número de serviços a serem exibidos em cada página quando a paginação é usada. Valor padrão: 100.	100
GroupName	string	Não	O nome do grupo de serviços. Para obter informações sobre como obter o nome do grupo de serviços, consulte ListServices.	foo
ParentServiceUid	string	Não	O ID do serviço principal que corresponde ao serviço membro da Band.	eas-m-ijafy3c8cxxxx
ServiceType	string	Não	O tipo de serviço. Valores válidos:\n- Async\n- Standard\n- Queue\n- LLM\n- RAG\n- Serverless\n- LLMGatewayService\n- Offline Task\n- SDCluster\n- ScalableJob\n- ScalableJobService\n- AssistantJob. Valores válidos: Async : Serviço assíncrono. Standard : Implantação padrão. OfflineTask : Tarefa offline. Proxima : Proxima.	Standard
Label	object	Não	Filtra serviços por rótulo.
	string	Não	Especifique o rótulo no formato `{"key":"value"}`. O valor pode ser nulo ou uma string vazia, o que significa que apenas a chave é usada para filtragem. O valor pode ser qualquer valor.	{"key1":"value1","key2":null}
ServiceStatus	string	Não	O status de execução do serviço. Valores válidos: Creating : Criando. Stopped : Parado. Failed : Falhou. Complete : Concluído. Cloning : Clonando. Stopping : Parando. Updating : Atualizando. Waiting : Aguardando. HotUpdate : Atualização a quente. Committing : Confirmando. Starting : Iniciando. DeleteFailed : Falha na exclusão. Running : Em execução. Developing : Desenvolvendo. Scaling : Escalando. Deleted : Excluído. Pending : Pendente. Deleting : Excluindo.	Running
ServiceName	string	Não	O nome do serviço.	echo_test
ServiceUid	string	Não	O UID do serviço.	eas-m-c9iw3yitxxxx
ResourceName `deprecated`	string	Não	O nome ou ID do grupo de recursos ao qual o serviço pertence.	eas-r-hd0qwy8cxxxx
WorkspaceId	string	Não	O ID do workspace.	1234**
QuotaId	string	Não	O ID da cota.	quota1****
Gateway	string	Não	O ID do gateway dedicado.	gw-1uhcqmsc7x22******
Role	string	Não	A função do serviço. Valores válidos: DataLoader : DataLoader. FrontEnd : FrontEnd. DataSet : DataSet. SDProxy : SDProxy. LLMScheduler : LLMScheduler. ScalableJob : ScalableJob. LLMGateway : LLMGateway. Job : Job. Queue : Queue.	LLMGateway
ResourceType	string	Não	O tipo de recurso usado pelo serviço. Valores válidos: PublicResource DedicatedResource Lingjun SelfManagedLingjun Valores válidos: Lingjun : Cota de recursos Lingjun. PublicResource : Grupo de recursos público. DedicatedResource : Grupo de recursos dedicado. SelfManagedLingjun : Grupo de recursos Lingjun autogerenciado.	PublicResource
IncludeNoWorkspace	boolean	Não	Especifica se devem ser incluídos serviços que não pertencem a nenhum workspace. Valor padrão: true.	true
ResourceAliasName	string	Não	O nome personalizado do grupo de recursos.	example
ResourceId	string	Não	O ID do grupo de recursos. Para obter informações sobre como consultar o ID do grupo de recursos, consulte ListResources.	eas-r-asdas****
ResourceBurstable	boolean	Não	Especifica se o pool de recursos burstable está ativado para o serviço. Valores válidos: true : true. false : false.	true
CronscalerEnabled	boolean	Não	Especifica se o auto scaling agendado está ativado para o serviço. Valores válidos: true : true. false : false.	true
AutoscalerEnabled	boolean	Não	Especifica se o dimensionamento elástico está ativado para o serviço. Valores válidos: true : true. false : false.	true
TrafficState	string	Não	Especifica se o serviço lida com tráfego de grupo. Este parâmetro é válido apenas para serviços de grupo. Valores válidos: standalone : No. grouping : Sim.	grouping
CallerUid	string	Não	O UID da conta que criou o serviço.	19989224166xxxxxxx
Accessibility	string	Não	Filtra serviços por visibilidade. PUBLIC indica serviços públicos. PRIVATE indica serviços privados. Valores válidos: PUBLIC : Serviço público. PRIVATE : Serviço privado.	PUBLIC

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
RequestId	string	O ID da solicitação.	40325405-579C-4D82****
Services	array	A lista de serviços.
	Service	A instância do serviço.
PageNumber	integer	O número da página atual da lista de serviços retornada.	1
PageSize	integer	O número de serviços exibidos em cada página.	100
TotalCount	integer	O número total de serviços.	2

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "40325405-579C-4D82****",
  "Services": [
    {
      "RequestId": "40325405-579C-4D82********",
      "Region": "cn-shanghai",
      "CallerUid": "20123*******",
      "ParentUid": "11234*******",
      "CurrentVersion": 1,
      "Cpu": 1,
      "Gpu": 0,
      "Image": "registry.cn-shanghai.aliyuncs.com/eas/echo_cn-shanghai:v0.0.1-20210129111320",
      "PendingInstance": 0,
      "RunningInstance": 1,
      "TotalInstance": 1,
      "InternetEndpoint": "http://10123*****.cn-shanghai.aliyuncs.com/api/predict/echo",
      "IntranetEndpoint": "http://10123*****.vpc.cn-shanghai.aliyuncs.com/api/predict/echo",
      "LatestVersion": 1,
      "Memory": 1024,
      "Message": "Service start successfully",
      "Namespace": "echo",
      "Reason": "RUNNING",
      "Resource": "eas-r-xxxxxxx",
      "ResourceAlias": "my_resource",
      "ServiceConfig": "{\"metadata\":{\"cpu\":1,\"instance\":1,\"memory\":1024},\"name\":\"echo\",\"processor_entry\":\"libecho.so\",\"processor_path\":\"http://oss-cn-hangzhou-zmf.aliyuncs.com/059247/echo_processor_release.tar.gz\",\"processor_type\":\"cpp\"}",
      "ServiceName": "echo",
      "ServiceGroup": "my_group",
      "Status": "Running",
      "CreateTime": "2021-01-29T11:13:20Z",
      "UpdateTime": "2021-01-29T11:13:20Z",
      "Weight": 100,
      "ServiceId": "eas-m-xxasdat",
      "ServiceUid": "eas-m-xxasdat\n",
      "AccessToken": "MzJiMDI5MDliODc0MTlkYmI0ZDhlYmExYjczYTIyZTE3Zm********",
      "Source": "dsw",
      "ExtraData": "{\"blue_green_services\":[\"test\",\"testxxxx\"]}",
      "Role": "Queue",
      "RoleAttrs": "{\"ApproxMaxLength\":null,\"Length\":null,\"MaxPayloadBytes\":null}",
      "SafetyLock": "dangerous",
      "SecondaryInternetEndpoint": "http://10123*****.cn-shanghai.aliyuncs.com/api/predict/async_path.echo\n",
      "SecondaryIntranetEndpoint": "http://10123*****.vpc.cn-shanghai.aliyuncs.com/api/predict/async_path.echo\n",
      "Labels": [
        {
          "LabelKey": "key1",
          "LabelValue": "value1"
        }
      ],
      "WorkspaceId": "123445",
      "AppType": "LLM",
      "AppConfig": "{\"ModelStorage\":\"oss\"}",
      "AppSpecName": "llama_7b_fp16",
      "AppVersion": "v1",
      "TrafficState": "standalone",
      "QuotaId": "quotaxxxxx",
      "Gateway": "gw-xxxxxx",
      "GPUMemory": 20,
      "GPUCorePercentage": 50,
      "ResourceBurstable": true,
      "CronscalerEnabled": true,
      "AutoscalerEnabled": true,
      "InstanceCountInResource": {
        "Public": 10,
        "Dedicated": 10,
        "Quota": 10
      },
      "WorkloadType": ""
    }
  ],
  "PageNumber": 1,
  "PageSize": 100,
  "TotalCount": 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.