Memanggil API ListWorkspaces untuk menanyakan workspace - Platform For AI - Alibaba Cloud - Platform For AI

Mengambil daftar ruang kerja di wilayah tertentu.

Deskripsi operasi

Anda dapat menggunakan parameter option untuk menentukan opsi kueri guna mengambil informasi terkait ruang kerja yang berbeda.

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 ruang kerja. Nilai minimum: 1. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman untuk penomoran halaman. Nilai default: 20.	20
SortBy	string	No	Bidang pengurutan untuk penomoran halaman. Nilai default: GmtCreateTime. Nilai yang valid: GmtCreateTime (default): diurutkan berdasarkan waktu pembuatan. GmtModifiedTime: diurutkan berdasarkan waktu modifikasi.	GmtCreateTime
Order	string	No	Urutan pengurutan untuk bidang pengurutan yang ditentukan selama penomoran halaman. Nilai yang valid: ASC (default): urutan menaik. DESC: urutan menurun.	ASC
WorkspaceName	string	No	Nama ruang kerja.	abc
ModuleList	string	No	Daftar modul yang dipisahkan koma. Nilai default: PAI.	PAI
Status	string	No	Status ruang kerja. Nilai yang valid: ENABLED: Normal. INITIALIZING: Sedang diinisialisasi. FAILURE: Gagal. DISABLED: Dinonaktifkan secara manual. FROZEN: Dibekukan karena pembayaran tertunda. UPDATING: Sedang diperbarui.	ENABLED
Option	string	No	Opsi kueri. Nilai yang valid: GetWorkspaces (default): mengambil daftar ruang kerja. Parameter Workspaces dikembalikan. GetResourceLimits: mengambil batas resource. Parameter ResourceLimits dikembalikan.	GetWorkspaces
Verbose	boolean	No	Menentukan apakah akan menampilkan informasi detail ruang kerja. Nilai yang valid: false (default): tidak menampilkan informasi detail. true: menampilkan informasi detail.	true
Fields	string	No	Daftar bidang yang dikembalikan untuk detail ruang kerja. Parameter ini membatasi properti ruang kerja yang dikembalikan dalam hasil. Pisahkan beberapa properti dengan koma (,). Saat ini, hanya Id yang didukung, yang menunjukkan ID ruang kerja.	Id
WorkspaceIds	string	No	Daftar ID ruang kerja. Pisahkan beberapa ID ruang kerja dengan koma (,).	123,234
ResourceGroupId	string	No	ID kelompok sumber daya. Untuk informasi tentang cara melihat ID kelompok sumber daya, lihat Lihat informasi dasar kelompok sumber daya.	rg-acfmwp7rky****
UserId	string	No	ID pengguna.	17*****1743

Elemen respons

Element	Type	Description	Example
	object	Struktur respons.
RequestId	string	ID permintaan.	8D7B2E70-F770-505B-A672-09F1D8F2EC1E
Workspaces	array<object>	Daftar detail ruang kerja. Daftar ini dikembalikan ketika Option diatur ke GetWorkspaces.
	array<object>	Detail ruang kerja.
WorkspaceId	string	ID ruang kerja.	123
WorkspaceName	string	Nama ruang kerja.	workspace-example
GmtCreateTime	string	Waktu saat ruang kerja dibuat. Waktu dalam standar ISO 8601 di UTC+0. Format: yyyy-MM-ddTHH:mm:ss.SSSZ.	2021-01-21T17:12:35.232Z
GmtModifiedTime	string	Waktu saat ruang kerja terakhir dimodifikasi. Waktu dalam standar ISO 8601 di UTC+0. Format: yyyy-MM-ddTHH:mmZ.	2021-01-21T17:12:35.232Z
Description	string	Deskripsi ruang kerja.	workspace description example
Creator	string	ID pengguna dari pembuat.	122424353535
EnvTypes	array	Daftar lingkungan yang terdapat dalam ruang kerja.
	string	Lingkungan yang terdapat dalam ruang kerja. Nilai yang valid: Mode Simple hanya berisi lingkungan produksi (prod). Mode Standard berisi lingkungan pengembangan (dev) dan lingkungan produksi (prod).	prod
Status	string	Status ruang kerja.	ENABLED
AdminNames	array	Daftar nama akun administrator.
	string	Nama akun administrator.	demo_test@***.aliyunid.com
IsDefault	boolean	Menunjukkan apakah ruang kerja tersebut merupakan ruang kerja 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****
DisplayName	string	Nama tampilan ruang kerja.
TotalCount	integer	Total jumlah ruang kerja yang sesuai dengan kondisi kueri.	1
ResourceLimits	object	Jenis resource dan batas kuantitas yang dapat diaktifkan pengguna dalam ruang kerja. Daftar ini dikembalikan ketika Option diatur ke GetResourceLimits. Jenis resource yang didukung saat ini meliputi: MaxCompute_share: MaxCompute pay-as-you-go. MaxCompute_isolate: MaxCompute subscription. DLC_share: DLC pay-as-you-go. PAI_isolate: PAI subscription. PAI_share: PAI pay-as-you-go. DataWorks_isolate: DataWorks subscription. DataWorks_share: DataWorks pay-as-you-go.	{ "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****",
      "DisplayName": ""
    }
  ],
  "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.