Querying the Plug-in List

Function

This API is used to query the plug-in list.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/setting/plugins

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.
host_name	No	String	Definition Server name. Constraints N/A Range The value contains 1 to 256 characters. Default Value N/A
host_id	No	String	Definition Unique ID of a server. Constraints N/A Range The value can contain 1 to 64 characters. Default Value N/A
private_ip	No	String	Definition Server private IP address. Constraints N/A Range The value can contain 1 to 128 characters. Default Value N/A
public_ip	No	String	Definition Server EIP. Constraints N/A Range For IPv4, the value contains 7 to 15 characters. For IPv6, the value contains 15 to 39 characters. Default Value None
group_id	No	String	Definition Unique ID of a server group. Constraints N/A Range The value can contain 1 to 64 characters. Default Value N/A
asset_value	No	String	Definition Asset importance. Constraints N/A Range important common test Default Value None
limit	No	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10-200 Default Value 10
offset	No	Integer	Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value The default value is 0.
agent_status	No	String	Definition Agent status Constraints N/A Range Length: 1 to 256 characters Default Value N/A
detect_result	No	String	Definition Check result. Constraints N/A Range Length: 1 to 256 characters Default Value N/A
host_status	No	String	Definition Server status Constraints N/A Range Length: 1 to 256 characters Default Value N/A
os_type	No	String	Definition OS type. Constraints N/A Range Linux: Linux OS. Windows: Windows OS. Default Value N/A
ip_addr	No	String	EIP or private IP address.
protect_status	No	String	Protection status.
group_name	No	String	Server group name.
policy_group_id	No	String	Policy group ID.
policy_group_name	No	String	Policy group name.
label	No	String	Asset tag
charging_mode	No	String	Billing mode.
refresh	No	Boolean	Definition Whether to forcibly synchronize servers from ECS. Constraints N/A Range true: yes false: no Default Value false
above_version	No	Boolean	Whether to return all the versions later than the current version.
name	Yes	String	Definition Plug-in Constraints N/A Range Length: 1 to 256 characters Default Value opa-docker-authz
version	No	String	Definition Enabled HSS edition. Constraints N/A Range Length: 1 to 256 characters Default Value N/A
plugin	No	String	Definition Plug-in type. Constraints N/A Range opa-docker-authz: Docker plug-in. Default Value opa-docker-authz
outside_host	No	Boolean	Definition Whether a server is a non-Huawei Cloud server. Constraints N/A Range true: yes false: no Default Value false

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Total
data_list	Array of PluginResponseInfo objects	data list

**Table 5** PluginResponseInfo
Parameter	Type	Description
host_name	String	Server name
host_id	String	Server ID
private_ip	String	Private IP address
public_ip	String	Public IP Address
os_type	String	OS type.
plugin_name	String	Plugin
plugin_version	String	Plug-in version
plugin_status	String	Plug-in status
upgrade_status	String	Plug-in upgrade status

Example Requests

Querying the Plug-in List

GET https://{endpoint}/v5/{project_id}/setting/plugins?name=opa-docker-authz

Example Responses

Status code: 200

Response to the Docker plug-in installation script.

{
  "total_num" : 1,
  "data_list" : [ {
    "host_name" : "Z00840245-TNISN",
    "host_id" : "08cfa327-b01b-39fa-989c-9842d4e5a4d3",
    "private_ip" : "10.112.30.223",
    "public_ip" : "192.168.0.135",
    "os_type" : "Linux",
    "plugin_name" : "xxx",
    "plugin_version" : "xxx",
    "plugin_status" : "xx",
    "upgrade_status" : "xx"
  } ]
}