Querying Pod Details
Function
Query pod details.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/kubernetes/{pod_name}/pod/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 |
pod_name |
Yes |
String |
Pod name |
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. |
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 |
---|---|---|
pod_name |
String |
Pod name |
namespace_name |
String |
Name |
cluster_name |
String |
Cluster. |
node_name |
String |
Node name |
label |
String |
Label |
cpu |
String |
Used CPU |
memory |
String |
Memory usage |
cpu_limit |
String |
CPU limit |
memory_limit |
String |
Memory Limit |
node_ip |
String |
Node IP address |
pod_ip |
String |
Pod IP |
status |
String |
Pod status. It can be:
|
create_time |
Long |
Created At |
containers |
Array of ContainerBaseInfo objects |
Pod container list. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition ID Range The value can contain 0 to 255 characters. |
region_id |
String |
Definition Region. Range The value can contain 0 to 255 characters. |
container_id |
String |
Definition Container ID. Range The value can contain 0 to 255 characters. |
container_name |
String |
Definition Container name. Range The value can contain 0 to 255 characters. |
image_name |
String |
Definition Image name. Range The value can contain 0 to 255 characters. |
status |
String |
Definition Container status. Range
|
create_time |
Long |
Definition Creation time. Range The value range is 0 to 4,071,095,999,000. |
cpu_limit |
String |
Definition CPU limit. Range The value can contain 0 to 64 characters. |
memory_limit |
String |
Definition Memory limit. Range The value can contain 0 to 64 characters. |
restart_count |
Integer |
Definition Number of restarts. Range The value range is 0 to 20. |
pod_name |
String |
Definition Pod name. Range The value can contain 0 to 64 characters. |
cluster_name |
String |
Definition Cluster. Range The value can contain 0 to 64 characters. |
cluster_id |
String |
Definition Cluster ID. Range The value can contain 0 to 64 characters. |
cluster_type |
String |
Definition Cluster type. Range
|
risky |
Boolean |
Definition Risky or not. Range true (risky) or false (safe) |
low_risk |
Integer |
Definition Number of low risks. Range The value range is 0 to 2,147,483,647. |
medium_risk |
Integer |
Definition Number of medium risks. Range The value range is 0 to 2,147,483,647. |
high_risk |
Integer |
Definition Number of high risks. Range The value range is 0 to 2,147,483,647. |
fatal_risk |
Integer |
Definition Number of critical risks. Range The value range is 0 to 2,147,483,647. |
Example Requests
Query pod details.
GET https://{endpoint}/v5/{project_id}/kubernetes/node-local-dns-admission-controller-678d87b4cc-78qqt/pod/detail?enterprise_project_id=all_granted_eps
Example Responses
Status code: 200
Request succeeded.
{ "pod_name" : "node-local-dns-admission-controller-678d87b4cc-78qqt", "namespace_name" : "kube-system", "node_name" : "192.168.1.18", "label" : "{\"release\":\"cceaddon-node-local-dns\",\"pod-template-hash\":\"678d87b4cc\",\"k8s-app\":\"node-local-dns-admission-controller\"}", "node_ip" : "192.168.1.18", "pod_ip" : "192.168.1.166", "status" : "Running", "create_time" : 1720916013000, "containers" : [ { "id" : "66a9f98c-xxxx-xxxx-xxxx-37f99fbed435", "container_id" : "b9e0fc15f74ccff251736c3e091f57b239b4d1ee25da615e1000e59aef54c98f", "container_name" : "webhook", "image_name" : "hwofficial/local-dns-admission-controller:1.6.8", "status" : "Running", "create_time" : 1720916341000, "restart_count" : 0, "pod_name" : "node-local-dns-admission-controller-678d87b4cc-78qqt", "cluster_name" : "glz-2451", "cluster_id" : "a03efb0c-xxxx-xxxx-xxxx-0255ac100b0b", "region_id" : "cn-north-7" } ], "cluster_name" : "glz-2451" }
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 48 |
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 ShowK8sPodDetailSolution { 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(); ShowK8sPodDetailRequest request = new ShowK8sPodDetailRequest(); request.withPodName("{pod_name}"); try { ShowK8sPodDetailResponse response = client.showK8sPodDetail(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 32 |
# 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 = ShowK8sPodDetailRequest() request.pod_name = "{pod_name}" response = client.show_k8s_pod_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 38 |
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.ShowK8sPodDetailRequest{} request.PodName = "{pod_name}" response, err := client.ShowK8sPodDetail(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