QueryPrimaryObjectData - 分页查询主对象数据

更新时间:
复制 MD 格式

通过运营对象名称分页查询主对象数据,支持过滤和搜索。

接口说明

请求说明

  • 该 API 用于根据给定的运营对象名称(如 customer_1)分页查询相关的主对象数据。

  • 支持通过关键字进行搜索,并且可以设置是否仅返回被标记为关注的对象。

  • 可以使用复杂的过滤条件来进一步筛选结果,包括但不限于等于、不等于、大于、小于等逻辑操作符。

  • 如果没有配置主对象类型,则会返回一个空的结果集。

  • 请求中包含的数据将经过鉴权与过滤处理,确保安全性和准确性。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

winnexo:QueryPrimaryObjectData

none

*全部资源

*

无 无

请求语法

POST /openapi/queryPrimaryObjectData HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

tenantId

string

否

租户 ID,公共参数;winnexo-cli 通过 --tenant-id 显式传入。

10000

operatingObjectName

string

是

运营对象名称(如 customer_1)。

string_value

page

integer

否

页码(从 1 开始)。

1

pageSize

integer

否

每页数量,范围 1-100。

20

keyword

string

否

关键字搜索(固定匹配 name;若 schema 定义 description,则同时匹配 description)。

示例关键词

onlyFavorites

boolean

否

仅返回关注的主对象;false 或不传则返回全部对象(包含 isFavorited 标识)。

false

返回参数

名称

类型

描述

示例值

object

分页查询主对象数据

code

string

业务状态码:成功为 200,失败为后端错误码(ERR.* / InvalidParameter.*)。

200

items

array<object>

增量信息列表。

string_value

object

结果列表,最大 size:50。

string_value

string

结果

string_value

message

string

错误描述,成功时为空。

ok

page

integer

当前页码。

1

pageSize

integer

每页数量。

100

requestId

string

请求追踪 ID。

019FF406-1B10-0065-A97D-2D1920C2A03D

total

integer

总数。

0

示例

正常返回示例

JSON格式

{
  "code": "200",
  "items": [
    {
      "key": "string_value"
    }
  ],
  "message": "ok",
  "page": 1,
  "pageSize": 100,
  "requestId": "019FF406-1B10-0065-A97D-2D1920C2A03D",
  "total": 0
}

错误码

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

变更历史

更多信息,参考变更详情变更详情。