Consulta de la lista de grupos de políticas
Función
Esta API se utiliza para consultar la lista de grupos de políticas.
Método de invocación
Para obtener más información, consulte Invocación a las API.
URI
GET /v5/{project_id}/policy/groups
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID de proyecto 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 |
group_name |
No |
String |
Nombre del grupo de políticas Mínimo: 1 Máximo: 256 |
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: 100000 Valor predeterminado: 0 |
limit |
No |
Integer |
Número de registros mostrados en cada página. Mínimo: 10 Máximo: 200 Valor predeterminado: 10 |
container_mode |
No |
Boolean |
Si se debe consultar la política de edición de contenedor. |
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 |
Número total |
data_list |
Array of PolicyGroupResponseInfo objects |
Lista de grupos de políticas Longitud de matriz: 0 - 100 |
Parámetro |
Tipo |
Descripción |
---|---|---|
group_name |
String |
Nombre del grupo de políticas |
group_id |
String |
ID de grupo de política |
description |
String |
Descripción del grupo de políticas Mínimo: 1 Máximo: 64 |
deletable |
Boolean |
Si se puede eliminar un grupo de políticas |
host_num |
Integer |
Cantidad de servidores asociados |
default_group |
Boolean |
Si un grupo de políticas es el predeterminado |
support_os |
String |
Sistema operativo compatible. Las opciones son las siguientes:
|
support_version |
String |
Versiones compatibles. Las opciones son las siguientes:
|
Solicitudes de ejemplo
Consultar la lista de grupos de políticas de todos los proyectos empresariales.
GET https://{endpoint}/v5/{project_id}/policy/groups?offset=0&limit=100&enterprise_project_id=all_granted_eps
Ejemplo de respuestas
Código de estado: 200
Lista de grupos de políticas
{ "data_list" : [ { "default_group" : true, "deletable" : false, "description" : "container policy group for linux", "group_id" : "c831f177-226d-4b91-be0f-bcf98d04ef5d", "group_name" : "tenant_linux_container_default_policy_group ", "host_num" : 0, "support_version" : "hss.version.container.enterprise", "support_os" : "Linux" }, { "default_group" : true, "deletable" : false, "description" : "enterprise policy group for windows", "group_id" : "1ff54b90-1b3e-42a9-a1da-9883a83385ce", "group_name" : "tenant_windows_enterprise_default_policy_group ", "host_num" : 0, "support_version" : "hss.version.enterprise", "support_os" : "Windows" }, { "default_group" : true, "deletable" : false, "description" : "enterprise policy group for linux", "group_id" : "1069bcc0-c806-4ccd-a35d-f1f7456805e9", "group_name" : "tenant_linux_enterprise_default_policy_group ", "host_num" : 1, "support_version" : "hss.version.enterprise", "support_os" : "Linux" }, { "default_group" : true, "deletable" : false, "description" : "premium policy group for windows", "group_id" : "11216d24-9e91-4a05-9212-c4c1d646ee79", "group_name" : "tenant_windows_premium_default_policy_group ", "host_num" : 0, "support_version" : "hss.version.premium", "support_os" : "Linux" }, { "default_group" : true, "deletable" : false, "description" : "premium policy group for linux", "group_id" : "e6e1228a-7bb4-424f-a42b-755162234da7", "group_name" : "tenant_linux_premium_default_policy_group ", "host_num" : 0, "support_version" : "hss.version.premium", "support_os" : "Windows" } ], "total_num" : 5 }
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 ListPolicyGroupSolution { 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(); ListPolicyGroupRequest request = new ListPolicyGroupRequest(); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withGroupName("<group_name>"); request.withOffset(<offset>); request.withLimit(<limit>); request.withContainerMode(<container_mode>); try { ListPolicyGroupResponse response = client.listPolicyGroup(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 = ListPolicyGroupRequest() request.enterprise_project_id = "<enterprise_project_id>" request.group_name = "<group_name>" request.offset = <offset> request.limit = <limit> request.container_mode = <ContainerMode> response = client.list_policy_group(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 |
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.ListPolicyGroupRequest{} enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest groupNameRequest:= "<group_name>" request.GroupName = &groupNameRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest containerModeRequest:= <container_mode> request.ContainerMode = &containerModeRequest response, err := client.ListPolicyGroup(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 grupos de políticas |
Códigos de error
Consulte Códigos de error.