Query Gateway Service Details via GetGatewayServiceDetail - MSE - Alibaba Cloud - Microservices Engine

Meminta detail dari sebuah 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:GetGatewayServiceDetail

get

*Gateway

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ServiceId	integer	Yes	ID layanan.	35
GatewayUniqueId	string	Yes	ID unik gateway.	gw-f4c960ad071a48a790b36324394c****
AcceptLanguage	string	No	Bahasa respons. Nilai yang valid: `zh`: Tionghoa `en`: Inggris.	zh

Elemen respons

Element	Type	Description	Example
	object	Objek data yang dikembalikan.
RequestId	string	ID permintaan.	9802C54E-5CC5-5706-927B-993DBB6DCF2F
HttpStatusCode	integer	Kode status HTTP.	200
Message	string	Pesan respons.	Succ
Code	integer	Kode respons.	1
Success	boolean	Menentukan apakah permintaan berhasil. Nilai yang valid: `true`: Permintaan berhasil. `false`: Permintaan gagal.	true
Data	object	Data yang dikembalikan.
Id	integer	ID layanan.	1
Name	string	Nama layanan.	test
GatewayUniqueId	string	ID unik gateway.	gw-7ea3da97b96543e19f6c597c****
GatewayId	integer	ID gateway.	1
SourceType	string	Sumber layanan.	MSE
Namespace	string	Namespace.	default
GroupName	string	Nama grup.	test
SourceId	integer	ID sumber.	1
ServiceNameInRegistry	string	Nama layanan di dalam registri layanan.	test
MetaInfo	string	Informasi dasar tentang layanan.	{}
Ips	array	Alamat IP dari instans-instans layanan.
	string	Sebuah alamat IP dari sebuah instans layanan.	127.0.1.12
Versions	array<object>	Versi layanan. Parameter ini sudah tidak digunakan lagi (deprecated).
	object	Sebuah objek versi layanan.
Label	string	The label.	version
Value	string	The tag value.	v1
Type	string	The type.	test
LabelDetails	array<object>	Detail tag.
	object	Sebuah objek detail tag.
Key	string	The tag.	label
Values	array	The tag value.
	string	The tag value.	v1
VersionDetails	array<object>	Detail dari versi-versi layanan.
	array<object>	Detail untuk satu versi layanan.
ServiceVersion	object	The version of the service.
Name	string	Version name.	v2
Labels	array<object>	The label.
	object	The data structure.
Key	string	The tag.	version
Value	string	The tag value.	v2
EndpointNum	integer	The number of instances.	1
EndpointNumPercent	string	The percentage of instances.	20%
GmtCreate	string	Waktu saat layanan dibuat.	2022-01-07 18:07:57
GmtModified	string	Waktu saat layanan terakhir kali diubah, dalam format ISO 8601.	2022-01-07T10:07:57.000+0000
GatewayTrafficPolicy	TrafficPolicy	Kebijakan lalu lintas untuk layanan.	{}
HealthStatus	string	Status kesehatan layanan.	true
HealthCheck	string	Menentukan apakah pemeriksaan kesehatan (health check) diaktifkan.	true
ServiceProtocol	string	Protokol layanan.	HTTP
Ports	array	Port-port layanan.
	integer	Sebuah port layanan.	80
PortTrafficPolicyList	array<object>	Kebijakan lalu lintas dari port-port layanan.
	object	Sebuah objek kebijakan lalu lintas untuk sebuah port.
Id	integer	The port ID.	1
ServiceId	integer	The service ID.	1
ServicePort	integer	The service port.	8080
GatewayUniqueId	string	The unique ID of the gateway.	gw-2837hfd91h34dbg87364g*****
TrafficPolicy	TrafficPolicy	The traffic policy.
GmtCreate	string	The time when the policy was created.	1667460287386
GmtModified	string	The time when the policy was modified.	1667460287386
ServiceFQDN	string	Fully qualified domain name (FQDN) dari layanan.
ServicePort	integer	Port layanan.
DnsServerList	array	Daftar server DNS. Parameter ini hanya berlaku untuk layanan yang menggunakan DNS untuk service discovery.
	string	Alamat sebuah server DNS dalam format `IP address:Port`.	1.1.1.1:80

Contoh

Respons sukses

JSONformat

{
  "RequestId": "9802C54E-5CC5-5706-927B-993DBB6DCF2F",
  "HttpStatusCode": 200,
  "Message": "请求处理成功",
  "Code": 1,
  "Success": true,
  "Data": {
    "Id": 1,
    "Name": "test",
    "GatewayUniqueId": "gw-7ea3da97b96543e19f6c597c****",
    "GatewayId": 1,
    "SourceType": "MSE",
    "Namespace": "default",
    "GroupName": "test",
    "SourceId": 1,
    "ServiceNameInRegistry": "test",
    "MetaInfo": "{}",
    "Ips": [
      "127.0.1.12"
    ],
    "Versions": [
      {
        "Label": "version",
        "Value": "v1",
        "Type": "test"
      }
    ],
    "LabelDetails": [
      {
        "Key": "label",
        "Values": [
          "v1"
        ]
      }
    ],
    "VersionDetails": [
      {
        "ServiceVersion": {
          "Name": "v2",
          "Labels": [
            {
              "Key": "version",
              "Value": "v2"
            }
          ]
        },
        "EndpointNum": 1,
        "EndpointNumPercent": "20%"
      }
    ],
    "GmtCreate": "2022-01-07 18:07:57",
    "GmtModified": "2022-01-07T10:07:57.000+0000",
    "GatewayTrafficPolicy": {
      "TlsSetting": {
        "TlsMode": "SIMPLE",
        "CertId": "",
        "CaCertContent": "",
        "Sni": ""
      },
      "LoadBalancerSettings": {
        "LoadbalancerType": "RANDOM",
        "ConsistentHashLBConfig": {
          "ParameterName": "",
          "HttpCookie": {
            "Name": "",
            "Path": "",
            "TTL": "0s"
          },
          "ConsistentHashLBType": ""
        },
        "WarmupDuration": 0
      }
    },
    "HealthStatus": "true",
    "HealthCheck": "true",
    "ServiceProtocol": "HTTP",
    "Ports": [
      80
    ],
    "PortTrafficPolicyList": [
      {
        "Id": 1,
        "ServiceId": 1,
        "ServicePort": 8080,
        "GatewayUniqueId": "gw-2837hfd91h34dbg87364g*****",
        "TrafficPolicy": {
          "TlsSetting": {
            "TlsMode": "SIMPLE",
            "CertId": "",
            "CaCertContent": "",
            "Sni": ""
          },
          "LoadBalancerSettings": {
            "LoadbalancerType": "RANDOM",
            "ConsistentHashLBConfig": {
              "ParameterName": "",
              "HttpCookie": {
                "Name": "",
                "Path": "",
                "TTL": "0s"
              },
              "ConsistentHashLBType": ""
            },
            "WarmupDuration": 0
          }
        },
        "GmtCreate": "1667460287386",
        "GmtModified": "1667460287386"
      }
    ],
    "ServiceFQDN": "",
    "ServicePort": 0,
    "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.