GetServiceMethodPage API Overview - Microservices Engine - Alibaba Cloud - Microservices Engine

Mengkueri daftar antarmuka layanan.

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

mse:GetServiceMethodPage

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Region	string	No	Wilayah.	cn-hangzhou
ServiceType	string	No	Tipe mesin.	springCloud
Namespace	string	No	Namespace Microservices Engine (MSE) tempat aplikasi berada.	default
AppName	string	No	Nama aplikasi.	example-app
AppId	string	No	ID aplikasi.	hkhonxxxxx@f3f75ed8ffxxxxx
ServiceName	string	No	Nama layanan.	sc-A
ServiceVersion	string	No	Versi layanan.	1.0.0
ServiceGroup	string	No	Kelompok tempat layanan berada.	ALIYUN
Ip	string	No	Alamat IP penyedia layanan.	223.5.5.5
PageNumber	integer	No	Nomor halaman.	1
PageSize	integer	No	Jumlah entri per halaman.	10
MethodController	string	No	Nama lengkap kelas Controller tempat antarmuka berada.	com.alibabacloud.mse.demo.a.AController
Path	string	No	Jalur permintaan yang sesuai dengan antarmuka.	/a
Name	string	No	Nama metode.	aMethod
AcceptLanguage	string	No	Bahasa untuk menampilkan hasil. Nilai valid: zh dan en. zh menunjukkan bahasa Tionghoa, yang merupakan nilai default. en menunjukkan bahasa Inggris.	zh

Elemen respons

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the request is successful. Valid values:	True
Message	string	The request information.	OK
RequestId	string	The request ID.	2DD5A212-C77B-3XXF-9XXE-XXX9XXXE5XX1
Data	object	The response to the request.
Result	array<object>	The method description list.
	array<object>	The description of each method.
NameDetail	string	The interface description information.	sample description
ParameterDetails	array	The type of the interface parameter.
	string	The type of each parameter.	java.lang.String
ParameterDefinitions	array<object>	The detailed definition of the parameter.
	object	The detailed definition of the parameter.
Type	string	The parameter type.	java.lang.String
Description	string	The description of the parameter.	sample description
Name	string	The name of the parameter.	aParam
Paths	array	The list of request paths that correspond to the interface.
	string	The request path that corresponds to the interface.	/a
ParameterTypes	array	The parameter types.
	string	The parameter type.	java.lang.String
RequestMethods	array	The HTTP request method.
	string	The HTTP request parameter.	GET
ReturnDetails	string	The type of the return value.	java.lang.String
Name	string	The name of the method.	aMethod
MethodController	string	The full name of the Controller class to which the interface belongs.	com.alibabacloud.mse.demo.a.AController
ReturnType	string	The type of the return value.	java.lang.String
TotalSize	integer	The total number of methods.	100
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10

Contoh

Respons sukses

JSONformat

{
  "Success": true,
  "Message": "OK",
  "RequestId": "2DD5A212-C77B-3XXF-9XXE-XXX9XXXE5XX1",
  "Data": {
    "Result": [
      {
        "NameDetail": "sample description",
        "ParameterDetails": [
          "java.lang.String"
        ],
        "ParameterDefinitions": [
          {
            "Type": "java.lang.String",
            "Description": "sample description",
            "Name": "aParam"
          }
        ],
        "Paths": [
          "/a"
        ],
        "ParameterTypes": [
          "java.lang.String"
        ],
        "RequestMethods": [
          "GET"
        ],
        "ReturnDetails": "java.lang.String",
        "Name": "aMethod",
        "MethodController": "com.alibabacloud.mse.demo.a.AController",
        "ReturnType": "java.lang.String"
      }
    ],
    "TotalSize": 100,
    "PageNumber": 1,
    "PageSize": 10
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	IllegalRequest	Invalid request:%s
400	InvalidParameter	Parameter error:%s
500	InternalError	Console error. Try again later:%s
403	NoPermission	You are not authorized to perform this operation:%s
404	NotFound	Not found:%s

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.