Querying the Operation Connection List
Function
This API is used to query the operation connection list.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/workspaces/{workspace_id}/soc/assetcredentials
|
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 |
|
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 |
|
name |
No |
String |
Connection name. |
|
component_name |
No |
String |
Plug-in name. |
|
creator_name |
No |
String |
Creator. |
|
modifier_name |
No |
String |
User who performed the modification. |
|
description |
No |
String |
Description. |
|
create_start_time |
No |
String |
Creation start time. |
|
create_end_time |
No |
String |
Creation end time. |
|
update_start_time |
No |
String |
Modification start time. |
|
update_end_time |
No |
String |
Modification end time. |
|
is_defense_type |
No |
Boolean |
Whether the operation connection is used for emergency policies. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token Constraints N/A Range N/A Default Value N/A |
|
content-type |
Yes |
String |
Definition Content type.
Constraints N/A Range
Default Value N/A |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Error code. |
|
message |
String |
Error message. |
|
total |
Integer |
Total data volume. |
|
asset |
Array of AssetInfoResponseBody objects |
Response body for operating a connection. |
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
Operation connection ID. |
|
project_id |
String |
Project ID. |
|
workspace_id |
String |
Workspace ID. |
|
name |
String |
Operation connection name. |
|
component_id |
String |
ID of the plugin to which the operation connection belongs. |
|
component_name |
String |
Name of the plugin ID to which the operation connection belongs. |
|
component_version_id |
String |
Plugin version ID. |
|
type |
String |
Operation connection type. |
|
status |
String |
Operation connection status (SUCCESS or FAILED) |
|
config |
String |
Configuration string of the operation connection. Configure the field value based on the plugin operation connection schema. |
|
description |
String |
Operation connection description. |
|
enabled |
Boolean |
Whether to enable this feature. |
|
create_time |
String |
Creation time. |
|
creator_id |
String |
Creator ID. |
|
creator_name |
String |
Creator name. |
|
update_time |
String |
Update time. |
|
modifier_id |
String |
Updater ID. |
|
modifier_name |
String |
Updater name. |
|
defense_type |
String |
Defense layer for the emergency policy. |
|
target_project_id |
String |
IAM project ID for the emergency policy. |
|
target_project_name |
String |
IAM project name for the emergency policy. |
|
target_enterprise_id |
String |
Enterprise project ID for the emergency policy. |
|
target_enterprise_name |
String |
Enterprise project name for the emergency policy. |
|
region_id |
String |
Region ID for the emergency policy. |
|
region_name |
String |
Region name for the emergency policy. |
|
can_be_deleted |
Boolean |
Whether the connection can be deleted. If the connection is used by a workflow, false is returned. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Definition Error code. Range N/A |
|
message |
String |
Definition Error description. Range N/A |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Definition Error code. Range N/A |
|
message |
String |
Definition Error description. Range N/A |
Example Requests
None
Example Responses
Status code: 200
Request succeeded.
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Request succeeded. |
|
400 |
Invalid request parameters. |
|
500 |
Request failed. |
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