Gunakan GetProject untuk kueri informasi workspace DataWorks-DataWorks-Alibaba Cloud -

Mengkueri informasi tentang ruang kerja DataWorks.

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
ProjectId	integer	No	ID ruang kerja DataWorks. Anda dapat memanggil operasi ListProjects untuk mengkueri ID.	466230
ProjectIdentifier	string	No	Nama ruang kerja DataWorks. Anda dapat memanggil operasi ListProjects untuk mengkueri nama.	test_project

Elemen respons

Element	Type	Description	Example
	object	The returned result.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	1AFAE64E-D1BE-432B-A9****
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Data	object	The information about the workspace.
Status	integer	The status of the workspace. Valid values: 0: AVAILABLE, which indicates that the workspace runs 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. The workspace enters this state after you associate a new compute engine with the workspace and the compute engine is initialized. 9: UPDATE_FAILED, which indicates that the workspace fails to be updated.	0
MaxFlowNode	integer	This parameter is deprecated.	1
ProjectId	integer	The ID of the workspace.	466230
IsAllowDownload	integer	Indicates whether you are allowed to download the query result from DataStudio. Valid values: 1: You are allowed to download the query result from DataStudio. 0: You are not allowed to download the query result from DataStudio.	1
ProjectMode	integer	The mode of the workspace. Valid values: 2: The workspace is in basic mode. 3: The workspace is in standard mode.	2
GmtModified	string	The time when the workspace was last modified. Example: `Dec 3, 2019 9:12:20 PM`.	Dec 3, 2019 9:12:20 PM
ProdStorageQuota	string	This parameter is deprecated.	1
ProjectDescription	string	The description of the workspace.	test_describe
DevelopmentType	integer	This parameter is deprecated.	4
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
DefaultDiResourceGroupIdentifier	string	The ID of the resource group that was allocated by default when you purchased an exclusive resource group for MaxCompute.	group_280749521****
SchedulerMaxRetryTimes	integer	The default maximum number of automatic reruns that are allowed after an error occurs.	3
ProtectedMode	integer	Indicates whether the workspace protection feature is enabled. Valid values: 1: enabled 0: disabled	1
SchedulerRetryInterval	integer	The default interval between automatic reruns after an error occurs. Unit: milliseconds. The maximum interval is 30 minutes. You must pay attention to the conversion between units.	120000
Appkey	string	This parameter is deprecated.	0
DevStorageQuota	string	This parameter is deprecated.	0
ResidentArea	string	The type of the workspace. Valid values: private swap	private
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
Destination	integer	This parameter is deprecated.	0
ProjectName	string	The display name of the workspace.	test_project
ProjectIdentifier	string	The name of the workspace.	test_project
DisableDevelopment	boolean	Indicates whether the Develop role is disabled. Valid values: false (default) true	true
ProjectOwnerBaseId	string	The ID of the Alibaba Cloud account used by the workspace owner.	18229311****
BaseProject	boolean	This parameter is deprecated.	false
UseProxyOdpsAccount	boolean	Indicates whether a proxy account is used to access the MaxCompute compute engine associated with the workspace.	true
GmtCreate	string	The time when the workspace was created. Example: `Dec 3, 2019 9:12:20 PM`.	Oct 10, 2019 3:42:53 PM
TenantId	integer	The tenant ID.	280749521
EnvTypes	array	The environment information of the workspace.
	string	The environment of the workspace. Valid values: PROD and DEV. The value PROD indicates the production environment. Workspaces in basic mode provide only the production environment. The value DEV indicates the development environment. Workspaces in standard mode provide both the development environment and the production environment.	["PROD"]
ResourceManagerResourceGroupId	string	The resource group ID.	rg-acfmzbn7****
Tags	array<object>	The tags added to the workspace.
	object
Key	string	The tag key.	key
Value	string	The tag value.	value

Contoh

Respons sukses

JSONformat

{
  "HttpStatusCode": 200,
  "RequestId": "1AFAE64E-D1BE-432B-A9****",
  "Success": true,
  "Data": {
    "Status": 0,
    "MaxFlowNode": 1,
    "ProjectId": 466230,
    "IsAllowDownload": 1,
    "ProjectMode": 2,
    "GmtModified": "Dec 3, 2019 9:12:20 PM",
    "ProdStorageQuota": " 1",
    "ProjectDescription": "test_describe",
    "DevelopmentType": 4,
    "TablePrivacyMode": 1,
    "DefaultDiResourceGroupIdentifier": "group_280749521****",
    "SchedulerMaxRetryTimes": 3,
    "ProtectedMode": 1,
    "SchedulerRetryInterval": 120000,
    "Appkey": "0",
    "DevStorageQuota": "0",
    "ResidentArea": "private",
    "IsDefault": 1,
    "Destination": 0,
    "ProjectName": "test_project",
    "ProjectIdentifier": "test_project",
    "DisableDevelopment": true,
    "ProjectOwnerBaseId": "18229311****",
    "BaseProject": false,
    "UseProxyOdpsAccount": true,
    "GmtCreate": "Oct 10, 2019 3:42:53 PM",
    "TenantId": 280749521,
    "EnvTypes": [
      "[\"PROD\"]"
    ],
    "ResourceManagerResourceGroupId": "rg-acfmzbn7****",
    "Tags": [
      {
        "Key": "key",
        "Value": "value"
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	Invalid.Tenant.ProjectNotExists	The project does not exist.
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.