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

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:DescribeService

get

*Service

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

Nenhuma

Sintaxe da solicitação

GET /api/v2/services/{ClusterId}/{ServiceName} HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ClusterId	string	Sim	O ID da região onde o serviço está implantado.	cn-shanghai
ServiceName	string	Sim	O nome do serviço. Para mais informações sobre como consultar o nome do serviço, consulte ListServices.	foo

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

Nenhum parâmetro necessário.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	Service	Os detalhes sobre o serviço.

Exemplos

Resposta de sucesso

JSON formato

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

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.