SearchInventory - CloudOps Orchestration Service - Alibaba Cloud ドキュメントセンター

在庫に関する詳細情報または集計情報をクエリします。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

oos:SearchInventory

get

*All Resource

*

oos:TLSVersion

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID。	cn-hangzhou
NextToken	string	任意	次のページの結果を取得するために使用されるトークン。	gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC
MaxResults	integer	任意	ページごとに返すエントリ数。有効な値: 1～100。デフォルト値: 50。	50
Filter	array<object>	任意	コンポーネントのフィルタールール。
	object	任意
Value	array	任意	A list of values for the component property query.	i-bp1cpoxxxxxxxxxxxxxx
	string	任意	A value for the component property query.	i-bp1cpoxxxxxxxxxxxxxx
Operator	string	任意	The comparison operator for the property value. You can specify up to five filters. Valid values: Equal NotEqual BeginWith LessThan GreaterThan	Equal
Name	string	任意	The name of the component property. You can specify up to five filters. Property names vary for different components. Call the GetInventorySchema operation to query the property names of different components. For example, the ACS:InstanceInformation component has the InstanceId property. For this component, set this parameter to ACS:InstanceInformation.InstanceId.	ACS:InstanceInformation.InstanceId
Aggregator	array	任意	アグリゲーター。1 つ以上のアグリゲーターを使用して、インスタンスに関する集計情報をクエリできます。有効な値: ACS:Application.Name ACS:Application.Version。	ACS:Application.Name
	string	任意	The aggregator.	ACS:Application.Name

レスポンスフィールド

フィールド	型	説明	例
	object
NextToken	string	The token that is used to retrieve the next page of results.	gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC
RequestId	string	The request ID.	A81E4B2E-6B33-4BAE-9856-55DB7C893E01
MaxResults	integer	The number of entries returned on each page.	50
Entities	array<object>	The entities.
	object	The detailed inventory or aggregated information about the component.	[ { "ACS:InstanceInformation": { "CaptureTime": "2020-10-13T08:55:06Z", "SchemaVersion": "1.0", "Content": { "PlatformName": "ubuntu", "PlatformVersion": "20.04", "Status": "Running", "InstanceId": "i-bp1cpoxxxxxxxxxxxxxx", "AgentVersion": "v1.5", "ComputerName": "iZbp1cpoxxxw111jcv94drZ", "IpAddress": "192.168.10.245", "AgentName": "oosutil", "PlatformType": "linux" }, "RegionId": "cn-hangzhou" }, "Id": "i-bp1cpoxxxxxxxxxxxxxx" } ]}

例

成功レスポンス

JSONJSON

{
  "NextToken": "gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC",
  "RequestId": "A81E4B2E-6B33-4BAE-9856-55DB7C893E01",
  "MaxResults": 50,
  "Entities": [
    {
      "test": "test",
      "test2": 1
    }
  ]
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。