GetDigitalEmployeeEntityData - 查询数字员工 Entity 数据 - 全域智能运维平台 STAROps

查询数字员工的 Entity 数据

接口说明

查询数字员工的 Entity 数据。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

starops:GetDigitalEmployeeEntityData

get

*DigitalEmployee

acs:starops:{#regionId}:{#accountId}:digitalemployee/{#name}

无

请求语法

POST /digitalEmployee/{name}/entities/query HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
name	string	是	需要查询 Entity 数据的数字员工名称。	sample-agent

请求参数

名称	类型	必填	描述	示例值
body	object	否	查询体最大 4 MiB。查询由数字员工的内部资源执行，无需提供内部存储标识。
from	integer	是	Unix 时间戳，单位为秒。	1770000000
query	string	是	仅允许查询当前数字员工的 .entity 或 .topo 语义源，禁止显式访问内部存储或外部数据源。	.entity with(type='deployment', domain='k8s') \| limit 100
to	integer	是	Unix 时间戳，单位为秒，必须大于 from。	1770003600

返回参数

名称	类型	描述	示例值
	object	接口返回数据。
data	array	二维数组形式的查询结果；每个单元格按字符串返回。
	array	列表项。
	string	列表项。	example
header	array	查询结果每一列的名称。
	string	列表项。	example
requestId	string	由 STAROps 接入层生成的本次请求唯一标识。	0A1B2C3D-4E5F-6789-ABCD-1234567890AB
responseStatus	object	查询的完成情况、重试建议和执行状态。
level	string	状态级别。枚举值： Error : 错误信息 Info : 信息提示 Warn : 警告信息	Info
result	string	查询结果状态。枚举值： Error : 失败 PartialSuccess : 部分成功 Success : 成功	Success
retryPolicy	string	重试建议。枚举值： Once : 建议重试一次 Continuous : 可持续重试 None : 不建议重试	None
statusItem	array<object>	状态详情列表。
	object	列表项。
code	string	状态码。	Success
level	string	状态级别。	example
message	string	状态信息。	success
suggestion	string	处理建议。	example

示例

正常返回示例

JSON格式

{
  "data": [
    [
      "example"
    ]
  ],
  "header": [
    "example"
  ],
  "requestId": "0A1B2C3D-4E5F-6789-ABCD-1234567890AB",
  "responseStatus": {
    "level": "Info",
    "result": "Success",
    "retryPolicy": "None",
    "statusItem": [
      {
        "code": "Success",
        "level": "example",
        "message": "success",
        "suggestion": "example"
      }
    ]
  }
}

错误码

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

变更历史

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