GetComputeResource - 查看计算资源详情

更新时间:
复制 MD 格式

根据计算资源ID,查询指定的计算资源。

接口说明

  1. 需要购买 DataWorks 基础版及以上版本才能使用。

  2. 需要在 DataWorks 项目空间中具有如下至少一种角色:

  • 租户所有者、空间管理员、部署、开发、项目所有者、运维

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

Id

integer

计算资源 ID,计算资源的唯一标识符。

11792

ProjectId

integer

DataWorks 工作空间的 ID。

10003

返回参数

名称

类型

描述

示例值

object

返回结果。

RequestId

string

请求 ID,用于定位日志,排查问题。

9252F32F-D855-549E-8898-61CF5A733050

ComputeResource

object

计算资源的详情。

Id

integer

计算资源 ID。

16738

ProjectId

integer

计算资源所属项目空间 ID。

52660

Name

string

计算资源名称。

MyCs

Type

string

计算资源类型。

hologres

ConnectionProperties

any

计算资源的具体连接配置信息,包括连接地址、访问身份、环境信息等。计算资源环境 envType 信息是此对象的成员属性,包括

  • Dev(开发环境);

  • Prod(生产环境); 不同类型的计算资源在不同的配置模式(ConnectionPropertiesMode)下具有不同的属性信息规范,

{ "envType": "Prod", "regionId": "cn-beijing", "instanceId": "hgprecn-cn-x0r3oun4k001", "database": "testdb", "securityProtocol": "authTypeNone", "authType": "Executor", "authIdentity": "1107550004253538" }

ConnectionPropertiesMode

string

计算资源添加的类别,不同 type 下会有不同的子类型,对应有不同的参数约束,场景举例:

  • InstanceMode 实例模式;

  • UrlMode 连接串模式;

  • CdhMode:CDH 模式。

InstanceMode

Description

string

计算资源描述信息。

My Description

CreateTime

integer

创建时间(时间戳格式)。

1698286929333

CreateUser

string

创建者的 ID。

1107550004253538

ModifyTime

integer

最近修改的时间(时间戳)。

1698286929333

ModifyUser

string

修改者 的 ID。

1107550004253538

QualifiedName

string

计算资源的业务唯一键,以 Holo 举例格式是${tenantOwnerId}:${regionId}:${type}:${instanceId}:${database}。

1107550004253538:cn-beijing:holo:hgprecn-cn-x0r3oun4k001:testdb

WhetherDefault

boolean

是否为默认计算资源。

true

示例

正常返回示例

JSON格式

{
  "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
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情