通過設定搜尋條件查詢合格資產資訊,例如通過資產執行個體名稱、資產執行個體所屬地區等條件搜尋指定資產。目前提供分頁和NextToken兩種方式,推薦NextToken方式。
介面說明
您可以通過資產的執行個體 ID、執行個體名稱、所屬 VPC ID、地區、公網 IP 位址等條件搜尋資產,還可以通過設定不同搜尋條件之間的邏輯關係搜尋符合多個搜尋條件的資產。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
yundun-sas:DescribeCloudCenterInstances |
get |
*Asset
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
RegionId
deprecated
|
string |
否 |
要查詢的執行個體所在地區的 ID。 |
cn-hangzhou |
| Criteria |
string |
否 |
設定搜尋資產的條件。該參數 JSON 格式,輸入參數時注意大小寫。 說明
支援使用資產的執行個體 ID、執行個體名稱、所屬 VPC ID、地區、公網 IP 位址等條件搜尋資產。您可以調用 DescribeCriteria 介面查詢支援的搜尋條件。 |
[{"name":"riskStatus","value":"YES"},{"name":"internetIp","value":"1.2.XX.XX"}] |
| MachineTypes |
string |
否 |
要查詢的資產的類型。取值:
|
ecs |
| LogicalExp |
string |
否 |
設定多個搜尋條件間生效的邏輯關係。預設 OR,取值:
|
OR |
| PageSize |
integer |
否 |
設定分頁查詢時,每頁顯示的資產的數量。預設值為 20,表示每頁顯示 20 條資產資訊。 |
100 |
| CurrentPage |
integer |
否 |
設定從返回結果的第幾頁開始顯示查詢結果。預設值為 1,表示從第 1 頁開始顯示。 |
1 |
| Importance |
integer |
否 |
設定資產重要性。取值:
|
2 |
| NoGroupTrace |
boolean |
否 |
預設分組未分組是否要做國際化處理。預設 false,取值:
|
false |
| Lang |
string |
否 |
佈建要求和接收訊息的語言類型,預設為 zh。取值:
|
zh |
| UseNextToken |
boolean |
否 |
是否使用 NextToken 方式拉取資產列表資料。如果使用此參數 TotalCount 不再返回。取值:
|
false |
| NextToken |
string |
否 |
使用 NextToken 方式下返回的 NextToken 值。第一次拉取傳空。 |
E17B501887A2D3AA5E8360A6EFA3B*** |
| ResourceDirectoryAccountId |
integer |
否 |
資來源目錄成員帳號主帳號 ID。 說明
調用 DescribeMonitorAccounts 介面可以擷取該參數。 |
1232428423234**** |
| Flags |
string |
否 |
資產廠商。多個資產廠商之間使用半形逗號(,)分隔。取值:
|
1,2,3 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| Success |
boolean |
介面調用的結果狀態。取值:
|
true |
| RequestId |
string |
本次調用請求的 ID,是由阿里雲為該請求產生的唯一識別碼,可用於排查和定位問題。 |
32A73759-4C0F-4801-BE98-901223ACEE9A |
| PageInfo |
object |
頁面顯示資訊。 |
|
| CurrentPage |
integer |
分頁查詢時,當前頁的頁碼。 |
1 |
| PageSize |
integer |
分頁查詢時,每頁顯示的資產的數量。預設值為 20,表示每頁顯示 20 條資產資訊。 |
20 |
| TotalCount |
integer |
查詢到的資產的總數量。 |
50 |
| Count |
integer |
當前頁顯示的資產的條數。 |
10 |
| NextToken |
string |
使用 NextToken 方式下返回的 NextToken 值。 |
B604532DEF982B875E8360A6EFA3B*** |
| Instances |
array<object> |
資產詳細資料列表。 |
|
|
object |
資產詳細資料。 |
||
| Status |
string |
執行個體的運行狀態。取值:
|
Running |
| CpuInfo |
string |
資產的 CPU 資訊。 |
Intel(R) Xeon(R) Platinum 8269CY CPU @ 2.50GHz |
| InternetIp |
string |
執行個體的公網 IP 位址。 |
1.2.XX.XX |
| Kernel |
string |
核心版本資訊。 |
3.10.0-1127.19.1.el7.x86_64 |
| Bind |
boolean |
資產是否已綁定授權。取值:
|
true |
| OsName |
string |
執行個體的核心版本。 |
- |
| Tag |
string |
資產執行個體的標籤名稱。 |
InternetIp,test |
| ClientStatus |
string |
執行個體的用戶端線上狀態。取值:
|
online |
| Mem |
integer |
記憶體(MB)。 |
1024 |
| VpcInstanceId |
string |
執行個體所屬 VPC 的 ID。 |
vpc-uf60agqq65bs98zoo**** |
| TagId |
string |
資產的標籤 ID。 |
121313,41412 |
| Flag |
integer |
執行個體是否為阿里雲資產。取值:
|
0 |
| LastLoginTimestamp |
integer |
用戶端最後上線的時間戳記。單位為毫秒。 |
1637592907000 |
| AuthVersion |
integer |
資產的授權版本。取值:
|
1 |
| Region |
string |
執行個體所屬地區 ID。 |
cn-hangzhou-cm***-*** |
| InstanceName |
string |
執行個體名稱。 |
yztest-l*** |
| PodCount |
integer |
容器組個數。 |
1 |
| VulCount |
integer |
執行個體上存在的漏洞數量。 |
2 |
| HcStatus |
string |
執行個體是否檢測出了基準風險項。取值:
|
YES |
| CreatedTime |
integer |
叢集建立的時間戳記,單位為毫秒。 |
1607365213000 |
| GroupTrace |
string |
資產所在的分組的名稱。 |
default |
| ClusterId |
string |
叢集 ID。 |
c690a0789419f4284a4e0a29e12fe**** |
| RiskStatus |
string |
資產是否存在安全風險。取值:
|
NO |
| Cores |
integer |
資產的 CPU 核心數。 |
4 |
| VulStatus |
string |
執行個體是否存在漏洞。取值:
|
YES |
| AlarmStatus |
string |
資產是否存在安全警示。取值:
|
NO |
| MacListString |
string |
系統的 Mac 地址。 |
00:13:3e:31:13:39,02:12:67:b8:**:** |
| Importance |
integer |
資產的重要性。取值:
|
2 |
| HealthCheckCount |
integer |
執行個體中存在的基準風險數量。 |
1 |
| Ip |
string |
執行個體的公網 IP 位址。 |
1.2.XX.XX |
| Os |
string |
執行個體的作業系統。 |
Linux |
| AuthModifyTime |
integer |
資產的授權綁定時間戳記。單位:毫秒。 |
1627974044000 |
| SafeEventCount |
integer |
資產存在的安全警示數量。 |
5 |
| InstanceId |
string |
執行個體 ID。 |
i-m5*** |
| AssetType |
string |
資產的類型。取值:
|
0 |
| IntranetIp |
string |
執行個體的私網 IP 位址。 |
1.2.XX.XX |
| Vendor |
integer |
資產廠商。取值:
|
0 |
| RegionId |
string |
資產所在的地區的 ID。 |
cn-hanghzou |
| Uuid |
string |
執行個體的 UUID。 |
c9107c04-942f-40c1-981a-f1c1*** |
| GroupId |
integer |
執行個體所屬分組 ID。 |
4120080 |
| RegionName |
string |
資產的地區名稱。 |
China (Hangzhou) |
| VendorName |
string |
資產的服務商名稱。 取值:
|
IDC |
| AuthVersionName |
string |
資產的授權版本(具體名稱)。取值:
|
Ultimate Edition |
| ClusterName |
string |
叢集名稱。 |
cluster1 |
| ExposedStatus |
integer |
資產暴露狀態。取值:
|
0 |
| RiskCount |
string |
資產存在的風險項統計。JSON 格式,包含以下欄位:
|
{ "account": 0, "appNum": 0, "asapVulCount": 0, "baselineHigh": 0, "baselineLow": 0, "baselineMedium": 0, "baselineNum": 0, "cmsNum": 0, "containerAsap": 0, "containerLater": 0, "containerNntf": 0, "containerRemind": 0, "containerSerious": 0, "containerSuspicious": 0, "cveNum": 0, "emgNum": 0, "health": 0, "imageBaselineHigh": 0, "imageBaselineLow": 0, "imageBaselineMedium": 0, "imageBaselineNum": 0, "imageMaliciousFileRemind": 0, "imageMaliciousFileSerious": 0, "imageMaliciousFileSuspicious": 0, "imageVulAsap": 0, "imageVulLater": 0, "imageVulNntf": 0, "laterVulCount": 0, "newSuspicious": 0, "nntfVulCount": 0, "remindNum": 0, "scaNum": 0, "seriousNum": 0, "suspNum": 0, "suspicious": 0, "sysNum": 0, "trojan": 0, "uuid": "inet-37316411-37fe-4b72-b245-346a2721****", "vul": 0, "weakPWNum": 0 } |
| IpListString |
string |
系統的 IP 列表。 |
172.31.XX.XX,172.171.XX.XX |
| AssetTypeName |
string |
資產的類型名稱。 |
Elastic Compute Service |
| FlagName |
string |
資產廠商。取值:
|
ASK |
| AppId |
string |
應用 ID。 說明
該資料僅當 Vendor 為 9 時可存在。 |
test |
| AppName |
string |
應用程式名稱。 說明
該資料僅當 Vendor 為 9 時可存在。 |
testAppName |
| ClientSubStatus |
string |
執行個體的用戶端子狀態。取值:
|
online |
| TagResources |
string |
靈駿節點自訂標籤,當機器是靈駿機器時才會傳回值。 |
app:test,type:lingjun |
| PostPaidFlag |
integer |
當前資產綁定的防護版本計費方式。取值:
|
0 |
| HasContainer |
string |
是否含有容器。取值:
|
YES |
| ServiceId |
string |
服務 ID,僅執行個體為 Serverless 執行個體,且歸屬於 PAI 平台時有值。 |
dsw-76jlywunsif09bp15p |
| VendorUid |
string |
多雲執行個體的帳號 ID。 |
123 |
| VendorUserName |
string |
多雲執行個體的帳號名稱。 |
VendorUserName |
| Namespace |
string |
命名空間。 |
crm-test |
| BindFileProtectType |
string |
是否綁定防篡改授權。取值:
|
block |
樣本
正常返回樣本
JSON格式
{
"Success": true,
"RequestId": "32A73759-4C0F-4801-BE98-901223ACEE9A",
"PageInfo": {
"CurrentPage": 1,
"PageSize": 20,
"TotalCount": 50,
"Count": 10,
"NextToken": "B604532DEF982B875E8360A6EFA3B***"
},
"Instances": [
{
"Status": "Running",
"CpuInfo": "Intel(R) Xeon(R) Platinum 8269CY CPU @ 2.50GHz",
"InternetIp": "1.2.XX.XX",
"Kernel": "3.10.0-1127.19.1.el7.x86_64",
"Bind": true,
"OsName": "-",
"Tag": "InternetIp,test",
"ClientStatus": "online",
"Mem": 1024,
"VpcInstanceId": "vpc-uf60agqq65bs98zoo****",
"TagId": "121313,41412",
"Flag": 0,
"LastLoginTimestamp": 1637592907000,
"AuthVersion": 1,
"Region": "cn-hangzhou-cm***-***",
"InstanceName": "yztest-l***",
"PodCount": 1,
"VulCount": 2,
"HcStatus": "YES",
"CreatedTime": 1607365213000,
"GroupTrace": "default",
"ClusterId": "c690a0789419f4284a4e0a29e12fe****",
"RiskStatus": "NO",
"Cores": 4,
"VulStatus": "YES",
"AlarmStatus": "NO",
"MacListString": "00:13:3e:31:13:39,02:12:67:b8:**:**",
"Importance": 2,
"HealthCheckCount": 1,
"Ip": "1.2.XX.XX",
"Os": "Linux",
"AuthModifyTime": 1627974044000,
"SafeEventCount": 5,
"InstanceId": "i-m5***",
"AssetType": "0",
"IntranetIp": "1.2.XX.XX",
"Vendor": 0,
"RegionId": "cn-hanghzou",
"Uuid": "c9107c04-942f-40c1-981a-f1c1***",
"GroupId": 4120080,
"RegionName": "China (Hangzhou)",
"VendorName": "IDC",
"AuthVersionName": "Ultimate Edition",
"ClusterName": "cluster1",
"ExposedStatus": 0,
"RiskCount": "{\n \"account\": 0,\n \"appNum\": 0,\n \"asapVulCount\": 0,\n \"baselineHigh\": 0,\n \"baselineLow\": 0,\n \"baselineMedium\": 0,\n \"baselineNum\": 0,\n \"cmsNum\": 0,\n \"containerAsap\": 0,\n \"containerLater\": 0,\n \"containerNntf\": 0,\n \"containerRemind\": 0,\n \"containerSerious\": 0,\n \"containerSuspicious\": 0,\n \"cveNum\": 0,\n \"emgNum\": 0,\n \"health\": 0,\n \"imageBaselineHigh\": 0,\n \"imageBaselineLow\": 0,\n \"imageBaselineMedium\": 0,\n \"imageBaselineNum\": 0,\n \"imageMaliciousFileRemind\": 0,\n \"imageMaliciousFileSerious\": 0,\n \"imageMaliciousFileSuspicious\": 0,\n \"imageVulAsap\": 0,\n \"imageVulLater\": 0,\n \"imageVulNntf\": 0,\n \"laterVulCount\": 0,\n \"newSuspicious\": 0,\n \"nntfVulCount\": 0,\n \"remindNum\": 0,\n \"scaNum\": 0,\n \"seriousNum\": 0,\n \"suspNum\": 0,\n \"suspicious\": 0,\n \"sysNum\": 0,\n \"trojan\": 0,\n \"uuid\": \"inet-37316411-37fe-4b72-b245-346a2721****\",\n \"vul\": 0,\n \"weakPWNum\": 0\n}",
"IpListString": "172.31.XX.XX,172.171.XX.XX",
"AssetTypeName": "Elastic Compute Service",
"FlagName": "ASK",
"AppId": "test",
"AppName": "testAppName",
"ClientSubStatus": "online",
"TagResources": "app:test,type:lingjun",
"PostPaidFlag": 0,
"HasContainer": "YES",
"ServiceId": "dsw-76jlywunsif09bp15p",
"VendorUid": "123",
"VendorUserName": "VendorUserName",
"Namespace": "crm-test",
"BindFileProtectType": "block"
}
]
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | NoPermission | no permission | 無此服務的存取權限。 |
| 400 | RdCheckNoPermission | Resource directory account verification has no permission. | 資來源目錄帳號校正無許可權。 |
| 500 | ServerError | ServerError | 服務故障,請稍後重試! |
| 500 | RdCheckInnerError | Resource directory account service internal error. | 資來源目錄帳號服務內部錯誤。 |
| 403 | NoPermission | caller has no permission | 當前操作未被授權,請聯絡主帳號在RAM控制台進行授權後再執行操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。