GetDigitalEmployeeEntityData - STAROps - Alibaba Cloud Documentation Center

Queries the entity data of a digital human.

Operation description

Queries the entity data of a digital human.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

starops:GetDigitalEmployeeEntityData

get

*DigitalEmployee

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
name	string	Yes	The name of the digital human whose entity data you want to query.	sample-agent

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The maximum size of the query body is 4 MiB. The query is executed by the internal resources of the digital human. You do not need to provide an internal storage identifier.
from	integer	Yes	The UNIX timestamp, in seconds.	1770000000
query	string	Yes	Only the .entity or .topo semantic sources of the current digital human can be queried. Explicit access to internal storage or external data sources is prohibited.	.entity with(type='deployment', domain='k8s') \| limit 100
to	integer	Yes	The UNIX timestamp, in seconds. The value must be greater than the value of from.	1770003600

Response elements

Element	Type	Description	Example
	object	The response data.
data	array	The query results in a two-dimensional array. Each cell is returned as a string.
	array	The list item.
	string	The list item.	example
header	array	The column names of the query results.
	string	The list item.	example
requestId	string	The unique identifier of the request, generated by the STAROps access layer.	0A1B2C3D-4E5F-6789-ABCD-1234567890AB
responseStatus	object	The completion status, retry suggestions, and execution status of the query.
level	string	The status level. Valid values: Error : Error message. Info : Information. Warn : Warning.	Info
result	string	The query result status. Valid values: Error : Failed. PartialSuccess : Partially succeeded. Success : Succeeded.	Success
retryPolicy	string	The retry suggestion. Valid values: Once : Retry once is recommended. Continuous : Continuous retry is allowed. None : Retry is not recommended.	None
statusItem	array<object>	The list of status details.
	object	The list item.
code	string	The status code.	Success
level	string	The status level.	example
message	string	The status message.	success
suggestion	string	The suggestion for handling the issue.	example

Examples

Success response

JSON format

{
  "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"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.