Queries Kubernetes asset information.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
yundun-sas:ListKspmInstances |
get |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
No |
The ID of the region where the instance resides. |
cn-hangzhou |
| Criteria |
string |
No |
The search conditions for assets. This parameter is in JSON format. Pay attention to letter case when you specify this parameter. The following fields are included:
Note
You can search by region, instance name, instance ID, alert status, risk status, or tag. |
[{"name":"vulStatus","value":"YES","logicalExp":"AND"}] |
| LogicalExp |
string |
No |
The logical relationship between multiple search conditions. Valid values:
|
OR |
| PageSize |
integer |
No |
The maximum number of entries per page in a paged query. Default value: 20. |
20 |
| CurrentPage |
integer |
No |
The page number of the page to return in the query results. Default value: 1, which indicates that the results are returned starting from page 1. |
1 |
| CloudAssetTypes |
array<object> |
No |
The list of asset type information for Kubernetes assets. |
|
|
object |
No |
The asset type information for a Kubernetes asset. |
||
| AssetType |
integer |
No |
The type of the asset. Valid values:
|
0 |
| AssetSubType |
integer |
No |
The subtype of the asset. The value is in the format of asset type - subtype. Valid values:
|
0 |
| Vendor |
integer |
No |
The asset vendor. This parameter is fixed to 200. |
200 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| Success |
boolean |
Indicates whether the API call is successful. Valid values:
|
true |
| RequestId |
string |
The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues. |
7532B7EE-7CE7-5F4D-BF04-B12447DDCAE1 |
| PageInfo |
object |
The paging information for a paged query. |
|
| CurrentPage |
integer |
The page number of the current page in a paged query. |
1 |
| PageSize |
integer |
The maximum number of entries per page in a paged query. |
20 |
| TotalCount |
integer |
The total number of entries returned. |
55 |
| Count |
integer |
The number of entries on the current page. |
4 |
| Instances |
array<object> |
The list of Kubernetes asset information. |
|
|
object |
The Kubernetes asset information. |
||
| RegionId |
string |
The ID of the region where the asset resides. |
cn-hanghzou |
| Vendor |
integer |
The asset vendor. This parameter is fixed to 200. |
200 |
| AssetType |
integer |
The type of the asset. |
1 |
| AssetSubType |
string |
The subtype of the asset. |
1 |
| InstanceId |
string |
The instance ID. |
rm-uf6t6u05n6g48**** |
| InstanceName |
string |
The instance name. |
yztest-l*** |
| CreatedTime |
integer |
The timestamp when the instance was created. Unit: milliseconds. |
1607365213000 |
| InternetIp |
string |
The public IP address of the instance. |
1.2.XX.XX |
| AlarmStatus |
string |
Indicates whether security alerts exist for the asset. Valid values:
|
NO |
| RiskStatus |
string |
Indicates whether security risks exist for the asset. Valid values:
|
NO |
| AssetTypeName |
string |
The name of the asset type. |
Workload |
| AssetSubTypeName |
string |
The name of the asset subtype. |
Pod |
| SecurityInfo |
string |
The security information of the asset. |
{\"seriousNum\":0,\"appNum\":0,\"baselineMedium\":0,\"remindNum\":0,\"imageVulNntf\":0,\"cveNum\":0,\"vul\":0,\"uuid\":\"rm-uf6t6u05n6g485o70\",\"emgNum\":0,\"weakPWNum\":0,\"imageMaliciousFileRemind\":0,\"imageBaselineMedium\":0,\"laterVulCount\":0,\"cmsNum\":0,\"imageMaliciousFileSerious\":0,\"agentlessMalicious\":0,\"suspNum\":0,\"imageBaselineHigh\":0,\"asapVulCount\":0,\"imageVulLater\":0,\"agentlessAll\":0,\"sysNum\":0,\"containerLater\":0,\"containerSuspicious\":0,\"imageBaselineNum\":0,\"newSuspicious\":0,\"nntfVulCount\":0,\"scaNum\":0,\"containerNntf\":0,\"health\":0,\"trojan\":0,\"suspicious\":0,\"imageMaliciousFileSuspicious\":0,\"containerRemind\":0,\"baselineLow\":0,\"imageVulAsap\":0,\"imageBaselineLow\":0,\"containerAsap\":0,\"agentlessBaseline\":0,\"agentlessVulSca\":0,\"agentlessVulCve\":0,\"containerSerious\":0,\"baselineHigh\":0,\"account\":0,\"baselineNum\":6} |
| Tags |
array |
The list of resource tags. |
|
|
string |
The resource tag. |
AI |
Examples
Success response
JSON format
{
"Success": true,
"RequestId": "7532B7EE-7CE7-5F4D-BF04-B12447DDCAE1",
"PageInfo": {
"CurrentPage": 1,
"PageSize": 20,
"TotalCount": 55,
"Count": 4
},
"Instances": [
{
"RegionId": "cn-hanghzou",
"Vendor": 200,
"AssetType": 1,
"AssetSubType": "1",
"InstanceId": "rm-uf6t6u05n6g48****",
"InstanceName": "yztest-l***",
"CreatedTime": 1607365213000,
"InternetIp": "1.2.XX.XX",
"AlarmStatus": "NO",
"RiskStatus": "NO",
"AssetTypeName": "Workload",
"AssetSubTypeName": "Pod",
"SecurityInfo": "{\\\"seriousNum\\\":0,\\\"appNum\\\":0,\\\"baselineMedium\\\":0,\\\"remindNum\\\":0,\\\"imageVulNntf\\\":0,\\\"cveNum\\\":0,\\\"vul\\\":0,\\\"uuid\\\":\\\"rm-uf6t6u05n6g485o70\\\",\\\"emgNum\\\":0,\\\"weakPWNum\\\":0,\\\"imageMaliciousFileRemind\\\":0,\\\"imageBaselineMedium\\\":0,\\\"laterVulCount\\\":0,\\\"cmsNum\\\":0,\\\"imageMaliciousFileSerious\\\":0,\\\"agentlessMalicious\\\":0,\\\"suspNum\\\":0,\\\"imageBaselineHigh\\\":0,\\\"asapVulCount\\\":0,\\\"imageVulLater\\\":0,\\\"agentlessAll\\\":0,\\\"sysNum\\\":0,\\\"containerLater\\\":0,\\\"containerSuspicious\\\":0,\\\"imageBaselineNum\\\":0,\\\"newSuspicious\\\":0,\\\"nntfVulCount\\\":0,\\\"scaNum\\\":0,\\\"containerNntf\\\":0,\\\"health\\\":0,\\\"trojan\\\":0,\\\"suspicious\\\":0,\\\"imageMaliciousFileSuspicious\\\":0,\\\"containerRemind\\\":0,\\\"baselineLow\\\":0,\\\"imageVulAsap\\\":0,\\\"imageBaselineLow\\\":0,\\\"containerAsap\\\":0,\\\"agentlessBaseline\\\":0,\\\"agentlessVulSca\\\":0,\\\"agentlessVulCve\\\":0,\\\"containerSerious\\\":0,\\\"baselineHigh\\\":0,\\\"account\\\":0,\\\"baselineNum\\\":6}",
"Tags": [
"AI"
]
}
]
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | AccountIdNotExist | AccountId not exist | |
| 400 | NoPermission | no permission | |
| 500 | ServerError | ServerError | |
| 403 | NoPermission | caller has no permission |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.