Checking NICs and Security Groups

Function

This API is used to check whether NICs and security groups of a target server meet the requirements.

Calling Method

For details, see Calling APIs.

URI

GET /v3/tasks/{t_project_id}/networkacl/{t_network_id}/check

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
t_project_id	Yes	String	The ID of the project to which the target server belongs. Minimum: 0 Maximum: 255
t_network_id	Yes	String	The ID of the subnet where the target server is located. Minimum: 0 Maximum: 255

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
region_id	Yes	String	The region ID. Minimum: 0 Maximum: 255
os_type	Yes	String	The OS type. Minimum: 0 Maximum: 255

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Minimum: 1 Maximum: 16384

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
-	String	Checking NICs and security groups succeeded.

Status code: 403

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	The error code. Minimum: 0 Maximum: 255
error_msg	String	The error message. Minimum: 0 Maximum: 255
encoded_authorization_message	String	The encrypted authorization information. Minimum: 0 Maximum: 65535
error_param	Array of strings	Error parameters. Minimum: 0 Maximum: 65535 Array Length: 1 - 20
details	Array of details objects	The error details. Array Length: 1 - 20

**Table 6** details
Parameter	Type	Description
error_code	String	The SMS error code. Minimum: 0 Maximum: 65535
error_msg	String	The SMS error message. Minimum: 0 Maximum: 65535

Example Requests

This example checks whether NICs and security groups meet the requirements.

GET    https://{endpoint}/v3/tasks/abcd6935282ses/networkacl/dsedasdferet9685/check?region_id=XXXXX&os_type=XXXX

Example Responses

Status code: 200

Checking NICs and security groups succeeded.

{ }

Status code: 403

Authentication failed.

{
  "error_code" : "SMS.9004",
  "error_msg" : "The current account does not have the permission to execute policy. You do not have permission to perform action XXX on resource XXX.",
  "encoded_authorization_message" : "XXXXXX",
  "error_param" : [ "You do not have permission to perform action XXX on resource XXX." ],
  "details" : [ {
    "error_code" : "SMS.9004",
    "error_msg" : "You do not have permission to perform action XXX on resource XXX."
  } ]
}