Consulta del resultado de verificación de un elemento de configuración de seguridad
Función
Esta API se utiliza para consultar el resultado de la comprobació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}/detail
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 |
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 registros en cada 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 |
---|---|---|
severity |
String |
Nivel de riesgo. Su valor puede ser:
Mínimo: 0 Máximo: 65534 |
check_type |
String |
Tipo de verificación de configuración (línea base), por ejemplo, SSH, CentOS 7, Windows Server 2019 R2, Windows Server 2016 R2 y MySQL5-Windows. Mínimo: 0 Máximo: 256 |
check_type_desc |
String |
Descripción del tipo de línea base, incluidas las normas para los elementos de verificación y los problemas que se pueden auditar. Mínimo: 0 Máximo: 65534 |
check_rule_num |
Integer |
Indica el número total de elementos de verificación del tipo de verificación de configuración actual (línea base). Por ejemplo, si el tipo estándar de la línea base de SSH es hw_standard, la seguridad del servidor proporciona 17 elementos de verificación, pero solo se detectan cinco elementos de verificación de la línea base de SSH en todos los servidores. Por lo tanto, el valor de check_rule_num es 5. Todos los elementos de verificación se verifican en un servidor. El valor de check_rule_num es 17. Mínimo: 0 Máximo: 2147483647 |
failed_rule_num |
Integer |
Número de elementos de verificación fallidos. Si un servidor no logra pasar un elemento de verificación en check_rule_num, el elemento se cuenta en fail_rule_num. Mínimo: 0 Máximo: 2147483647 |
passed_rule_num |
Integer |
Número de elementos de verificación aprobados. Si un servidor pasa un elemento de verificación en check_rule_num, el elemento de verificación se cuenta en passed_rule_num. Mínimo: 0 Máximo: 2147483647 |
ignored_rule_num |
Integer |
Número de elementos de verificación ignorados. Si un servidor ignora un elemento de verificación en check_rule_num, el elemento de verificación se cuenta en ignored_rule_num. Mínimo: 0 Máximo: 2147483647 |
host_num |
Long |
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 |
Solicitudes de ejemplo
Esta API se utiliza para consultar la lista de verificación de configuració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/detail?standard=hw_standard&enterprise_project_id=xxx
Ejemplo de respuestas
Código de estado: 200
Resultado de verificación del elemento de configuración de seguridad
{ "check_rule_num" : 17, "check_type_desc" : "This policy checks the basic security configuration items of the SSH service to improve the security of the SSH service.", "failed_rule_num" : 15, "host_num" : 2, "ignored_rule_num" : 1, "passed_rule_num" : 14, "severity" : "Medium" }
Código de ejemplo del SDK
El código de ejemplo del SDK es el siguiente.
Java
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 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 ShowRiskConfigDetailSolution { 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(); ShowRiskConfigDetailRequest request = new ShowRiskConfigDetailRequest(); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withStandard("<standard>"); request.withHostId("<host_id>"); request.withLimit(<limit>); request.withOffset(<offset>); try { ShowRiskConfigDetailResponse response = client.showRiskConfigDetail(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
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 |
# 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 = ShowRiskConfigDetailRequest() request.enterprise_project_id = "<enterprise_project_id>" request.standard = "<standard>" request.host_id = "<host_id>" request.limit = <limit> request.offset = <offset> response = client.show_risk_config_detail(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
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 |
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.ShowRiskConfigDetailRequest{} enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest request.Standard = "<standard>" hostIdRequest:= "<host_id>" request.HostId = &hostIdRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest response, err := client.ShowRiskConfigDetail(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 |
Resultado de verificación del elemento de configuración de seguridad |
Códigos de error
Consulte Códigos de error.