Kueri layanan berlangganan gateway melalui ListGatewayService - Microservices Engine - Alibaba Cloud - Microservices Engine

Mengambil daftar layanan yang dilanggan oleh gerbang.

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

get

*Gateway

acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
PageNumber	integer	No	Nomor halaman.	1
PageSize	integer	No	Jumlah entri per halaman.	10
OrderItem	string	No	Properti pengurutan.	GmtCreate
DescSort	boolean	No	Apakah akan mengurutkan hasil dalam pesanan menurun.	false
FilterParams	object	No	Kondisi filter, ditentukan sebagai string JSON, seperti {"key1":"value1"}.
Name	string	No	The service name.	test
SourceType	string	No	The source type.	MSE
Namespace	string	No	The namespace.	public
GroupName	string	No	The group.	test
GatewayUniqueId	string	Yes	The unique gateway ID.	gw-5017305290e14centbrveca****
ServiceProtocol	string	No	The service protocol. HTTP HTTPS HTTP2 GRPC DUBBO Valid values: HTTP2 : HTTP2 HTTPS : HTTPS HTTP : HTTP DUBBO : DUBBO GRPC : GRPC	HTTP
AcceptLanguage	string	No	Bahasa tanggapan. Nilai valid: zh: Cina en: Inggris.	zh

Elemen respons

Element	Type	Description	Example
	object	The data structure.
RequestId	string	The request ID.	F46CDBA4-B1EE-5C94-8A48-51C10177****
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The response message.	You are not authorized to perform this operation.
Code	integer	The response code.	200
Success	boolean	Specifies whether the request succeeded. Valid values: `true`: The request succeeded. `false`: The request failed.	true
Data	object	The response data.
TotalSize	integer	The total number of entries.	9
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page. Default value: 10.	10
Result	array<object>	The list of services.
	array<object>	The details of a service.
Id	integer	ID.	1
Name	string	Service name.	test
GatewayUniqueId	string	Gateway unique ID.	gw-5017305290e14centbrveca****
GatewayId	integer	Gateway ID.	1
SourceType	string	Source type.	MSE
Namespace	string	Namespace.	public
GroupName	string	Group.	test
SourceId	integer	Source ID.	2
ServiceNameInRegistry	string	Original service name in the Accreditation Centre.	test
MetaInfo	string	Meta information or IP list.	{}
Ips	array	IP list.
	string	IP.	127.0.2.1
GmtCreate	string	Record creation time.	2022-01-07 18:07:57
GmtModified	string	Record modification time.	2022-01-07 18:07:57
Versions	array<object>	Service version.
	object	Version.
Name	string	Version name.	v1
ServiceProtocol	string	Service Agreement.	HTTP
ServicePort	integer	Service port.	80
HealehStatus	string	Health status. Health Unhealthy Unknown	Unhealthy
HealthStatus	string	Health status. Health Unhealthy Unknown	Unhealthy
HealthCheck	boolean	Whether to perform health check.	true
HealthCheckInfo	object	Health check information.
Check	boolean	Whether to check.	true
Protocol	string	Network protocol.	TCP
Timeout	integer	Timeout.	2
Interval	integer	Health check interval.	2
HealthyThreshold	integer	Healthy Threshold.	2
UnhealthyThreshold	integer	Unhealthy threshold.	2
HttpPath	string	URI of the request for health check HTTP.	/health
HttpHost	string	Health check HTTP request address.	http://172.168.0.1
ExpectedStatuses	array	Expected status values for health check.
	integer	Expected HttpStatus.	200
UnhealthyEndpoints	array	Unhealthy endpoint array
	string	Unhealthy endpoint	172.168.0.1
GatewayTrafficPolicy	object	Traffic management policy.
Tls	object	TLS.
Mode	string	TLS mode. DISABLE SIMPLE MUTUAL ISTIO_MUTUAL	SIMPLE
CertId	string	Certificate ID.	5******-cn-hangzhou
CaCertId	string	CA certificate ID.	5******-cn-hangzhou
CaCertContent	string	CA certificate public key.	content
SubjectAltNames	array	Subject alias array.
	string	Subject alias.	name
Sni	string	Service name identifier.	name-sni
LoadBalancerSettings	object	Load balancing settings.
LoadbalancerType	string	Load balancing policy ROUND_ROBIN LEAST_CONN RANDOM CONSISTENT_HASH	RANDOM
ConsistentHashLBConfig	object	Consistent hash configuration.
ParameterName	string	Parameter name.	param
HttpCookie	object	Cookie-based parameters.
Name	string	Cookie name.	name
Path	string	Cookie path.	/path
Ttl	string	Cookie lifecycle.	360
MinimumRingSize	integer	Hash ring minimum value.	10000
ConsistentHashLBType	string	Consistent hash method. HEADER COOKIE SOURCE_IP QUERY_PARAMETER	HEADER
WarmupDuration	integer	Ramp-up period for minimum requests.	10
Ports	array	Port array.
	integer	Port.	8080
ServiceFQDN	string
DnsServerList	array	DNS server list (for DNS domain name service only)
	string	DNS server address (IP+port)	1.1.1.1:80

Contoh

Respons sukses

JSONformat

{
  "RequestId": "F46CDBA4-B1EE-5C94-8A48-51C10177****",
  "HttpStatusCode": 200,
  "Message": "You are not authorized to perform this operation.",
  "Code": 200,
  "Success": true,
  "Data": {
    "TotalSize": 9,
    "PageNumber": 1,
    "PageSize": 10,
    "Result": [
      {
        "Id": 1,
        "Name": "test",
        "GatewayUniqueId": "gw-5017305290e14centbrveca****",
        "GatewayId": 1,
        "SourceType": "MSE",
        "Namespace": "public",
        "GroupName": "test",
        "SourceId": 2,
        "ServiceNameInRegistry": "test",
        "MetaInfo": "{}",
        "Ips": [
          "127.0.2.1"
        ],
        "GmtCreate": "2022-01-07 18:07:57",
        "GmtModified": "2022-01-07 18:07:57",
        "Versions": [
          {
            "Name": "v1"
          }
        ],
        "ServiceProtocol": "HTTP",
        "ServicePort": 80,
        "HealehStatus": "Unhealthy",
        "HealthStatus": "Unhealthy",
        "HealthCheck": true,
        "HealthCheckInfo": {
          "Check": true,
          "Protocol": "TCP",
          "Timeout": 2,
          "Interval": 2,
          "HealthyThreshold": 2,
          "UnhealthyThreshold": 2,
          "HttpPath": "/health",
          "HttpHost": "http://172.168.0.1",
          "ExpectedStatuses": [
            200
          ]
        },
        "UnhealthyEndpoints": [
          "172.168.0.1"
        ],
        "GatewayTrafficPolicy": {
          "Tls": {
            "Mode": "SIMPLE",
            "CertId": "5******-cn-hangzhou",
            "CaCertId": "5******-cn-hangzhou",
            "CaCertContent": "content",
            "SubjectAltNames": [
              "name"
            ],
            "Sni": "name-sni"
          },
          "LoadBalancerSettings": {
            "LoadbalancerType": "RANDOM",
            "ConsistentHashLBConfig": {
              "ParameterName": "param",
              "HttpCookie": {
                "Name": "name",
                "Path": "/path",
                "Ttl": "360"
              },
              "MinimumRingSize": 10000,
              "ConsistentHashLBType": "HEADER"
            },
            "WarmupDuration": 10
          }
        },
        "Ports": [
          8080
        ],
        "ServiceFQDN": "",
        "DnsServerList": [
          "1.1.1.1:80"
        ]
      }
    ]
  }
}

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.