Referensi API ListWorkspaces untuk data workspace tenant - Data Management - Alibaba Cloud - Data Management

API ini digunakan untuk mengkueri daftar ruang kerja di bawah tenant.

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

dms:ListWorkspaces

list

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
AlreadyJoined	boolean	No	Apakah pengguna saat ini telah bergabung dengan ruang kerja.	true
SearchKey	string	No	Kata kunci pencarian. Pencarian fuzzy didukung.	poc_test
Region	string	No	Region.	cn-hangzhou
ServiceAccountId	integer	No	ID akun layanan.	12345
WorkspaceId	integer	No	ID ruang kerja.	12****
PageNumber	integer	No	Nomor halaman.	1
PageSize	integer	No	Jumlah entri yang dikembalikan per halaman.	10
VpcId	string	No	ID virtual private cloud (VPC). Catatan Tidak dapat digunakan sebagai filter untuk saat ini.	vpc-bp10wnlcmor****

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	EE214ECD-4330-503A-82F0-FFB03975****
ErrorCode	string	Kode kesalahan.	UserNotExist
ErrorMessage	string	Pesan kesalahan yang dikembalikan saat panggilan gagal.	UnknownError
Success	boolean	Menunjukkan apakah permintaan berhasil. Nilai yang valid: true: Permintaan berhasil. false: Permintaan gagal.	true
TotalCount	integer	Jumlah total ruang kerja yang memenuhi kondisi.	10
Data	object
BaseWorkspaces	array<object>	Set data.
	object
Description	string	The description of the workspace.	Test
CreatorId	integer	The ID of the creator.	123
OwnerUid	string	The Alibaba Cloud UID of the owner.	15608564799****
WorkspaceId	integer	The workspace ID.	8652340494****
GmtModified	string	The update time.	2025-01-01 00:00:00
ServiceAccountId	integer	The ID of the service account.	12345
CreatorUid	string	The Alibaba Cloud account UID of the creator.	1344****
ServiceAccountNickName	string	The nickname of the service account.	testname
Name	string	The name of the workspace.	workspace-xxxx
AlreadyJoined	boolean	Whether the current user has joined the workspace.	true
TenantId	integer	The ID of the tenant to which the workspace belongs.	23456
GmtCreate	string	The creation time.	2025-01-01 00:00:00
ServiceAccountUid	string	The Alibaba Cloud account UID of the service account.	1422****
OwnerId	integer	The owner ID.	123****
VpcId	string	The VPC ID.	vpc-25fl3qjqb****
Region	string	The region ID.	cn-hangzhou
WorkspaceName	string	The name of the workspace.	test-workspace
CreatorNickName	string	The nickname of the creator.	work*****
OwnerNickName	string	The nickname of the owner.	hel****
NextToken	string	NextToken tidak digunakan.	token-xxx
MaxResults	integer	Sama dengan TotalCount. Jumlah total ruang kerja yang memenuhi kondisi.	10

Contoh

Respons sukses

JSONformat

{
  "RequestId": "EE214ECD-4330-503A-82F0-FFB03975****",
  "ErrorCode": "UserNotExist",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "TotalCount": 10,
  "Data": {
    "BaseWorkspaces": [
      {
        "Description": "Test",
        "CreatorId": 123,
        "OwnerUid": "15608564799****",
        "WorkspaceId": 0,
        "GmtModified": "2025-01-01 00:00:00",
        "ServiceAccountId": 12345,
        "CreatorUid": "1344****",
        "ServiceAccountNickName": "testname",
        "Name": "workspace-xxxx",
        "AlreadyJoined": true,
        "TenantId": 23456,
        "GmtCreate": "2025-01-01 00:00:00",
        "ServiceAccountUid": "1422****",
        "OwnerId": 0,
        "VpcId": "vpc-25fl3qjqb****",
        "Region": "cn-hangzhou",
        "WorkspaceName": "test-workspace",
        "CreatorNickName": "work*****",
        "OwnerNickName": "hel****"
      }
    ]
  },
  "NextToken": "token-xxx",
  "MaxResults": 10
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.