Consulta de la lista de elementos de verificación de un elemento de configuración de seguridad especificada de una imagen
Función
Esta API se utiliza para consultar la lista de elementos de verificación de un elemento de configuración de seguridad especificada de una imagen.
Método de invocación
Para obtener más información, consulte Invocación a las API.
URI
GET /v5/{project_id}/image/baseline/risk-configs/{check_name}/rules
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID de proyecto Mínimo: 1 Máximo: 256 |
check_name |
Sí |
String |
Nombre de línea base Mínimo: 0 Máximo: 128 |
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. Valor predeterminado: 0 Mínimo: 1 Máximo: 256 |
image_type |
Sí |
String |
Tipo de imagen. Las opciones son las siguientes:
Mínimo: 1 Máximo: 32 |
offset |
No |
Integer |
Desfase, que especifica la posición inicial del registro que se va a devolver. El valor debe ser un número no menor que 0. El valor predeterminado es 0. Mínimo: 0 Máximo: 2000000 Valor predeterminado: 0 |
limit |
No |
Integer |
Número de registros mostrados en cada página. Mínimo: 10 Máximo: 200 Valor predeterminado: 10 |
namespace |
No |
String |
Especifica el nombre de la organización. Si no hay información de imagen disponible, se consultan todas las imágenes. Mínimo: 0 Máximo: 64 |
image_name |
No |
String |
Nombre de imagen Mínimo: 0 Máximo: 128 |
image_version |
No |
String |
Nombre de etiqueta de imagen 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 |
instance_id |
No |
String |
ID de instancia de repositorio de empresa. Esta API no es necesaria para la edición compartida de SWR. Mínimo: 0 Máximo: 128 |
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: 1 Máximo: 32768 |
region |
Sí |
String |
ID de región Mínimo: 0 Máximo: 128 |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
total_num |
Integer |
Riesgos totales Mínimo: 0 Máximo: 2147483647 |
data_list |
Array of ImageRiskConfigsCheckRulesResponseInfo 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 Mínimo: 0 Máximo: 256 |
check_type |
String |
Tipo de línea base 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 |
Elementos 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 |
scan_result |
String |
Resultado de la detección. Las opciones son las siguientes:
Mínimo: 0 Máximo: 64 |
Solicitudes de ejemplo
Consultar los elementos de verificación de un elemento de configuración de seguridad especificada cuya organización es aaa, el nombre de la imagen es centos7, la versión de la imagen es común y el tipo de estándar es estándar de Huawei.
GET https://{endpoint}/v5/{project_id}/image/baseline/risk-configs/{check_name}/rules?offset=0&limit=200&image_type=private_image&namespace=aaa&image_name=centos7/test&image_version=common&standard=hw_standard&enterprise_project_id=all_granted_eps
Ejemplo de respuestas
Código de estado: 200
Lista de comprobación del elemento de configuración de seguridad especificada
{ "total_num" : 1, "data_list" : [ { "check_rule_id" : "1.1", "check_rule_name" : "Rule: Password locking policy.", "check_name" : "CentOS 7", "check_type" : "CentOS 7", "standard" : "hw_standard", "scan_result" : "failed", "severity" : "High" } ] }
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 51 52 53 54 55 56 57 |
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 ListImageRiskConfigRulesSolution { 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(); ListImageRiskConfigRulesRequest request = new ListImageRiskConfigRulesRequest(); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withImageType("<image_type>"); request.withOffset(<offset>); request.withLimit(<limit>); request.withNamespace("<namespace>"); request.withImageName("<image_name>"); request.withImageVersion("<image_version>"); request.withStandard("<standard>"); request.withResultType("<result_type>"); request.withCheckRuleName("<check_rule_name>"); request.withSeverity("<severity>"); request.withInstanceId("<instance_id>"); try { ListImageRiskConfigRulesResponse response = client.listImageRiskConfigRules(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 35 36 37 38 39 40 41 |
# 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 = ListImageRiskConfigRulesRequest() request.enterprise_project_id = "<enterprise_project_id>" request.image_type = "<image_type>" request.offset = <offset> request.limit = <limit> request.namespace = "<namespace>" request.image_name = "<image_name>" request.image_version = "<image_version>" request.standard = "<standard>" request.result_type = "<result_type>" request.check_rule_name = "<check_rule_name>" request.severity = "<severity>" request.instance_id = "<instance_id>" response = client.list_image_risk_config_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
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 54 55 56 57 |
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.ListImageRiskConfigRulesRequest{} enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest request.ImageType = "<image_type>" offsetRequest:= int32(<offset>) request.Offset = &offsetRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest namespaceRequest:= "<namespace>" request.Namespace = &namespaceRequest imageNameRequest:= "<image_name>" request.ImageName = &imageNameRequest imageVersionRequest:= "<image_version>" request.ImageVersion = &imageVersionRequest request.Standard = "<standard>" resultTypeRequest:= "<result_type>" request.ResultType = &resultTypeRequest checkRuleNameRequest:= "<check_rule_name>" request.CheckRuleName = &checkRuleNameRequest severityRequest:= "<severity>" request.Severity = &severityRequest instanceIdRequest:= "<instance_id>" request.InstanceId = &instanceIdRequest response, err := client.ListImageRiskConfigRules(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.