ListRobotNode

Updated at:

Retrieves the list of robot node information based on the robot ID, which is the script ID.

Operation description

  • Robot node information includes flow name, model name, node name, whether it is an output, and output ID.

  • Before invoking this API, you can confirm the robot ID (that is, the script ID) by following the instructions in the Request Parameters section.

Queries per second (QPS) limits

  • Per-user invocation frequency: No rate limiting.

  • API frequency: 500 queries per second (QPS).

Note

If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.

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

aiccs:ListRobotNode

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

RobotId

integer

Yes

The robot ID, which is the script ID.
You can obtain it in the outbound robot > Script Management section of the left-side navigation pane in the Artificial Intelligence Cloud Call Service console.

100002674****

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

Request ID.

D9CB3933-9FE3-4870-BA8E-2BEE91B69D23

Message

string

Description of the status code.

Ok

Data

array<object>

List of robot nodes.

object

List of robot nodes.

ProcessName

string

Flow name.

开场白

ModelName

string

Model name.

模型一

IsOutput

integer

Whether it is an output. Valid values:

  • 1: Yes.

  • 0: No.

1

NodeName

string

Node name.

理财

NodeIdentifier

string

Output ID.

12****

Code

string

Request status code. A return value of OK indicates that the request succeeded.

Ok

Success

boolean

Whether the API invocation succeeded. Valid values:

  • true: Succeeded.

  • false: Failed.

true

Examples

Success response

JSON format

{
  "RequestId": "D9CB3933-9FE3-4870-BA8E-2BEE91B69D23",
  "Message": "Ok",
  "Data": [
    {
      "ProcessName": "开场白",
      "ModelName": "模型一",
      "IsOutput": 1,
      "NodeName": "理财",
      "NodeIdentifier": "12****"
    }
  ],
  "Code": "Ok",
  "Success": true
}

Error codes

HTTP status code

Error code

Error message

Description

400 PermissionInsufficient Insufficient permissions. Please contact the Alibaba Cloud account administrator.
400 ParameterError The parameter is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.