Querying Container Details
Function
This API is used to query container details.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/kubernetes/container/detail
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project. |
container_id |
Yes |
String |
Container ID |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
service_name |
String |
Service name. |
service_username |
String |
Service subscriber name. |
service_password |
String |
Service password. |
service_port_list |
Array of ServicePortInfo objects |
Container service port information |
enable_simulate |
String |
Data simulation, which is disabled by default. After this function is enabled, simulation data will be injected to the sandbox.
|
hosts |
String |
Sandbox domain name. Use commas (,) to separate domain names. |
extra |
ContainerExtraInfo object |
Additional configuration of a sandbox. It can be specified for the VPN traffic diversion sandbox, Linux sandbox, RDP sandbox, and MySQL sandbox. It is left blank for other sandboxes by default. |
Parameter |
Type |
Description |
---|---|---|
desc |
String |
Service name |
type |
String |
Type. The value can be http or https. |
protocol |
String |
The default value is tcp. The value can be tcp or udp. |
user_port |
Integer |
User Port |
port |
Integer |
Internal port of the container |
Parameter |
Type |
Description |
---|---|---|
openvpn |
ContainerExtraOpenvpnInfo object |
Sandbox type. It can only be specified for the VPN traffic diversion sandbox. |
linux |
ContainerExtraLinuxInfo object |
Sandbox type. It can only be specified for the Linux sandbox. |
rdp |
ContainerExtraRdpInfo object |
Sandbox type. It can only be specified for the RDP sandbox. |
mysql |
ContainerExtraMysqlInfo object |
Sandbox type. It can only be specified for the MySQL and MySQLCHEAT sandboxes. |
Parameter |
Type |
Description |
---|---|---|
outside_ip |
String |
Mapping IP address |
outside_port |
String |
Mapped port |
Parameter |
Type |
Description |
---|---|---|
os |
String |
OS.
|
Parameter |
Type |
Description |
---|---|---|
proto_env |
String |
Protocol type. The value can be:
|
system |
String |
System type, which is used for system simulation.
|
Example Requests
None
Example Responses
Status code: 200
Request succeeded.
{ "container_id" : "19031ec457570cce64f789a57ce6551509c5ac95836c196a1e34e67232da5744", "container_name" : "k8s_POD_hostguard-w4x9h_hss_64732fbe-475c-4f1d-a728-fa4bdd22496f_0", "status" : "Running", "create_time" : 1742184403735, "image_name" : "cce-pause", "image_id" : "sha256:c96088c71666e3aa61a2659a1e6b533d5ea286d8f370f3b2088b102e9c595042", "pod_name" : "", "command\"" : "/pause", "cluster_name" : "" }
SDK Sample Code
The SDK sample code is as follows.
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.hss.v5.region.HssRegion; import com.huaweicloud.sdk.hss.v5.*; import com.huaweicloud.sdk.hss.v5.model.*; public class ShowK8sContainerDetailSolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("<YOUR REGION>")) .build(); ShowK8sContainerDetailRequest request = new ShowK8sContainerDetailRequest(); try { ShowK8sContainerDetailResponse response = client.showK8sContainerDetail(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()); } } } |
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 import os 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 = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowK8sContainerDetailRequest() response = client.show_k8s_container_detail(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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 |
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") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := hss.NewHssClient( hss.HssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowK8sContainerDetailRequest{} response, err := client.ShowK8sContainerDetail(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Request succeeded. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot