Gunakan ListProjects untuk kueri daftar workspace-DataWorks-Alibaba Cloud - DataWorks

Mengkueri daftar ruang kerja DataWorks pada penyewa tempat pengguna berada.

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

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Parameter permintaan

Parameter	Type	Required	Description	Example
PageNumber	integer	No	Nomor halaman. Nilai valid: 1 hingga 100.	1
PageSize	integer	No	Jumlah entri per halaman. Nilai default: 10. Nilai maksimum: 100.	10
ResourceManagerResourceGroupId	string	No	ID kelompok sumber daya.	rg-acfmzbn7pt****
Tags	array<object>	No	Tag yang akan ditambahkan ke ruang kerja.
	object	No
Key	string	No	The key of tag N to add to the workspace.	key
Value	string	No	The value of tag N to add to the workspace.	value

Elemen respons

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	20658801****
PageResult	object	The results that are returned.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page. Default value: 10. Maximum value: 100.	10
TotalCount	integer	The total number of entries returned.	68
ProjectList	array<object>	The DataWorks workspaces.
	array<object>
ProjectStatusCode	string	The status code of the workspace. Valid values: AVAILABLE: 0, which indicates that the workspace is running as expected. DELETED: 1, which indicates that the workspace is deleted. INITIALIZING: 2, which indicates that the workspace is being initialized. INIT_FAILED: 3, which indicates that the workspace fails to be initialized. FORBIDDEN: 4, which indicates that the workspace is manually disabled. DELETING: 5, which indicates that the workspace is being deleted. DEL_FAILED: 6, which indicates that the workspace fails to be deleted. FROZEN: 7, which indicates that the workspace is frozen due to overdue payments. UPDATING: 8, which indicates that the workspace is being updated. After you associate a compute engine with the workspace, the system initializes the compute engine and updates the workspace. UPDATE_FAILED: 9, which indicates that the workspace fails to be updated.	AVAILABLE
ProjectStatus	integer	The status of the workspace. Valid values: 0: AVAILABLE, which indicates that the workspace is running as expected. 1: DELETED, which indicates that the workspace is deleted. 2: INITIALIZING, which indicates that the workspace is being initialized. 3: INIT_FAILED, which indicates that the workspace fails to be initialized. 4: FORBIDDEN, which indicates that the workspace is manually disabled. 5: DELETING, which indicates that the workspace is being deleted. 6: DEL_FAILED, which indicates that the workspace fails to be deleted. 7: FROZEN, which indicates that the workspace is frozen due to overdue payments. 8: UPDATING, which indicates that the workspace is being updated. After you associate a compute engine with the workspace, the system initializes the compute engine and updates the workspace. 9: UPDATE_FAILED, which indicates that the workspace fails to be updated.	0
ProjectName	string	The display name of the workspace.	test_project
ProjectIdentifier	string	The name of the workspace.	test_project
ProjectId	integer	The workspace ID.	466230
ProjectDescription	string	The description of the workspace.	test_describe
ProjectOwnerBaseId	string	The ID of the user used by the workspace owner.	13969939245****
ResourceManagerResourceGroupId	string	The resource group ID.	rg-acfmzbn7****
Tags	array<object>	The tags added to the workspace.
	object
Key	string	The key of tag N added to the workspace.	key
Value	string	The value of tag N added to the workspace.	value
DisableDevelopment	boolean	Indicates whether the Development role is disabled. Valid values: false: enabled true: disabled	true
UseProxyOdpsAccount	boolean	Indicates whether a proxy account is used to access the MaxCompute compute engine associated with the workspace. Valid values: false true	true
TablePrivacyMode	integer	Indicates whether the MaxCompute tables in the workspace are visible to the users within a tenant. Valid values: 0: invisible 1: visible	1
IsDefault	integer	Indicates whether the workspace is a default workspace. Valid values: 1: The workspace is a default workspace. 0: The workspace is not a default workspace.	1

Contoh

Respons sukses

JSONformat

{
  "RequestId": "20658801****",
  "PageResult": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 68,
    "ProjectList": [
      {
        "ProjectStatusCode": "AVAILABLE",
        "ProjectStatus": 0,
        "ProjectName": "test_project",
        "ProjectIdentifier": "test_project",
        "ProjectId": 466230,
        "ProjectDescription": "test_describe",
        "ProjectOwnerBaseId": "13969939245****",
        "ResourceManagerResourceGroupId": "rg-acfmzbn7****",
        "Tags": [
          {
            "Key": "key",
            "Value": "value"
          }
        ],
        "DisableDevelopment": true,
        "UseProxyOdpsAccount": true,
        "TablePrivacyMode": 1,
        "IsDefault": 1
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	Invalid.Tenant.ConnectionNotExists	The connection does not exist.
400	Invalid.Tenant.ProjectNotExists	The project does not exist.
400	Invalid.Tenant.UserAlreadyInProject	The user already exists in the project.
400	Invalid.Tenant.UserNotInProject	The user is not in the project.
403	Invalid.Tenant.UserIsNotProjectOwnerOrAdmin	The user is not a project administrator or owner.
403	Invalid.Tenant.UserNotInTenant	The user is not in tenant.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.