DescribeAppServiceDetail - Serverless App Engine: Central de Documentação do Alibaba Cloud

Descreve os detalhes de metadados de um serviço de aplicação.

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

sae:DescribeAppServiceDetail

list

*All Resource

*

Nenhuma

Sintaxe da solicitação

GET /pop/v1/sam/service/describeAppServiceDetail HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
AppId	string	Sim	O ID da aplicação.	6dcc8c9e-d3da-478a-a066-86dcf820****
ServiceType	string	Não	O tipo de serviço. Valores válidos: dubbo springCloud	springCloud
ServiceGroup	string	Não	O grupo de serviço. Este é um parâmetro personalizado.	springCloud
ServiceVersion	string	Não	A versão do serviço. Este é um parâmetro personalizado.	1.0.0
ServiceName	string	Não	O nome do serviço.	edas.service.provider
NacosInstanceId	string	Não	O ID da instância MSE Nacos.	mse-cn-sco3r0u****
NacosNamespaceId	string	Não	O ID do namespace MSE Nacos.	public

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados retornados.
RequestId	string	O ID da solicitação.	B2C7874F-F109-5B34-8618-2C10BBA2****
Message	string	As informações adicionais retornadas.	success
TraceId	string	O ID da cadeia de chamadas. Use este ID para uma consulta de termos dos detalhes da chamada.	0b16399316402420740034918e****
Data	object	Os dados retornados.
Group	string	O grupo de serviço. Este é um parâmetro personalizado.	springCloud
ServiceName	string	O nome do serviço.	service-provider
Version	string	A versão do serviço. Este é um parâmetro personalizado.	1.0.0
ServiceType	string	O tipo de serviço. Valores válidos: dubbo springCloud	springCloud
ServiceProtocol	string	O protocolo utilizado pelo serviço.	HTTP
ServicePorts	array	As portas utilizadas pelo serviço.
	integer	O número da porta.	8000
ServiceTags	array	As tags do serviço.
	string	A tag do serviço.	tag1
EdasAppName	string	O nome da aplicação.	cn-zhangjiakou-micro-service-******
Metadata	object	Os metadados. Exemplo: `{side: "provider", port: "18081", preserved: {register: {source: "SPRING_CLOUD"}},…}`	{side: "provider", port: "18081", preserved: {register: {source: "SPRING_CLOUD"}},…}
SpringApplicationName	string	O nome da aplicação Spring Cloud.	service-provider
DubboApplicationName	string	O nome da aplicação Dubbo.	service-consumer
Methods	array<object>	A lista de métodos.
	array<object>	A lista de métodos.
MethodController	string	The class to which the method belongs.	com.serverless.sae.controller.EchoController
ReturnType	string	The return type.	java.lang.String
ReturnDetails	string	The details of the returned data.	test
Name	string	The method name.	echo
NameDetail	string	The details of the method.	description
ParameterDetails	array	The details of the parameters.
	string	The details of the parameter.	description
RequestMethods	array	The request methods.
	string	The request method. Valid values: GET ALL	ALL
ParameterTypes	array	The parameter types.
	string	The parameter type.	["java.lang.String"]
Paths	array	The request paths.
	string	The request path. The format is as follows: `/path`	["/echo/{str}"]
ParameterDefinitions	array<object>	The parameter definitions.
	object	The parameter definition.
Type	string	The parameter type.	java.lang.String
Description	string	The description of the parameter.	description
Name	string	The parameter name.	arg0
ErrorCode	string	O código de erro. Se a solicitação for bem-sucedida, o campo ErrorCode não será retornado. Se a solicitação falhar, o campo ErrorCode será retornado. Para mais informações, consulte a lista de códigos de erro neste tópico.
Code	string	O status da chamada de API ou um código de erro POP. Valores válidos: 2xx: sucesso. 3xx: redirecionamento. 4xx: erro do cliente. 5xx: erro do servidor.	200
Success	boolean	Indica se os metadados foram obtidos. Valores válidos: true: Os metadados foram obtidos. false: Falha ao obter os metadados.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "B2C7874F-F109-5B34-8618-2C10BBA2****",
  "Message": "success",
  "TraceId": "0b16399316402420740034918e****",
  "Data": {
    "Group": "springCloud",
    "ServiceName": "service-provider",
    "Version": "1.0.0",
    "ServiceType": "springCloud",
    "ServiceProtocol": "HTTP",
    "ServicePorts": [
      8000
    ],
    "ServiceTags": [
      "tag1"
    ],
    "EdasAppName": "cn-zhangjiakou-micro-service-******",
    "Metadata": {
      "test": "test",
      "test2": 1
    },
    "SpringApplicationName": "service-provider",
    "DubboApplicationName": "service-consumer",
    "Methods": [
      {
        "MethodController": "com.serverless.sae.controller.EchoController",
        "ReturnType": "java.lang.String",
        "ReturnDetails": "test",
        "Name": "echo",
        "NameDetail": "description",
        "ParameterDetails": [
          "description"
        ],
        "RequestMethods": [
          "ALL"
        ],
        "ParameterTypes": [
          "[\"java.lang.String\"]"
        ],
        "Paths": [
          "[\"/echo/{str}\"]"
        ],
        "ParameterDefinitions": [
          {
            "Type": "java.lang.String",
            "Description": "description",
            "Name": "arg0"
          }
        ]
      }
    ]
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	Micro.Service.MetaData.NotFound	The micro service metadata not found {%s}.
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.