Ambil detail layanan aplikasi dengan DescribeAppServiceDetail - Serverless App Engine - Alibaba Cloud - Serverless App Engine

Mendeskripsikan detail metadata layanan aplikasi.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

sae:DescribeAppServiceDetail

list

*全部资源

*

None

Sintaks permintaan

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

Parameter permintaan

Parameter	Type	Required	Description	Example
AppId	string	Yes	ID aplikasi.	6dcc8c9e-d3da-478a-a066-86dcf820****
ServiceType	string	No	Jenis layanan. Nilai valid: dubbo springCloud.	springCloud
ServiceGroup	string	No	Kelompok layanan. Parameter ini bersifat kustom.	springCloud
ServiceVersion	string	No	Versi layanan. Parameter ini bersifat kustom.	1.0.0
ServiceName	string	No	Nama layanan.	edas.service.provider
NacosInstanceId	string	No	ID instans MSE Pusat Registrasi Nacos.	mse-cn-sco3r0u****
NacosNamespaceId	string	No	ID namespace MSE Pusat Registrasi Nacos.	public

Elemen respons

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	B2C7874F-F109-5B34-8618-2C10BBA2****
Message	string	The additional information returned.	success
TraceId	string	The call chain ID. Use this ID for a term query of call details.	0b16399316402420740034918e****
Data	object	The returned data.
Group	string	The service group. This is a custom parameter.	springCloud
ServiceName	string	The service name.	service-provider
Version	string	The service version. This is a custom parameter.	1.0.0
ServiceType	string	The service type. Valid values: dubbo springCloud	springCloud
ServiceProtocol	string	The protocol used by the service.	HTTP
ServicePorts	array	The ports used by the service.
	integer	The port number.	8000
ServiceTags	array	The tags of the service.
	string	The tag of the service.	tag1
EdasAppName	string	The application name.	cn-zhangjiakou-micro-service-******
Metadata	object	The metadata. Example: `{side: "provider", port: "18081", preserved: {register: {source: "SPRING_CLOUD"}},…}`	{side: "provider", port: "18081", preserved: {register: {source: "SPRING_CLOUD"}},…}
SpringApplicationName	string	The name of the Spring Cloud application.	service-provider
DubboApplicationName	string	The name of the Dubbo application.	service-consumer
Methods	array<object>	The list of methods.
	array<object>	The list of methods.
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	The error code. If the request is successful, the ErrorCode field is not returned. If the request fails, the ErrorCode field is returned. For more information, see the list of error codes in this topic.
Code	string	The status of the API call or a POP error code. Valid values: 2xx: success. 3xx: redirection. 4xx: client error. 5xx: server error.	200
Success	boolean	Indicates whether the metadata was obtained. Valid values: true: The metadata was obtained. false: The metadata failed to be obtained.	true

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	Micro.Service.MetaData.NotFound	The micro service metadata not found {%s}.
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.