ListRobotParams
Queries the list of robot parameters by robot ID, which is also the script ID.
Operation description
-
Before invoking this API, ensure that you have already added input parameters for the robot.
-
If your robot does not have any input parameters, go to the Script Management > Configuration > Input and Output Parameters interface and click to add an input parameter.
Queries per second (QPS) Limit
Per-user invocation frequency: No rate limiting.
API frequency: 500 queries per second.
If the total invocations from multiple users exceed the API frequency limit, throttle will be triggered.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
aiccs:ListRobotParams |
get |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RobotId |
integer |
Yes |
Robot ID, which is also the script ID. You can view it on the Script Management interface or obtain it by using the ListAiccsRobot API. |
12**** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
Request ID. |
FF67D4D5-4E90-1DF5-BB8F-060BBFAD72DB |
| Message |
string |
Description of the status code. |
successful |
| Data |
array<object> |
Parameter information. |
|
|
object |
List of parameters. |
||
| IsEmpty |
integer |
Indicates whether the parameter is required. Valid values:
|
0 |
| ParamCode |
string |
Parameter ID. |
1 |
| ParamName |
string |
Parameter name. |
名称 |
| Code |
string |
Status code. A value of 200 indicates that the request succeeded. |
200 |
| Success |
boolean |
Indicates whether the API invocation succeeded. Valid values:
|
true |
Examples
Success response
JSON format
{
"RequestId": "FF67D4D5-4E90-1DF5-BB8F-060BBFAD72DB",
"Message": "successful",
"Data": [
{
"IsEmpty": 0,
"ParamCode": "1",
"ParamName": "名称"
}
],
"Code": "200",
"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.