调用GetNodeTypeListInfos查询节点类型信息,包括类型Code和类型名称。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetNodeTypeListInfo |
要执行的操作。 |
PageNumber | Integer | 是 | 1 |
请求的数据页数,用于翻页。 |
PageSize | Integer | 是 | 50 |
请求的数据页大小,最大值为100。 |
ProjectId | Long | 是 | 10000 |
Dataworks工作空间的ID,您可以单击页面右上角的小扳手图标,进入工作空间管理页面进行查看。 |
RegionId | String | 是 | cn-zhangjiakou |
服务所在地域的列表。 |
ProjectIdentifier | String | 否 | dw_project |
Dataworks工作空间的唯一标识符,即数据开发页面顶部切换工作空间处的英文标识。该参数与ProjectId参数二者必须设置其一,以确定本次API调用操作的Dataworks工作空间。 |
Keyword | String | 否 | ODPS SQ |
节点类型的名称,您可以在DataStudio目录树中看到某个节点类型的名称,支持中英文,与locale需要对齐。支持模糊搜索,不填的情况下返回所有节点类型。 |
Locale | String | 否 | zh-CN |
语言筛选,支持zh-CN和en-US。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
NodeTypeInfoList | Struct |
符合条件的节点类型信息列表。 |
|
NodeTypeInfo | Array of NodeTypeInfo |
单个节点类型的信息。 |
|
NodeType | Integer | 10 |
节点类型Type(数字)。 |
NodeTypeName | String | ODPS SQL |
节点类型的名称。 |
PageNumber | Integer | 1 |
当前数据页的页码。 |
PageSize | Integer | 50 |
当前数据页的大小。 |
TotalCount | Integer | 127 |
满足查询条件的数据总条数。 |
RequestId | String | 0000-ABCD-EFG**** |
本次调用的唯一ID。出现错误后,您可以根据该ID排查问题。 |
示例
请求示例
http(s)://[Endpoint]/?Action=GetNodeTypeListInfo
&PageNumber=1
&PageSize=50
&ProjectId=10000
&RegionId=cn-zhangjiakou
&<公共请求参数>
正常返回示例
XML
格式
<RequestId>0000-ABCD-EFG****</RequestId>
<NodeTypeInfoList>
<TotalCount>127</TotalCount>
<PageSize>50</PageSize>
<PageNumber>1</PageNumber>
<NodeTypeInfo>
<NodeTypeName>ODPS SQL</NodeTypeName>
<NodeType>10</NodeType>
</NodeTypeInfo>
</NodeTypeInfoList>
JSON
格式
{
"RequestId": "0000-ABCD-EFG****",
"NodeTypeInfoList": {
"TotalCount": 127,
"PageSize": 50,
"PageNumber": 1,
"NodeTypeInfo": {
"NodeTypeName": "ODPS SQL",
"NodeType": 10
}
}
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
500 | InternalError.System | An internal system error occurred. Try again later. | 系统内部错误,请稍后再试。 |
500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | 系统内部错误,请稍后再试。 |
429 | Throttling.Api | The request for this resource has exceeded your available limit. | 对该资源的请求已超过您的可用上限。 |
429 | Throttling.System | The DataWorks system is busy. Try again later. | DataWorks系统繁忙,请稍后再试。 |
429 | Throttling.User | Your request is too frequent. Try again later. | 您的请求过于频繁,请尝试放缓请求速度。 |
403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | 您被限制访问,请开通DataWorks企业版或旗舰版。 |
访问错误中心查看更多错误码。