承認が必要
指定されたデプロイのすべてのリソースに関する一覧を取得します。
リクエスト
HTTP リクエスト
GET https://www.googleapis.com/deploymentmanager/v2/projects/project/global/deployments/deployment/resources
パラメータ
パラメータ名 | 値 | 説明 |
---|---|---|
パスパラメータ | ||
deployment |
string |
このリクエストのデプロイ名。 |
project |
string |
このリクエストのプロジェクト ID。 |
省略可能なクエリ パラメータ | ||
filter |
string |
Sets a filter expression for filtering listed resources, in the form
filter={expression} . Your {expression} must
be in the format: field_name comparison_string literal_string .
field_name は比較するフィールドの名前です。
アトミックなフィールドの型(文字列、数値、ブール値)のみ使用できます。comparison_string は eq (等しい)または ne (等しくない)のいずれかを指定してください。literal_string は絞り込む文字列値です。リテラル値は、フィールドの型(文字列、数値、ブール値)に対して有効である必要があります。文字列フィールドの場合、リテラル値は RE2 構文を使用した正規表現として解釈されます。リテラル値はフィールド全体と一致する必要があります。
たとえば、フィルタリングを使用して、 example-instance という名前を含まないインスタンスを得るには、filter=name ne example-instance を使用します。
ネストされたフィールドをフィルタリングできます。たとえば、 scheduling.automaticRestart フィールドを true に設定したインスタンス上でフィルタリングできます。ネストされたフィールドに対してフィルタリングを使用すると、ラベルを利用して結果を整理したり検索したりできます。
複数の式をフィルタリングするには、各式を括弧で囲みます。たとえば、 (scheduling.automaticRestart eq true) (zone eq us-central1-f) のようになります。
複数の式は AND 式として扱われます。つまり、すべての式に一致するリソースだけがフィルタを通過します。
|
maxResults |
unsigned integer |
1 ページあたりに返される結果の最大数。
結果の総数が maxResults を超える場合、Compute Engine は nextPageToken を返します。以降のリスト リクエストでこれを使用すると、結果の次ページを取得できます。
指定できる値は 0 ~500 です(デフォルト: 500 )。
|
orderBy |
string |
リスト結果を特定の順番で並べ替えます。デフォルトでは、リソース名に基づいてアルファベット順に並べ替えられた結果が返されます。
orderBy="creationTimestamp desc" を使用すれば、作成日時に基づいて結果を降順に並べ替えることもできます。この場合、結果は creationTimestamp フィールドに基づいて時間の逆順(最新の結果が最初)に並べ替えられます。これを使用してオペレーションなどのリソースを並べ替えて、最新のオペレーションが最初に返されるようにできます。
現在は、 name または creationTimestamp desc による並べ替えのみ使用できます。
|
pageToken |
string |
使用するページトークンを指定します。結果の次ページを取得するには、pageToken の値に、直前のリスト リクエストで返された nextPageToken を設定します。
|
承認
このリクエストには、次の 1 つ以上のスコープの承認が必要です(認証と承認についてはこちらをご覧ください)。
スコープ |
---|
https://www.googleapis.com/auth/ndev.cloudman.readonly |
https://www.googleapis.com/auth/cloud-platform |
https://www.googleapis.com/auth/ndev.cloudman |
https://www.googleapis.com/auth/cloud-platform.read-only |
リクエストの本文
このメソッドにはリクエストの本文を指定しないでください。
レスポンス
成功すると、このメソッドによって次の構造を含むレスポンスの本文が返されます。
{ "resources": [ resources Resource ], "nextPageToken": string }
プロパティ名 | 値 | 説明 | メモ |
---|---|---|---|
resources[] |
list |
このリストのレスポンスに含まれるリソース。 | |
nextPageToken |
string |
長すぎるため切り捨てられたリスト リクエストを続けて取得するために使用されるトークン。 |