ListComponents - 获取组件列表_大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

获取组件列表。

接口说明

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

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
ProjectId	long	否	数据源关联的工作空间 ID。您可以通过 ListProjects 接口获取工作空间 ID。	100001
Name	string	否	数据源的名称。	xm_create_test
PageNumber	integer	否	请求的数据页数，用于翻页。	1
PageSize	integer	否	每页显示的条数，默认为 10 条，最大为 100 条。	1000

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。用于出现错误后排查问题。	952795279527ab****
PagingInfo	object	分页信息。
TotalCount	integer	总记录数。	100
PageNumber	integer	分页页码。	1
PageSize	integer	每页显示的条数	10
Components	array<object>	数据集加速组件的创建者的 Uid，在阿里云内为 RAM 用户 ID （阿里云账号创建则直接为阿里云账号 ID）。
component	object	数据集加速组件的创建者的 Uid，在阿里云内为 RAM 用户 ID （阿里云账号创建则直接为阿里云账号 ID）。
ModifyTime	string	发布流程修改时间戳。	2023-11-30T13:30:58Z
Script	object	脚本信息
Path	string	脚本路径	/
Runtime	object	运行时
Command	string	命令	SQL_COMPONENT
Id	string	ID	348100
Owner	string	责任人	252675537980665607
Description	string	描述	vpc peering management_staging
CreateTime	string	创建时间。	2023-03-13 16:35:59
Outputs	array<object>	输出参数
Parameter	object	节点输出项
DefaultValue	string	默认值	32000
Type	string	参数类型	string
Description	string	参数描述	zdy
Name	string	参数名称	auto_updateAlertRule_test_bULIRo
ProjectId	long	DataWorks 工作空间的 ID。您可以登录 DataWorks 管控台，进入工作空间配置页面获取工作空间 ID。该参数与 ProjectIdentifier 参数，二者必须设置其一，用来确定本次 API 调用操作的 DataWorks 工作空间。	199925
ComponentId	string	组件 ID。可作为查询导播台组件、修改导播台组件、删除导播台组件的请求参数。	12312313123
Inputs	array<object>	输入参数
Parameter	object	变量元素
DefaultValue	string	默认值	mdb.shard.2x.2xlarge.d
Type	string	参数类型	string
Description	string	参数描述	None
Name	string	参数名称	auto_updateAlertRule_test_bULIRo
Name	string	资源名称	auto_updateAlertRule_test_lJd81f

示例

正常返回示例

JSON格式

{
  "RequestId": "952795279527ab****",
  "PagingInfo": {
    "TotalCount": 100,
    "PageNumber": 1,
    "PageSize": 10,
    "Components": [
      {
        "ModifyTime": "2023-11-30T13:30:58Z",
        "Script": {
          "Path": "/",
          "Runtime": {
            "Command": "SQL_COMPONENT"
          },
          "Id": 348100
        },
        "Owner": 252675537980665600,
        "Description": "vpc peering management_staging",
        "CreateTime": "2023-03-13 16:35:59",
        "Outputs": [
          {
            "DefaultValue": 32000,
            "Type": "string",
            "Description": "zdy",
            "Name": "auto_updateAlertRule_test_bULIRo"
          }
        ],
        "ProjectId": 199925,
        "ComponentId": 12312313123,
        "Inputs": [
          {
            "DefaultValue": "mdb.shard.2x.2xlarge.d",
            "Type": "string",
            "Description": "None",
            "Name": "auto_updateAlertRule_test_bULIRo"
          }
        ],
        "Name": "auto_updateAlertRule_test_lJd81f"
      }
    ]
  }
}

错误码

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