Memanggil API ListWorkspaces untuk menanyakan workspace - Platform For AI

Menampilkan daftar workspace di suatu wilayah.

Deskripsi operasi

Anda dapat menentukan opsi kueri yang berbeda melalui parameter options untuk mengambil informasi tentang workspace.

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

paiworkspace:ListWorkspaces

list

*All Resource

*

None

Sintaks permintaan

GET /api/v1/workspaces HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
PageNumber	integer	No	Nomor halaman dari daftar workspace. Nilainya dimulai dari 1. Nilai default adalah 1.	1
PageSize	integer	No	Jumlah entri yang dikembalikan per halaman untuk kueri terpaginasi. Nilai default adalah 20.	20
SortBy	string	No	Bidang yang digunakan untuk pengurutan dalam kueri terpaginasi. Nilai default adalah GmtCreateTime. Nilai yang valid: GmtCreateTime (default): Diurutkan berdasarkan waktu pembuatan. GmtModifiedTime: Diurutkan berdasarkan waktu modifikasi.	GmtCreateTime
Order	string	No	Urutan pengurutan untuk bidang yang ditentukan dalam kueri terpaginasi. Nilai yang valid: ASC (default): Urutan menaik. DESC: Urutan menurun.	ASC
WorkspaceName	string	No	Nama workspace.	abc
ModuleList	string	No	Daftar modul yang dipisahkan koma. Nilai default: PAI.	PAI
Status	string	No	Status workspace. Nilai yang didukung: ENABLED: Workspace berjalan normal. INITIALIZING: Workspace sedang diinisialisasi. FAILURE: Pembuatan atau pembaruan workspace gagal. DISABLED: Workspace dinonaktifkan secara manual. FROZEN: Workspace dibekukan karena pembayaran tertunda. UPDATING: Workspace sedang diperbarui.	ENABLED
Option	string	No	Opsi. Nilai yang valid: GetWorkspaces (default): Mendapatkan daftar workspace. Parameter Workspaces dikembalikan. GetResourceLimits: Mendapatkan batas resource. Parameter ResourceLimits dikembalikan.	GetWorkspaces
Verbose	boolean	No	Menentukan apakah informasi detail workspace ditampilkan. Nilai yang valid: false (default): Tidak menampilkan detail. true: Menampilkan detail.	true
Fields	string	No	Daftar bidang yang dikembalikan untuk detail workspace. Ini membatasi properti workspace dalam respons. Pisahkan beberapa properti dengan koma (,). Saat ini, hanya Id yang didukung, yang menunjukkan ID workspace.	Id
WorkspaceIds	string	No	Daftar ID workspace. Pisahkan beberapa ID workspace dengan koma (,).	123,234
ResourceGroupId	string	No	ID kelompok sumber daya. Untuk informasi selengkapnya tentang cara melihat ID kelompok sumber daya, lihat View the basic information of a resource group.	rg-acfmwp7rky****
UserId	string	No

Elemen respons

Element	Type	Description	Example
	object	Objek respons.
RequestId	string	ID permintaan.	8D7B2E70-F770-505B-A672-09F1D8F2EC1E
Workspaces	array<object>	Daftar detail workspace. Daftar ini dikembalikan ketika Option diatur ke GetWorkspaces.
	array<object>	Detail workspace.
WorkspaceId	string	ID workspace.	123
WorkspaceName	string	Nama workspace.	workspace-example
GmtCreateTime	string	Waktu pembuatan workspace. Waktu mengikuti standar ISO 8601 dan dalam format yyyy-MM-ddTHH:mm:ss.SSSZ. Waktu ditampilkan dalam UTC.	2021-01-21T17:12:35.232Z
GmtModifiedTime	string	Waktu terakhir workspace dimodifikasi. Waktu mengikuti standar ISO 8601 dan dalam format yyyy-MM-ddTHH:mmZ. Waktu ditampilkan dalam UTC.	2021-01-21T17:12:35.232Z
Description	string	Deskripsi workspace.	workspace description example
Creator	string	ID pengguna pembuat.	122424353535
EnvTypes	array	Daftar lingkungan dalam workspace.
	string	Lingkungan dalam workspace. Lingkungan tergantung pada mode workspace: Workspace dalam mode dasar hanya memiliki lingkungan produksi (prod). Workspace dalam mode standar memiliki lingkungan pengembangan (dev) dan lingkungan produksi (prod).	prod
Status	string	Status workspace.	ENABLED
AdminNames	array	Daftar nama akun administrator.
	string	Nama akun administrator.	demo_test@***.aliyunid.com
IsDefault	boolean	Menunjukkan apakah workspace tersebut merupakan workspace default.	false
ExtraInfos	object	Informasi tambahan. Saat ini mencakup TenantId, yang menunjukkan ID penyewa.	{"TenantId": "4286******98"}
resourceGroupId	string	ID kelompok sumber daya.	rg-acfmwp7rky****
TotalCount	integer	Jumlah total workspace yang memenuhi kondisi kueri.	1
ResourceLimits	object	Jenis dan batas kuantitas resource yang dapat diaktifkan pengguna dalam suatu workspace. Daftar ini dikembalikan ketika Option diatur ke GetResourceLimits. Jenis resource yang didukung: MaxCompute_share: MaxCompute bayar sesuai penggunaan. MaxCompute_isolate: MaxCompute subscription. DLC_share: DLC bayar sesuai penggunaan. PAI_isolate: PAI subscription. PAI_share: PAI bayar sesuai penggunaan. DataWorks_isolate: DataWorks subscription. DataWorks_share: DataWorks bayar sesuai penggunaan.	{ "MaxCompute_share": 1, "MaxCompute_isolate": 1, "DLC_share": 1 }

Contoh

Respons sukses

JSONformat

{
  "RequestId": "8D7B2E70-F770-505B-A672-09F1D8F2EC1E",
  "Workspaces": [
    {
      "WorkspaceId": "123",
      "WorkspaceName": "workspace-example",
      "GmtCreateTime": "2021-01-21T17:12:35.232Z",
      "GmtModifiedTime": "2021-01-21T17:12:35.232Z",
      "Description": "workspace description example",
      "Creator": "122424353535",
      "EnvTypes": [
        "prod"
      ],
      "Status": "ENABLED",
      "AdminNames": [
        "demo_test@***.aliyunid.com"
      ],
      "IsDefault": false,
      "ExtraInfos": {
        "TenantId": "4286******98"
      },
      "resourceGroupId": "rg-acfmwp7rky****"
    }
  ],
  "TotalCount": 1,
  "ResourceLimits": {
    "MaxCompute_share": 1,
    "MaxCompute_isolate": 1,
    "DLC_share": 1
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.