DescribeAppServiceDetail - - Centre de documentation Alibaba Cloud

Décrit les détails des métadonnées d'un service d'application.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

sae:DescribeAppServiceDetail

list

*All Resource

*

Aucune

Syntaxe de la requête

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

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
AppId	string	Oui	L'identifiant de l'application.	6dcc8c9e-d3da-478a-a066-86dcf820****
ServiceType	string	Non	Le type de service. Valeurs valides :	springCloud
ServiceGroup	string	Non	Le groupe de services. Il s'agit d'un paramètre personnalisé.	springCloud
ServiceVersion	string	Non	La version du service. Il s'agit d'un paramètre personnalisé.	1.0.0
ServiceName	string	Non	Le nom du service.	edas.service.provider
NacosInstanceId	string	Non	L'identifiant de l'instance MSE Nacos.	mse-cn-sco3r0u****
NacosNamespaceId	string	Non	L'identifiant de l'espace de noms MSE Nacos.	public

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les données renvoyées.
RequestId	string	L'identifiant de la requête.	B2C7874F-F109-5B34-8618-2C10BBA2****
Message	string	Les informations supplémentaires renvoyées.	success
TraceId	string	L'identifiant de la chaîne d'appels. Utilisez cet identifiant pour effectuer une requête par terme sur les détails des appels.	0b16399316402420740034918e****
Data	object	Les données renvoyées.
Group	string	Le groupe de services. Il s'agit d'un paramètre personnalisé.	springCloud
ServiceName	string	Le nom du service.	service-provider
Version	string	La version du service. Il s'agit d'un paramètre personnalisé.	1.0.0
ServiceType	string	Le type de service. Valeurs valides :	springCloud
ServiceProtocol	string	Le protocole utilisé par le service.	HTTP
ServicePorts	array	Les ports utilisés par le service.
	integer	Le numéro de port.	8000
ServiceTags	array	Les balises du service.
	string	La balise du service.	tag1
EdasAppName	string	Le nom de l'application.	cn-zhangjiakou-micro-service-******
Metadata	object	Les métadonnées. Exemple : `{side: "provider", port: "18081", preserved: {register: {source: "SPRING_CLOUD"}},…}`	{side: "provider", port: "18081", preserved: {register: {source: "SPRING_CLOUD"}},…}
SpringApplicationName	string	Le nom de l'application Spring Cloud.	service-provider
DubboApplicationName	string	Le nom de l'application Dubbo.	service-consumer
Methods	array<object>	La liste des méthodes.
	array<object>	La liste des méthodes.
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	Le code d'erreur.
Code	string	L'état de l'appel d'API ou un code d'erreur POP. Valeurs valides :	200
Success	boolean	Indique si les métadonnées ont été obtenues. Valeurs valides :	true

Exemples

JSON format

{
  "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
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	Micro.Service.MetaData.NotFound	The micro service metadata not found {%s}.
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.