Querying the Plug-in Action List
Function
This API is used to query the plug-in function, connector, and manager list
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/workspaces/{workspace_id}/soc/components/{component_id}/action
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Definition Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID Constraints N/A Range N/A Default Value N/A |
|
workspace_id |
Yes |
String |
Definition Workspace ID. Range N/A |
|
component_id |
Yes |
String |
Plug-in ID. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
offset |
No |
Integer |
Definition Offset. Constraints N/A Range N/A Default Value N/A |
|
limit |
No |
Integer |
Definition Data volume. Constraints N/A Range N/A Default Value N/A |
|
enabled |
Yes |
Boolean |
Whether to enable. |
Request Parameters
None
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Definition Response code. Constraints N/A |
|
total |
Integer |
Definition Total data records. Constraints N/A |
|
size |
Integer |
Definition Current page size. Constraints N/A |
|
page |
Integer |
Definition Current page number. Constraints N/A |
|
message |
String |
Definition Error message in the response. Constraints N/A |
|
success |
Boolean |
Definition Whether the response is successful. Constraints N/A |
|
request_id |
String |
Definition Request ID. Constraints N/A |
|
data |
Array of ComponentActionInfo objects |
List. |
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
ID of the plug-in execution function. |
|
action_name |
String |
Plugin execution function name. |
|
action_desc |
String |
Description of the plugin execution function. |
|
action_type |
String |
Execution function type. The options are action, connector, and manager. |
|
create_time |
String |
Creation time. |
|
creator_name |
String |
Creator name. |
|
can_update |
Boolean |
Whether the upgrade is supported. The options are true andfalse. |
|
action_version_id |
String |
ID of the currently enabled plugin execution function version. |
|
action_version_name |
String |
Alias of the currently enabled custom execution function version. |
|
action_version_number |
String |
Current execution function version. |
|
action_enable |
String |
Enabled/Disabled. |
|
action_input |
String |
Input parameter list of the current execution function version. |
|
action_output |
String |
Output parameter list of the current execution function version. |
|
action_versions |
Array of ComponentActionVersionInfo objects |
Full plugin execution function version list. |
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
ID of the plugin execution function version. |
|
create_time |
String |
Creation time. |
|
creator_name |
String |
Creator name. |
|
update_time |
String |
Update time. |
|
action_version_name |
String |
Alias of the custom execution function version. |
|
action_version_number |
String |
Execution function version number generated internally, which increases only in an ascending order. |
|
action_version_desc |
String |
Version description. |
|
action_input |
String |
Input parameter list of the execution function version. |
|
action_output |
String |
Output parameter list of the execution function version. |
|
action_code |
String |
Execution function code. |
|
action_status |
String |
Version review status |
|
action_enable |
String |
Enabled/Disabled. |
|
debug_result |
String |
Debugging result. |
|
debug_output |
String |
Debug output. |
|
debug_log |
String |
Debug logs. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Definition Error code. Range N/A |
|
message |
String |
Definition Error description. Range N/A |
Example Requests
None
Example Responses
None
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Object returned upon a successful response. |
|
400 |
Object returned upon a response error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot