获取组件列表。
接口说明
需要购买 DataWorks 基础版及以上版本才能使用。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dataworks:ListComponents | list | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ProjectId | long | 否 | 数据源关联的工作空间 ID。您可以通过 ListProjects 接口获取工作空间 ID。 | 100001 |
| Name | string | 否 | 数据源的名称。 | xm_create_test |
| PageNumber | integer | 否 | 请求的数据页数，用于翻页。 | 1 |
| PageSize | integer | 否 | 每页显示的条数，默认为 10 条，最大为 100 条。 | 1000 |
返回参数
示例
正常返回示例
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"
}
]
}
}错误码
访问错误中心查看更多错误码。