数据类类型列表 - ListDataClassType
功能介绍
数据类类型列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/workspaces/{workspace_id}/soc/dataclasses/{dataclass_id}/types
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| workspace_id | 是 | String | 参数解释: 工作空间id 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| dataclass_id | 是 | String | 参数解释: 数据类的唯一ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| offset | 否 | Integer | 参数解释: 偏移量 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| limit | 否 | Integer | 参数解释: 数据量 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| enabled | 否 | Boolean | 参数解释: 是否是启用的类型 约束限制: 不涉及 取值范围: 类型启用true,禁用状态false 默认取值: 不涉及 |
| order | 否 | String | 参数解释: 列表排序的顺序 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| sortby | 否 | String | 参数解释: 列表排序的字段 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| sub_category | 否 | String | 参数解释: 查询的子类型名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| name | 否 | String | 参数解释: 查询的类型名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| category_code | 否 | String | 参数解释: 查询的类型标识 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| is_built_in | 否 | Boolean | 参数解释: 是否内置 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| layout_name | 否 | String | 参数解释: 指定与类型关联的布局名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| level | 否 | Integer | 参数解释: 指定查询类型的层级 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| content-type | 是 | String | 参数解释: 内容类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| dataclass_type_details | Array of DataClassTypeDetailInfo objects | 参数解释: 类型详情数据 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| total | Integer | 参数解释: 类型数据总条数 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 类型id 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| dataclass_id | String | 参数解释: 数据类id 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| domain_id | String | 参数解释: 账号id 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| project_id | String | 参数解释: 项目id 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| workspace_id | String | 参数解释: 工作空间id 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| region_id | String | 参数解释: 局点id 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| layout_id | String | 参数解释: 布局id 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| layout_name | String | 参数解释: 布局名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| category | String | 参数解释: 数据类类型分类 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| category_code | String | 参数解释: 数据类类型分类编码 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| sub_category | String | 参数解释: 数据类子类型名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| sub_category_code | String | 参数解释: 数据类子类型业务编码 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| description | String | 参数解释: 数据类子类型描述 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| enabled | Boolean | 参数解释: 类型启用状态 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| level | Integer | 参数解释: 类型层级 约束限制: 不涉及 取值范围: 大类:1,子类型:2 默认取值: 不涉及 |
| is_built_in | Boolean | 参数解释: 是否内置,true内置,false非内置 约束限制: 不涉及 取值范围: 大类:1,子类型:2 默认取值: 不涉及 |
| sla | Long | 参数解释: 响应时长 约束限制: 不涉及 取值范围: 0-15634800000 默认取值: 不涉及 |
| creator_id | String | 参数解释: 创建人id 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| creator_name | String | 参数解释: 创建人名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| modifier_id | String | 参数解释: 修改人id 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| modifier_name | String | 参数解释: 修改人名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| create_time | String | 参数解释: 创建时间 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| update_time | String | 参数解释: 修改时间 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| dataclass_business_code | String | 参数解释: 所属数据类业务编码 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| sub_count | Integer | 参数解释: 类型分类下子类型数目 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| error_msg | String | 参数解释: 错误描述 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| error_msg | String | 参数解释: 错误描述 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求示例
无
响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
| 400 | 请求参数有误 |
| 500 | 请求失败 |
错误码
请参见错误码。