
# 查询容器详细信息 - ShowK8sContainerDetail
#### 功能介绍
查询容器详细信息。
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-hss2.0/hss_02_0007.html)。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-hss2.0/hss_02_0022.html)。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
 
#### URI
GET /v5/{project_id}/kubernetes/container/detail
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|:---|:---|:---|:---|
| project_id | 是    | String | **参数解释**: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-hss2.0/hss_02_0024.html)。 **约束限制**: 不涉及 **取值范围**: 字符长度1-256位 **默认取值**: 不涉及 |
   
表2Query参数 
| 参数                    | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|:---|:---|:---|:---|
| enterprise_project_id | 否    | String | **参数解释**: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见[获取企业项目ID](https://support.huaweicloud.com/api-hss2.0/hss_02_0027.html)。 如需查询所有企业项目下的资产请传参"all_granted_eps"。 **约束限制**: 开通企业项目功能后才需要配置企业项目ID参数。 **取值范围**: 字符长度1-256位 **默认取值**: 0，表示默认企业项目（default）。 |
| container_id          | 是    | String | 容器ID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
   
#### 请求参数
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释**: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见[获取用户Token](https://support.huaweicloud.com/api-hss2.0/hss_02_0009.html)。 **约束限制**: 不涉及 **取值范围**: 字符长度1-32768位 **默认取值**: 不涉及 |
   
#### 响应参数
**状态码：200**
表4响应Body参数 
| 参数                | 参数类型                                                                                  | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|
| service_name      | String                                                                                | 服务名称                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| service_username  | String                                                                                | 服务用户名                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| service_password  | String                                                                                | 服务密码                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| service_port_list | Array of [ServicePortInfo] objects | 容器各服务端口信息                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| enable_simulate   | String                                                                                | 数据仿真，默认关闭。开启后将在沙箱中注入仿真数据 - open : 开启   - close : 关闭    |
| hosts             | String                                                                                | 沙箱域名，域名之间使用 ',' 隔开                                                                                                                                                                                                                                                                                                                                                                                                                         |
| extra             | [ContainerExtraInfo] object     | 沙箱额外配置，包括VPN引流沙箱、linux沙箱、RDP沙箱、mysql沙箱，其他沙箱默认为空                                                                                                                                                                                                                                                                                                                                                                                            |
   
 表5ServicePortInfo 
| 参数        | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|:---|:---|:---|
| desc      | String  | 服务名称                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| type      | String  | **参数解释**: 类型 **取值范围**: - http：http类端口   - https：https类端口    |
| protocol  | String  | 默认tcp。可取值集合\[tcp，udp\]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| user_port | Integer | 用户端口                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| port      | Integer | 容器内部端口                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
   
 表6ContainerExtraInfo 
| 参数      | 参数类型                                                                                            | 描述                        |
|:---|:---|:---|
| openvpn | [ContainerExtraOpenvpnInfo] object | 沙箱类型，VPN引流沙箱专用            |
| linux   | [ContainerExtraLinuxInfo] object     | 沙箱类型，linux沙箱专用            |
| rdp     | [ContainerExtraRdpInfo] object         | 沙箱类型，RDP沙箱专用              |
| mysql   | [ContainerExtraMysqlInfo] object     | 沙箱类型，MYSQL、MYSQLCHEAT沙箱专用 |
   
 表7ContainerExtraOpenvpnInfo 
| 参数           | 参数类型   | 描述   |
|:---|:---|:---|
| outside_ip   | String | 映射ip |
| outside_port | String | 映射端口 |
   
 表8ContainerExtraLinuxInfo 
| 参数 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|:---|:---|:---|
| os | String | 操作系统: - ubt : ubuntu   - centos : centos   - debian   - redhat   - opensuse   - kylin   - uos   - euleros    |
   
 表9ContainerExtraRdpInfo 
| 参数        | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|
| proto_env | String | 协议类型: - 0 : 协议模拟   - 1 : 系统模拟                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| system    | String | 系统类型，系统模拟时使用: - win7 : win 7   - win8 : win 8   - win10 : win 10   - win-server2012 : win-server 2012   - win-server2016 : win-server 2016    |
   
 表10ContainerExtraMysqlInfo 
| 参数          | 参数类型   | 描述      |
|:---|:---|:---|
| custom_path | String | 自定义反制路径 |
   
#### 请求示例
无
#### 响应示例
**状态码：200**
请求已成功
```
{
  "service_name" : "xxx",
  "service_username" : "xxx",
  "service_password" : "xxx",
  "service_port_list" : [ {
    "desc" : null,
    "type" : "https",
    "protocol" : "tcp",
    "user_port" : 111,
    "port" : 111
  } ],
  "enable_simulate" : "open",
  "hosts" : "xxx",
  "extra" : {
    "openvpn" : {
      "outside_ip" : "xxx",
      "outside_port" : "xxx"
    },
    "linux" : {
      "os" : "centos"
    },
    "rdp" : {
      "proto_env" : "1",
      "system" : "win7"
    },
    "mysql" : {
      "custom_path" : "xxx"
    }
  }
}
```
#### SDK代码示例
SDK代码示例如下。
- [Java]
  ```
  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());
          }
      }
  }
  ```
- [Python]
  ```
  # 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)
  ```
- [Go]
  ```
  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, err := basic.NewCredentialsBuilder().
          WithAk(ak).
          WithSk(sk).
          WithProjectId(projectId).
          SafeBuild()
      if err != nil {
          fmt.Println(err)
          return
      }
      hcClient, err := hss.HssClientBuilder().
           WithRegion(region.ValueOf("<YOUR REGION>")).
           WithCredential(auth).
           SafeBuild()
      if err != nil {
          fmt.Println(err)
          return
      }
      client := hss.NewHssClient(hcClient)
      request := &model.ShowK8sContainerDetailRequest{}
  response, err := client.ShowK8sContainerDetail(request)
  if err == nil {
          fmt.Printf("%+v\n", response)
      } else {
          fmt.Println(err)
      }
  }
  ```
- [更多]
  更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/HSS/sdk?api=ShowK8sContainerDetail&version=v5)的代码示例页签，可生成自动对应的SDK代码示例。
#### 状态码
| 状态码 | 描述    |
|:---|:---|
| 200 | 请求已成功 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-hss2.0/ErrorCode.html)。
