Consulta de información básica de un servicio de punto de conexión de VPC
Función
Esta API se utiliza para consultar información básica sobre un servicio de punto de conexión de VPC. Puede utilizar esta API para consultar el servicio de punto de conexión de VPC de destino. Esta API también puede ser utilizada por otros usuarios para consultar información básica sobre su servicio punto de conexión de VPC, sin exponer la información de su servidor.
Método de invocación
Para obtener más información, consulte Invocación a las API.
URI
GET /v1/{project_id}/vpc-endpoint-services/describe
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID del proyecto. Mínimo: 1 Máximo: 64 |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
endpoint_service_name |
No |
String |
Especifica el nombre del servicio de punto de conexión de VPC. Nota: Se debe especificar este campo o el campo de id. De lo contrario, se produce un error. Mínimo: 1 Máximo: 128 |
id |
No |
String |
Especifica el ID del servicio de punto de conexión de VPC. El ID es el identificador único del servicio de punto de conexión de VPC. Nota: Se debe especificar este parámetro o endpoint_service_name. Mínimo: 1 Máximo: 64 |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
Especifica el token de usuario. Se puede obtener invocando a la API de IAM. El valor de X-Subject-Token en el encabezado de respuesta es el token de usuario. |
Content-Type |
No |
String |
Especifica el tipo MIME del cuerpo de la solicitud. Se recomienda el valor application/json. Para las API utilizadas para cargar objetos o imágenes, el tipo MIME varía en función del tipo de flujo. Valor predeterminado: application/json |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
Especifica el ID único del servicio de punto de conexión de VPC. Mínimo: 1 Máximo: 64 |
service_name |
String |
Especifica el nombre del servicio de punto de conexión de VPC. |
service_type |
String |
Especifica el tipo del servicio de punto de conexión de VPC. Solo sus servicios privados pueden configurarse en servicios de punto de conexión de VPC de interfaz.
|
created_at |
String |
Especifica cuándo se creó el servicio de punto de conexión de VPC. Se utiliza el formato de hora UTC AAAA-MMDDTHH:MM:SSZ. |
is_charge |
Boolean |
Especifica si se factura el punto de conexión de VPC conectado al servicio de punto de conexión de VPC.
|
public_border_group |
String |
Especifica la información del grupo de borde público sobre el grupo correspondiente al punto de conexión de VPC. |
enable_policy |
Boolean |
Especifica si la política de punto de conexión de VPC está habilitada.
|
Ejemplo de solicitudes
Información básica sobre un servicio de punto de conexión de VPC
GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/describe?id=4189d3c2-8882-4871-a3c2-d380272eed83
Ejemplo de respuestas
Código de estado: 200
El servidor procesó correctamente la solicitud.
{ "id" : "9d4c1028-1336-4556-9881-b5d807c1b8a8", "service_name" : "test123", "service_type" : "interface", "created_at" : "2018-09-17T07:28:31Z", "is_charge" : "true" }
Ejemplo de código del SDK
El ejemplo de código 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 |
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.vpcep.v1.region.VpcepRegion; import com.huaweicloud.sdk.vpcep.v1.*; import com.huaweicloud.sdk.vpcep.v1.model.*; public class ListServiceDescribeDetailsSolution { 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); VpcepClient client = VpcepClient.newBuilder() .withCredential(auth) .withRegion(VpcepRegion.valueOf("cn-north-4")) .build(); ListServiceDescribeDetailsRequest request = new ListServiceDescribeDetailsRequest(); request.withEndpointServiceName("<endpoint_service_name>"); request.withId("<id>"); try { ListServiceDescribeDetailsResponse response = client.listServiceDescribeDetails(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 |
# coding: utf-8 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkvpcep.v1.region.vpcep_region import VpcepRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkvpcep.v1 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 = os.getenv("CLOUD_SDK_AK") sk = os.getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = VpcepClient.new_builder() \ .with_credentials(credentials) \ .with_region(VpcepRegion.value_of("cn-north-4")) \ .build() try: request = ListServiceDescribeDetailsRequest() request.endpoint_service_name = "<endpoint_service_name>" request.id = "<id>" response = client.list_service_describe_details(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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" vpcep "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpcep/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpcep/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpcep/v1/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 := vpcep.NewVpcepClient( vpcep.VpcepClientBuilder(). WithRegion(region.ValueOf("cn-north-4")). WithCredential(auth). Build()) request := &model.ListServiceDescribeDetailsRequest{} endpointServiceNameRequest:= "<endpoint_service_name>" request.EndpointServiceName = &endpointServiceNameRequest idRequest:= "<id>" request.Id = &idRequest response, err := client.ListServiceDescribeDetails(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
Otro más
Para obtener un ejemplo de código del SDK de más lenguajes de programación, consulta la ficha Ejemplo de código en API Explorer. El ejemplo de código del SDK se puede generar automáticamente.
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
El servidor procesó correctamente la solicitud. |
Códigos de error
Consulte Códigos de error.