查询自定义实体定义列表(包括自定义实体类型和扩展表类型)。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| PageNumber |
integer |
否 |
分页页码,默认为 1 |
1 |
| PageSize |
integer |
否 |
分页大小,默认为 10,最大 100 |
10 |
| DisplayName |
string |
否 |
类型定义展示名称,按普通文本包含匹配 |
CustomReport |
| Description |
string |
否 |
描述,模糊匹配 |
description |
| Extend |
string |
否 |
扩展模式过滤,支持 NONE、TABLE |
NONE |
| SortBy |
string |
否 |
排序字段,支持 Name、CreateTime、ModifyTime |
CreateTime |
| Order |
string |
否 |
排序方向,支持 Asc、Desc |
Asc |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
RequestId |
ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS |
| Success |
boolean |
请求是否成功 |
true |
| PagingInfo |
object |
分页信息 |
|
| TotalCount |
integer |
总数 |
10 |
| PageNumber |
integer |
分页页码 |
1 |
| PageSize |
integer |
分页大小 |
10 |
| MetaEntityDefs |
array |
自定义实体定义列表 |
|
| MetaEntityDef |
自定义实体定义 |
示例
正常返回示例
JSON格式
{
"RequestId": "ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS",
"Success": true,
"PagingInfo": {
"TotalCount": 10,
"PageNumber": 1,
"PageSize": 10,
"MetaEntityDefs": [
{
"Name": "biz_api",
"EntityType": "custom_entity-biz_api",
"DisplayName": "业务API",
"Description": "test",
"AttributeDefs": [
{
"Name": "apiCode",
"DisplayName": "API编码",
"Type": "STRING",
"IsOptional": true,
"SearchFilterEnabled": false,
"DisplayEnabled": true,
"AllowedValues": [
"LABEL_1"
],
"Description": "层级描述"
}
],
"Extend": "NONE",
"CreateTime": 1780553640613,
"ModifyTime": 1780553640613
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。