Consulta da lista de itens de verificação de um item de configuração de segurança especificado de uma imagem
Função
Essa API é usada para consultar a lista de itens de verificação de um item de configuração de segurança especificado de uma imagem.
Método de chamada
Para obter detalhes, consulte Chamada de APIs.
URI
GET /v5/{project_id}/image/baseline/risk-configs/{check_name}/rules
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
ID do projeto Mínimo: 1 Máximo: 256 |
check_name |
Sim |
String |
Nome da linha de base Mínimo: 0 Máximo: 128 |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
enterprise_project_id |
Não |
String |
ID do projeto empresarial. Para consultar todos os projetos empresariais, defina este parâmetro como all_granted_eps. Padrão: 0 Mínimo: 1 Máximo: 256 |
image_type |
Sim |
String |
Tipo de imagem. As opções são as seguintes:
Mínimo: 1 Máximo: 32 |
offset |
Não |
Integer |
Deslocamento, que especifica a posição inicial do registro a ser retornado. O valor deve ser um número não menor que 0. O valor padrão é 0. Mínimo: 0 Máximo: 2000000 Padrão: 0 |
limit |
Não |
Integer |
Número de registros exibidos em cada página. Mínimo: 10 Máximo: 200 Padrão: 10 |
namespace |
Não |
String |
Especifica o nome da organização. Se nenhuma informação de imagem estiver disponível, todas as imagens serão consultadas. Mínimo: 0 Máximo: 64 |
image_name |
Não |
String |
Nome da imagem Mínimo: 0 Máximo: 128 |
image_version |
Não |
String |
Nome da tag de imagem Mínimo: 0 Máximo: 64 |
standard |
Sim |
String |
Tipo padrão. Seu valor pode ser:
Mínimo: 0 Máximo: 32 |
result_type |
Não |
String |
Tipo de resultado. Seu valor pode ser:
Padrão: unhandled Mínimo: 0 Máximo: 64 |
check_rule_name |
Não |
String |
Nome do item de verificação. A correspondência difusa é suportada. Mínimo: 0 Máximo: 2048 |
severity |
Não |
String |
Nível de risco. Seu valor pode ser:
Mínimo: 0 Máximo: 255 |
instance_id |
Não |
String |
ID da instância do repositório empresarial. Esta API não é necessária para a edição compartilhada do SWR. Mínimo: 0 Máximo: 128 |
Parâmetros de solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
X-Auth-Token |
Sim |
String |
Token do usuário. Ele pode ser obtido chamando a API do IAM usada para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é um token. Mínimo: 1 Máximo: 32768 |
region |
Sim |
String |
ID da região Mínimo: 0 Máximo: 128 |
Parâmetros de resposta
Código de status: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
total_num |
Integer |
Riscos totais Mínimo: 0 Máximo: 2147483647 |
data_list |
Array of ImageRiskConfigsCheckRulesResponseInfo objects |
Lista de dados Comprimento da matriz: 0–2147483647 |
Parâmetro |
Tipo |
Descrição |
---|---|---|
severity |
String |
Nível de risco. Seu valor pode ser:
Mínimo: 0 Máximo: 255 |
check_name |
String |
Nome da linha de base Mínimo: 0 Máximo: 256 |
check_type |
String |
Tipo de linha de base Mínimo: 0 Máximo: 256 |
standard |
String |
Tipo padrão. Seu valor pode ser:
Mínimo: 0 Máximo: 16 |
check_rule_name |
String |
Itens de verificação Mínimo: 0 Máximo: 2048 |
check_rule_id |
String |
ID do item de verificação Mínimo: 0 Máximo: 64 |
scan_result |
String |
Resultado da detecção. As opções são as seguintes:
Mínimo: 0 Máximo: 64 |
Exemplo de solicitações
Consultar os itens de verificação de um item de configuração de segurança especificado cuja organização é aaa, o nome da imagem é centos7, a versão da imagem é common e o tipo padrão é o padrão da 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
Exemplo de respostas
Código de status: 200
Lista de verificação do item de configuração de segurança especificado
{ "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 amostra do SDK
O código de amostra do SDK é o seguinte.
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) } } |
Mais
Para obter o código de amostra do SDK de mais linguagens de programação, consulte a guia Código de amostra no API Explorer. O código de amostra do SDK pode ser gerado automaticamente.
Códigos de status
Código de status |
Descrição |
---|---|
200 |
Lista de verificação do item de configuração de segurança especificado |
Códigos de erro
Consulte Códigos de erro.