Queries the specified computing resource based on the computing resource ID.
Operation description
-
DataWorks Basic Edition or a more advanced edition is required.
-
You must have at least one of the following roles in the DataWorks workspace:
-
Tenant Owner, Workspace Administrator, Deploy, Developer, Project Owner, O&M
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Id |
integer |
Yes |
The computing resource ID, which is the unique identifier for the resource. |
11792 |
| ProjectId |
integer |
Yes |
The ID of the DataWorks workspace. |
10003 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The returned result. |
||
| RequestId |
string |
The request ID. You can use the request ID to locate logs and troubleshoot issues. |
9252F32F-D855-549E-8898-61CF5A733050 |
| ComputeResource |
object |
The details of the computing resource. |
|
| Id |
integer |
The ID of the computing resource. |
16738 |
| ProjectId |
integer |
The ID of the workspace to which the computing resource belongs. |
52660 |
| Name |
string |
The name of the computing resource. |
MyCs |
| Type |
string |
The type of the computing resource. |
hologres |
| ConnectionProperties |
any |
The specific connection configuration details for the computing resource, including the connection address, access identity, and environment information. envType, which specifies the computing resource environment, is a property of this object. Valid values:
|
{ "envType": "Prod", "regionId": "cn-beijing", "instanceId": "hgprecn-cn-x0r3oun4k001", "database": "testdb", "securityProtocol": "authTypeNone", "authType": "Executor", "authIdentity": "1107550004253538" } |
| ConnectionPropertiesMode |
string |
The addition category of the computing resource. Different types will have different subtypes, each with corresponding parameter constraints. For instance:
|
InstanceMode |
| Description |
string |
The description of the computing resource. |
My Description |
| CreateTime |
integer |
The creation time, in timestamp format. |
1698286929333 |
| CreateUser |
string |
The ID of the creator. |
1107550004253538 |
| ModifyTime |
integer |
The last modification time, in timestamp format. |
1698286929333 |
| ModifyUser |
string |
The ID of the modifier. |
1107550004253538 |
| QualifiedName |
string |
The business unique key for the computing resource. For example, the format for Hologres is ${tenantOwnerId}:${regionId}:${type}:${instanceId}:${database}. |
1107550004253538:cn-beijing:holo:hgprecn-cn-x0r3oun4k001:testdb |
| WhetherDefault |
boolean |
Specifies whether it is the default computing resource. |
true |
Examples
Success response
JSON format
{
"RequestId": "9252F32F-D855-549E-8898-61CF5A733050",
"ComputeResource": {
"Id": 16738,
"ProjectId": 52660,
"Name": "MyCs",
"Type": "hologres",
"ConnectionProperties": "{\n\t\"envType\": \"Prod\",\n\t\"regionId\": \"cn-beijing\",\n \"instanceId\": \"hgprecn-cn-x0r3oun4k001\",\n \"database\": \"testdb\",\n \"securityProtocol\": \"authTypeNone\",\n \"authType\": \"Executor\",\n \"authIdentity\": \"1107550004253538\"\n}",
"ConnectionPropertiesMode": "InstanceMode",
"Description": "My Description",
"CreateTime": 1698286929333,
"CreateUser": "1107550004253538",
"ModifyTime": 1698286929333,
"ModifyUser": "1107550004253538",
"QualifiedName": "1107550004253538:cn-beijing:holo:hgprecn-cn-x0r3oun4k001:testdb",
"WhetherDefault": true
}
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.