产品概述
Domain name for API request: csip.intl.tencentcloudapi.com.
This API is used to list cluster pods.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeClusterPodAssets. |
| Version | Yes | String | Common Params. The value used for this API: 2022-11-21. |
| Region | No | String | Common Params. This parameter is not required. |
| MemberId.N | No | Array of String | Member id |
| Filter | No | Filter | Filter conditions |
| Parameter Name | Type | Description |
|---|---|---|
| Data | Array of AssetClusterPod | Data list |
| TotalCount | Integer | Total number of results |
| PodStatusList | Array of FilterDataObject | List of cluster pod status |
| NamespaceList | Array of FilterDataObject | List of namespaces |
| RegionList | Array of FilterDataObject | List of regions |
| AppIdList | Array of FilterDataObject | List of users (AppId) |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to obtain the cluster pod list.
POST / HTTP/1.1
Host: csip.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusterPodAssets
<common request parameters>
{
"MemberId": [
"mem-68b8087a65268000"
],
"Filter": {
"Limit": 1,
"Offset": 0
}
}{
"Response": {
"AppIdList": [
{
"Text": "1302396211",
"Value": "1302396211"
}
],
"Data": [
{
"AppId": 1302396211,
"AssetId": "002a244ad33***6b7ec01b91ae63a9",
"AssetName": "kubernetes-proxy-6dd44f7b74-mqf4n",
"ClusterId": "cls-0hdxu91s",
"ClusterName": "yancyw",
"ContainerCount": 1,
"InstanceCreateTime": "2024-08-22 21:45:10",
"IsCore": 2,
"IsNewAsset": 0,
"MachineId": "ins-0hdxu91s",
"MachineName": "my-vm",
"Namespace": "default",
"Nick": "Sound of Oolong",
"PodIp": "10.**.0.**",
"PrivateIp": "10.**.0.**",
"PublicIp": "118.**.**.**",
"Region": "ap-guangzhou",
"ServiceCount": 1,
"Status": "Running",
"Uin": "100014111178"
}
],
"NamespaceList": [
{
"Text": "default",
"Value": "default"
},
{
"Text": "kube-system",
"Value": "kube-system"
},
{
"Text": "tcss",
"Value": "tcss"
}
],
"PodStatusList": [
{
"Text": "running",
"Value": "running"
},
{
"Text": "succeeded",
"Value": "succeeded"
}
],
"RegionList": [
{
"Text": "Guangzhou",
"Value": "ap-guangzhou"
}
],
"RequestId": "077d335a-f2c7-4f20-884a-9700086f3608",
"TotalCount": 27
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
文档反馈