获取组件信息。
接口说明
- 需要购买 DataWorks 基础版及以上版本才能使用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dataworks:GetComponent | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ProjectId | long | 否 | DataWorks 工作空间的 ID。您可以登录 DataWorks 管控台,进入工作空间配置页面获取工作空间 ID。该参数与 ProjectIdentifier 参数,二者必须设置其一,用来确定本次 API 调用操作的 DataWorks 工作空间。 | 10000 |
| ComponentId | string | 是 | 组件 ID。 | 1112312312312 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "0000-ABCD-EFG****",
"Component": {
"ComponentId": "43cd873b-235c-44f8-be07-e4d4cf7e73b0",
"ProjectId": 64623,
"Name": "dim_whse_epet_warehouse_jz_storage_stock_lot_relation_id",
"Owner": 207316543660665800,
"CreateTime": "2017-04-27T05:37:05Z",
"ModifyTime": "2024-01-26T07:44:21Z",
"Spec": {
"kind": "Component",
"name": "com1",
"spec": {
"components": [
{
"name": "test11",
"id": "8196828925037*****",
"owner": "054664",
"description": "",
"script": {
"language": "odps-sql",
"path": "test11",
"content": "select '@@{bizdate}', '@@{my_input_table}'",
"runtime": {
"command": "SQL_COMPONENT"
}
},
"inputs": [
{
"name": "bizdate",
"type": "string"
},
{
"name": "my_input_table",
"type": "string"
}
],
"outputs": [
{
"name": "my_output_table1",
"type": "string"
}
]
}
]
}
},
"Description": "None",
"RegionId": "cn-hangzhou"
}
}错误码
| HTTP status code | 错误码 | 错误信息 |
|---|---|---|
| 404 | InvalidComponent.NotFound | The specified Component does not exist. |
访问错误中心查看更多错误码。
