Escaneo de imágenes en el repositorio de imágenes por lotes
Función
Esta API se utiliza para escanear imágenes en el repositorio de imágenes por lotes.
Método de invocación
Para obtener más información, consulte Invocación a las API.
URI
POST /v5/{project_id}/image/batch-scan
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID del proyecto del tenant Mínimo: 1 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. Valor predeterminado: 0 Mínimo: 1 Máximo: 256 |
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ámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
repo_type |
No |
String |
Tipo de repositorio. Actualmente, los repositorios de imágenes SWR están conectados. Las opciones son las siguientes:
Mínimo: 1 Máximo: 32 |
image_info_list |
No |
Array of BatchScanSwrImageInfo objects |
Especifica la lista de imágenes que se van a escanear. Este parámetro es obligatorio cuando operate_all es false. Longitud de la matriz: 0 - 10241 |
operate_all |
No |
Boolean |
Si este parámetro se establece en true, se pueden utilizar todos los criterios de filtro para la consulta completa. Si image_info_list está vacío, este parámetro es obligatorio. |
namespace |
No |
String |
Nombre de la organización Mínimo: 1 Máximo: 256 |
image_name |
No |
String |
Nombre de imagen Mínimo: 1 Máximo: 256 |
image_version |
No |
String |
Etiqueta de imagen Mínimo: 1 Máximo: 256 |
image_type |
Sí |
String |
Tipo de imagen. Las opciones son las siguientes:
Mínimo: 1 Máximo: 32 |
scan_status |
No |
String |
Estado de escaneo. Las opciones son las siguientes:
Mínimo: 1 Máximo: 32 |
latest_version |
No |
Boolean |
Mostrar solo las versiones de imagen más recientes |
image_size |
No |
Long |
Tamaño de imagen Mínimo: 0 Máximo: 2147483547 Valor predeterminado: 0 |
start_latest_update_time |
No |
Long |
Fecha de inicio de la creación, en ms. Mínimo: 0 Máximo: 2147483547 Valor predeterminado: 0 |
end_latest_update_time |
No |
Long |
Fecha de fin de creación, en ms. Mínimo: 0 Máximo: 2147483547 Valor predeterminado: 0 |
start_latest_scan_time |
No |
Long |
La hora de inicio de la finalización del último análisis, en ms. Mínimo: 0 Máximo: 2147483547 Valor predeterminado: 0 |
end_latest_scan_time |
No |
Long |
La hora de finalización del último análisis, en ms. Mínimo: 0 Máximo: 2147483547 Valor predeterminado: 0 |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
namespace |
No |
String |
Espacio de nombres Mínimo: 1 Máximo: 64 |
image_name |
No |
String |
Nombre de imagen Mínimo: 1 Máximo: 128 |
image_version |
No |
String |
Etiqueta de imagen Mínimo: 1 Máximo: 128 |
instance_id |
No |
String |
ID de instancia de empresa Mínimo: 1 Máximo: 128 |
instance_url |
No |
String |
Descarga de la URL de la imagen de empresa Mínimo: 0 Máximo: 256 |
Parámetros de respuesta
Ninguna
Solicitudes de ejemplo
-
Escanear imágenes privadas por lotes. El cuerpo de la solicitud transfiere la lista de imágenes y operate_all no contiene ningún parámetro, lo que indica que la lista de imágenes debe escanearse por lotes.
POST https://{endpoint}/v5/{project_id}/image/batch-scan { "image_type" : "private_image", "image_info_list" : [ { "image_name" : "openjdk", "image_version" : "v8.8", "namespace" : "test" }, { "image_name" : "openjdk1", "image_version" : "v1.0", "namespace" : "test1" } ] }
-
Realizar un escaneo completo de imágenes privadas. El cuerpo de la solicitud no transfiere la lista de imágenes y operate_all se establece en true, lo que indica que la lista de imágenes necesita ser escaneada por completo.
POST https://{endpoint}/v5/{project_id}/image/batch-scan { "image_type" : "private_image", "operate_all" : true }
Ejemplo de respuestas
Ninguna
Código de ejemplo del SDK
El código de ejemplo del SDK es el siguiente.
Java
-
Escanear imágenes privadas por lotes. El cuerpo de la solicitud transfiere la lista de imágenes y operate_all no contiene ningún parámetro, lo que indica que la lista de imágenes debe escanearse por lotes.
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 58 59 60 61 62 63 64 65
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.*; import java.util.List; import java.util.ArrayList; public class BatchScanSwrImageSolution { 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(); BatchScanSwrImageRequest request = new BatchScanSwrImageRequest(); request.withEnterpriseProjectId("<enterprise_project_id>"); BatchScanPrivateImageRequestInfo body = new BatchScanPrivateImageRequestInfo(); List<BatchScanSwrImageInfo> listbodyImageInfoList = new ArrayList<>(); listbodyImageInfoList.add( new BatchScanSwrImageInfo() .withNamespace("test") .withImageName("openjdk") .withImageVersion("v8.8") ); listbodyImageInfoList.add( new BatchScanSwrImageInfo() .withNamespace("test1") .withImageName("openjdk1") .withImageVersion("v1.0") ); body.withImageType("private_image"); body.withImageInfoList(listbodyImageInfoList); request.withBody(body); try { BatchScanSwrImageResponse response = client.batchScanSwrImage(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()); } } }
-
Perform a full scan for private images. The request body does not transfer the image list and operate_all is set to true, indicating that the image list needs to be fully scanned.
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 BatchScanSwrImageSolution { 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(); BatchScanSwrImageRequest request = new BatchScanSwrImageRequest(); request.withEnterpriseProjectId("<enterprise_project_id>"); BatchScanPrivateImageRequestInfo body = new BatchScanPrivateImageRequestInfo(); body.withImageType("private_image"); body.withOperateAll(true); request.withBody(body); try { BatchScanSwrImageResponse response = client.batchScanSwrImage(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
-
Scan private images in batches. The request body transfers the image list and operate_all does not contain any parameter, indicating that the image list needs to be scanned in batches.
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
# 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 = BatchScanSwrImageRequest() request.enterprise_project_id = "<enterprise_project_id>" listImageInfoListbody = [ BatchScanSwrImageInfo( namespace="test", image_name="openjdk", image_version="v8.8" ), BatchScanSwrImageInfo( namespace="test1", image_name="openjdk1", image_version="v1.0" ) ] request.body = BatchScanPrivateImageRequestInfo( image_type="private_image", image_info_list=listImageInfoListbody ) response = client.batch_scan_swr_image(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg)
-
Perform a full scan for private images. The request body does not transfer the image list and operate_all is set to true, indicating that the image list needs to be fully scanned.
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 = BatchScanSwrImageRequest() request.enterprise_project_id = "<enterprise_project_id>" request.body = BatchScanPrivateImageRequestInfo( image_type="private_image", operate_all=True ) response = client.batch_scan_swr_image(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
-
Escanear imágenes privadas por lotes. El cuerpo de la solicitud transfiere la lista de imágenes y operate_all no contiene ningún parámetro, lo que indica que la lista de imágenes debe escanearse por lotes.
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 58 59
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.BatchScanSwrImageRequest{} enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest namespaceImageInfoList:= "test" imageNameImageInfoList:= "openjdk" imageVersionImageInfoList:= "v8.8" namespaceImageInfoList1:= "test1" imageNameImageInfoList1:= "openjdk1" imageVersionImageInfoList1:= "v1.0" var listImageInfoListbody = []model.BatchScanSwrImageInfo{ { Namespace: &namespaceImageInfoList, ImageName: &imageNameImageInfoList, ImageVersion: &imageVersionImageInfoList, }, { Namespace: &namespaceImageInfoList1, ImageName: &imageNameImageInfoList1, ImageVersion: &imageVersionImageInfoList1, }, } request.Body = &model.BatchScanPrivateImageRequestInfo{ ImageType: "private_image", ImageInfoList: &listImageInfoListbody, } response, err := client.BatchScanSwrImage(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } }
-
Perform a full scan for private images. The request body does not transfer the image list and operate_all is set to true, indicating that the image list needs to be fully scanned.
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
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.BatchScanSwrImageRequest{} enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest operateAllBatchScanPrivateImageRequestInfo:= true request.Body = &model.BatchScanPrivateImageRequestInfo{ ImageType: "private_image", OperateAll: &operateAllBatchScanPrivateImageRequestInfo, } response, err := client.BatchScanSwrImage(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 |
Respuesta exitosa |
Códigos de error
Consulte Códigos de error.