指定された検索条件を満たすアセット情報を照会します。例えば、インスタンス名やリージョンでアセットを検索できます。ページベースのページネーションとNextTokenベースのページネーションの2つのページネーション方法がサポートされています。NextTokenベースのページネーションの使用を推奨します。
操作説明
インスタンスID、インスタンス名、VPC ID、リージョン、パブリックIPアドレスなどの条件でアセットを検索できます。また、複数の検索条件間の論理関係を設定して、複数の条件を満たすアセットを検索することもできます。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
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 |
任意 |
ページネーションクエリにおける1ページあたりのエントリ数。デフォルト値:20。1ページあたり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 |
任意 |
リソースディレクトリ内のメンバーアカウントのAlibaba CloudアカウントID。 説明
DescribeMonitorAccounts オペレーションを呼び出して、このパラメーターを取得できます。 |
1232428423234**** |
| Flags |
string |
任意 |
アセットのベンダー。複数のベンダーをカンマ(,)で区切ります。有効な値:
|
1,2,3 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| Success |
boolean |
APIコールが成功したかどうかを示します。有効な値:
|
true |
| RequestId |
string |
リクエストID。Alibaba Cloudがリクエストに対して生成する一意の識別子です。リクエストIDを使用して問題をトラブルシューティングできます。 |
32A73759-4C0F-4801-BE98-901223ACEE9A |
| PageInfo |
object |
ページネーション情報。 |
|
| CurrentPage |
integer |
ページネーションクエリにおける現在のページのページ番号。 |
1 |
| PageSize |
integer |
ページネーションクエリにおける1ページあたりのエントリ数。デフォルト値:20。1ページあたり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 |
インスタンスがAlibaba Cloudアセットかどうかを示します。有効な値:
|
0 |
| LastLoginTimestamp |
integer |
クライアントが最後にオンラインになったタイムスタンプ。単位:ミリ秒。 |
1637592907000 |
| AuthVersion |
integer |
アセットの認可バージョン。有効な値:
|
1 |
| Region |
string |
インスタンスのリージョンID。 |
cn-hangzhou-cm***-*** |
| InstanceName |
string |
インスタンス名。 |
yztest-l*** |
| PodCount |
integer |
Pod 数。 |
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 |
Lingjunノードのカスタムタグ。このパラメーターは、マシンがLingjunマシンの場合にのみ返されます。 |
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 |
例
成功レスポンス
JSONJSON
{
"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 ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 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 |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。