Referensi API ACK Cluster Governance - Microservices Engine - Alibaba Cloud - Microservices Engine

Mengkueri informasi tentang kluster Container Service for Kubernetes (ACK) yang telah mengaktifkan Tata Kelola Layanan Mikro.

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

get

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	Wilayah tempat kluster berada. MSE mendukung wilayah tertentu.	cn-hangzhou
ClusterId	string	Yes	ID kluster.	cd23228b3c80c4d4f9ad7af1d87cc****
AcceptLanguage	string	No	Bahasa tanggapan. Nilai valid: zh: Bahasa Tionghoa. en: Bahasa Inggris.	zh

Elemen respons

Element	Type	Description	Example
	object	The data structure.
Message	string	The information that is returned.	success
RequestId	string	The request ID.	5B170A0D-2C5D-4CF8-B808-03966B86****
Data	object	The data overview.
ClusterId	string	The cluster ID.	cd23228b3c80c4d4f9ad7af1d87cc30d5
ClusterName	string	The cluster name.	myCluster
Region	string	The region where the cluster is located. MSE supports specific regions.	cn-hangzhou
K8sVersion	string	The Kubernetes version.	1.20.11-aliyun.1
NamespaceInfos	string	The information about namespaces.	[{\"Name\":\"ack-onepilot\",\"Tags\":null},{\"Name\":\"default\",\"Tags\":{\"mse-enable\":\"enabled\"}},{\"Name\":\"kube-node-lease\",\"Tags\":null},{\"Name\":\"kube-public\",\"Tags\":null},{\"Name\":\"kube-system\",\"Tags\":null}]
PilotStartTime	string	The Pilot startup time.	2022-01-11T11:50:38.000+0000
UpdateTime	string	The time when the UDF was last modified.	2022-01-12T05:24:31.000+0000
Namespaces	array<object>	The list of namespaces.
	object	The namespace structure.
Name	string	The Kubernetes namespace name.	default
MseNamespace	string	The corresponding MSE namespace name.	default
PilotVersion	string	The ack-onepilot component version	4.1.1
VersionLifeCycle	string	The version lifecycle. Valid values: EXPIRED : 过期 SUNSETTING : 即将过期 STABLE : 稳定 DEPRECATED : 不推荐版本	STABLE
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	True

Contoh

Respons sukses

JSONformat

{
  "Message": "success",
  "RequestId": "5B170A0D-2C5D-4CF8-B808-03966B86****",
  "Data": {
    "ClusterId": "cd23228b3c80c4d4f9ad7af1d87cc30d5",
    "ClusterName": "myCluster",
    "Region": "cn-hangzhou",
    "K8sVersion": "1.20.11-aliyun.1",
    "NamespaceInfos": "[{\\\"Name\\\":\\\"ack-onepilot\\\",\\\"Tags\\\":null},{\\\"Name\\\":\\\"default\\\",\\\"Tags\\\":{\\\"mse-enable\\\":\\\"enabled\\\"}},{\\\"Name\\\":\\\"kube-node-lease\\\",\\\"Tags\\\":null},{\\\"Name\\\":\\\"kube-public\\\",\\\"Tags\\\":null},{\\\"Name\\\":\\\"kube-system\\\",\\\"Tags\\\":null}]",
    "PilotStartTime": "2022-01-11T11:50:38.000+0000",
    "UpdateTime": "2022-01-12T05:24:31.000+0000",
    "Namespaces": [
      {
        "Name": "default",
        "MseNamespace": "default"
      }
    ],
    "PilotVersion": "4.1.1",
    "VersionLifeCycle": "STABLE"
  },
  "Success": true
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.