ListAiccsRobot

Updated at:

Retrieve the list of robot scripts, including robot type, robot name, robot ID, associated business, and industry information.

Operation description

  • Before invoking this API, ensure that you already have scripts that have passed the Review.

  • If you do not have any scripts that have passed the Review, add a script and submit it for Review in the Script Management interface first.

Queries per second (QPS) limit

  • Per-user invocation frequency: No Rate Limiting.

  • API frequency: 500 queries per second.

Note

If the total invocations from multiple users exceed the API frequency limit, throttle 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:ListAiccsRobot

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

RobotName

string

No

The robot name. You can view the robot name in the Script Management interface.

测试机器人

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.

successful

Data

array<object>

Robot scripts.

object

List of scripts.

RobotType

string

Robot type.

CUSTOM

AtSence

string

Associated business.

新房销售

AtProfession

string

Associated industry.

房地产

RobotName

string

Robot name.

测试机器人

Id

integer

Robot ID.

12****

Code

string

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

OK

Success

boolean

Indicates whether the API invocation Succeeded. Valid values:

  • true: Succeeded.

  • false: failed.

true

Examples

Success response

JSON format

{
  "RequestId": "D9CB3933-9FE3-4870-BA8E-2BEE91B69D23",
  "Message": "successful",
  "Data": [
    {
      "RobotType": "CUSTOM",
      "AtSence": "新房销售",
      "AtProfession": "房地产",
      "RobotName": "测试机器人",
      "Id": 0
    }
  ],
  "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.