Consulta de la lista de verificación de un elemento de configuración de seguridad
Función
Esta API se utiliza para consultar la lista de verificación de un elemento de configuración de seguridad especificado.
Método de invocación
Para obtener más información, consulte Invocación a las API.
URI
GET /v5/{project_id}/baseline/risk-config/{check_name}/check-rules
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID de proyecto Mínimo: 20 Máximo: 64 |
check_name |
Sí |
String |
Nombre de línea base, por ejemplo, SSH, CentOS 7 y Windows. Mínimo: 0 Máximo: 256 |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
enterprise_project_id |
No |
String |
ID de proyecto empresarial. Para consultar todos los proyectos empresariales, establezca este parámetro en all_granted_eps. Mínimo: 0 Máximo: 64 |
standard |
Sí |
String |
Tipo estándar. Su valor puede ser:
Mínimo: 0 Máximo: 32 |
result_type |
No |
String |
Tipo de resultado. Su valor puede ser:
Valor predeterminado: unhandled Mínimo: 0 Máximo: 64 |
check_rule_name |
No |
String |
Nombre del elemento de verificación. Se admite la coincidencia difusa. Mínimo: 0 Máximo: 2048 |
severity |
No |
String |
Nivel de riesgo. Su valor puede ser:
Mínimo: 0 Máximo: 255 |
host_id |
No |
String |
ID del servidor. Si no se especifica este parámetro, se consultan todos los servidores del usuario. Mínimo: 0 Máximo: 64 |
limit |
No |
Integer |
Número de elementos por página Mínimo: 0 Máximo: 200 Valor predeterminado: 10 |
offset |
No |
Integer |
Desfase, que especifica la posición inicial del registro que se va a devolver. El valor debe ser un número. Mínimo: 0 Máximo: 2000000 Valor predeterminado: 0 |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
Token de usuario. Se puede obtener invocando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es un token. Mínimo: 32 Máximo: 2097152 |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
total_num |
Long |
Riesgos totales Mínimo: 0 Máximo: 9223372036854775807 |
data_list |
Array of CheckRuleRiskInfoResponseInfo objects |
Lista de datos Longitud de matriz: 0 - 2147483647 |
Parámetro |
Tipo |
Descripción |
---|---|---|
severity |
String |
Nivel de riesgo. Su valor puede ser:
Mínimo: 0 Máximo: 255 |
check_name |
String |
Nombre de línea base, por ejemplo, SSH, CentOS 7 y Windows. Mínimo: 0 Máximo: 256 |
check_type |
String |
Tipo de línea base. Los valores de check_type y check_name son los mismos para los servidores Linux. Por ejemplo, ambos pueden configurarse como SSH o CentOS 7. Para los servidores Windows, los valores de check_type y check_name son diferentes. Por ejemplo, check_type se puede establecer en Windows Server 2019 R2 o Windows Server 2016 R2. Mínimo: 0 Máximo: 256 |
standard |
String |
Tipo estándar. Su valor puede ser:
Mínimo: 0 Máximo: 16 |
check_rule_name |
String |
Nombre dek elemento de verificación Mínimo: 0 Máximo: 2048 |
check_rule_id |
String |
ID de elemento de verificación Mínimo: 0 Máximo: 64 |
host_num |
Integer |
El número de servidores en los que se realiza la detección de la línea base actual. Mínimo: 0 Máximo: 2147483647 |
scan_result |
String |
Resultado de la detección. Su valor puede ser:
Mínimo: 0 Máximo: 64 |
status |
String |
Estado. Su valor puede ser:
Mínimo: 0 Máximo: 64 |
enable_fix |
Integer |
Indica si se admite la reparación con un solo clic. 1: sí; 0: no. Mínimo: 0 Máximo: 2147483647 |
enable_click |
Boolean |
Indica si se puede hacer clic en los botones reparar, omitir y verificar del elemento de verificación. true: se puede hacer clic en el botón. false: no se puede hacer clic en el botón. |
rule_params |
Array of CheckRuleFixParamInfo objects |
Rango de parámetros aplicables a los elementos de verificación que se pueden fijar mediante transferencia de parámetros. Este parámetro solo se devuelve para los elementos de verificación que admiten la corrección de transferencia de parámetros. Longitud de matriz: 0 - 2147483647 |
Parámetro |
Tipo |
Descripción |
---|---|---|
rule_param_id |
Integer |
ID de parámetro de elemento de verificación Mínimo: 0 Máximo: 10 |
rule_desc |
String |
descripción del parámetro del elemento de verificación Mínimo: 0 Máximo: 256 |
default_value |
Integer |
Valores predeterminados de los parámetros del elemento de verificación Mínimo: 0 Máximo: 2147483647 |
range_min |
Integer |
Valor mínimo de los parámetros del elemento de verificación Mínimo: 0 Máximo: 2147483647 |
range_max |
Integer |
Valor mínimo de los parámetros del elemento de verificación Mínimo: 0 Máximo: 2147483647 |
Solicitudes de ejemplo
Esta API se utiliza para consultar los elementos de verificación cuyo nombre de línea base es SSH, el estándar de verificación es el estándar de práctica de seguridad en la nube y el ID del proyecto empresarial es xxx.
GET https://{endpoint}/v5/{project_id}/baseline/risk-config/SSH/check-rules?standard=hw_standard&enterprise_project_id=xxx { "standard" : "hw_standard" }
Ejemplo de respuestas
Código de estado: 200
lista de verificación del elemento de configuración de seguridad especificado
{ "total_num" : 1, "data_list" : [ { "check_rule_id" : "1.1", "check_rule_name" : "Rule:Ensure that permissions on /etc/ssh/sshd_config are configured.", "check_type" : "SSH", "host_num" : 2, "standard" : "hw_standard", "scan_result" : "failed", "severity" : "High", "status" : "unhandled", "enable_fix" : 1, "enable_click" : true, "rule_params" : [ { "rule_param_id" : 1, "rule_desc" : "Set the timeout duration.", "default_value" : 5, "range_min" : 1, "range_max" : 10 }, { "rule_param_id" : 2, "rule_desc" : "Set the number of restarts.", "default_value" : 10, "range_min" : 1, "range_max" : 20 } ] } ] }
Código de ejemplo del SDK
El código de ejemplo del SDK es el siguiente.
Java
Esta API se utiliza para consultar los elementos de verificación cuyo nombre de línea base es SSH, el estándar de verificación es el estándar de práctica de seguridad en la nube y el ID del proyecto empresarial es xxx.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.hss.v5.region.HssRegion; import com.huaweicloud.sdk.hss.v5.*; import com.huaweicloud.sdk.hss.v5.model.*; public class ListRiskConfigCheckRulesSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("<YOUR REGION>")) .build(); ListRiskConfigCheckRulesRequest request = new ListRiskConfigCheckRulesRequest(); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withStandard("<standard>"); request.withResultType("<result_type>"); request.withCheckRuleName("<check_rule_name>"); request.withSeverity("<severity>"); request.withHostId("<host_id>"); request.withLimit(<limit>); request.withOffset(<offset>); try { ListRiskConfigCheckRulesResponse response = client.listRiskConfigCheckRules(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
Esta API se utiliza para consultar los elementos de verificación cuyo nombre de línea base es SSH, el estándar de verificación es el estándar de práctica de seguridad en la nube y el ID del proyecto empresarial es xxx.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
# coding: utf-8 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkhss.v5.region.hss_region import HssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkhss.v5 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListRiskConfigCheckRulesRequest() request.enterprise_project_id = "<enterprise_project_id>" request.standard = "<standard>" request.result_type = "<result_type>" request.check_rule_name = "<check_rule_name>" request.severity = "<severity>" request.host_id = "<host_id>" request.limit = <limit> request.offset = <offset> response = client.list_risk_config_check_rules(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
Esta API se utiliza para consultar los elementos de verificación cuyo nombre de línea base es SSH, el estándar de verificación es el estándar de práctica de seguridad en la nube y el ID del proyecto empresarial es xxx.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := hss.NewHssClient( hss.HssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListRiskConfigCheckRulesRequest{} enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest request.Standard = "<standard>" resultTypeRequest:= "<result_type>" request.ResultType = &resultTypeRequest checkRuleNameRequest:= "<check_rule_name>" request.CheckRuleName = &checkRuleNameRequest severityRequest:= "<severity>" request.Severity = &severityRequest hostIdRequest:= "<host_id>" request.HostId = &hostIdRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest response, err := client.ListRiskConfigCheckRules(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
Más información
Para obtener un código de ejemplo del SDK de más lenguajes de programación, consulte la pestaña Código de ejemplo en API Explorer. El código de ejemplo del SDK se puede generar automáticamente.
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
lista de verificación del elemento de configuración de seguridad especificado |
Códigos de error
Consulte Códigos de error.