List Trunks#
利用可能なトランクを一覧表示します。
APIエンドポイント#
リージョン | APIエンドポイント |
---|---|
西日本リージョン3の場合 | https://networking.jp-west-3.cloud.global.fujitsu.com |
東日本リージョン3の場合 | https://networking.jp-east-3.cloud.global.fujitsu.com |
HTTPメソッドとURI#
GET
/v2.0/trunks
HTTPステータスコード#
正常時:200
エラー時:401,404
リクエストパラメータの説明#
名前 | In | Type | デフォルト値 /必須指定 |
Description |
---|---|---|---|---|
admin_state_up | query | boolean | 任意 | 結果をトランクの管理状態で絞り込みます。「up(true)」または「down(false)」を指定します。 |
description | query | string | 任意 | 結果をリソースの説明で絞り込みます。 |
id | query | string | 任意 | 結果をリソースのIDで絞り込みます。 |
name | query | string | 任意 | 結果をリソースの名前で絞り込みます。 |
port_id | query | string | 任意 | 結果を親のポート番号で絞り込みます。 |
revision_number | query | integer | 任意 | 結果をリソースの改定番号で絞り込みます。 |
status | query | string | 任意 | 結果をトランクのステータスで絞り込みます。有効値は「ACTIVE」、「DOWN」、「BUILD」、「DEGRADED」と「ERROR」です。 |
tenant_id | query | string | 任意 | 結果をリソースのプロジェクトIDで絞り込みます。 |
project_id | query | string | 任意 | 結果をリソースのプロジェクトIDで絞り込みます。 |
sort_dir | query | string | 任意 | ソートの方向 asc (ascending:昇順)、またはdesc (descending:降順)です。 クエリパラメータに、複数のソートキーとソート方向を指定することができます。 |
sort_key | query | string | 任意 | 結果をトランクの属性で絞り込みます。複数のソートキーとソート方向を指定することができます。有効値は以下のとおりです。 - admin_state_up - id - name - port_id - project_id - status - tenant_id |
tags | query | string | 任意 | 結果をタグで絞り込みます。すべてのタグが一致する場合は、該当のリソースが返却されます。複数のタグをコンマで区切る必要があります。 |
tags-any | query | string | 任意 | 結果をタグで絞り込みます。タグが1つでも一致する場合は、該当のリソースが返却されます。複数のタグをコンマで区切る必要があります。 |
not-tags | query | string | 任意 | 結果をタグで絞り込みます。すべてのタグが一致する場合は、該当のリソースが返却されません。複数のタグをコンマで区切る必要があります。 |
not-tags-any | query | string | 任意 | 結果をタグで絞り込みます。タグが1つでも一致する場合は、該当のリソースが返却されません。複数のタグをコンマで区切る必要があります。 |
レスポンスボディ(正常系)の説明#
名前 | Type | Description |
---|---|---|
admin_state_up | boolean | リソースの管理状態 「up(true)」または「down(false)」が表示されます。 |
created_at | string | リソースの作成日時(UTC ISO8601形式) |
description | string | リソースの説明 |
id | string | リソースのID |
name | string | リソース名 |
port_id | string | 親のポートのID |
revision_number | integer | リソースの改定番号 |
status | string | トランクのステータス 有効値は「ACTIVE」、「DOWN」、「BUILD」、「DEGRADED」と「ERROR」です。 作成時点では「DOWN」が表示されます。接続しているポート(親ポート・サブポート)が正常であれば「ACTIVE」と表示されます。 ※トランクに対してサブポートを削除すると、既に接続されている他のサブポートが正常状態であっても「DOWN」と表示されることがあります。その際は、既に接続されているサブポートのうち1つを一度削除し、再追加してみてください。 |
tenant_id | string | プロジェクトID |
project_id | string | プロジェクトID |
sub_ports | array | トランクと関連付けられているポートのリスト |
updated_at | string | リソースの最終更新日(UTC ISO8601形式) |
レスポンス例#
{ "trunks": [ { "status": "DOWN", "sub_ports": [], "name": "test", "admin_state_up": true, "project_id": "313be01bd0744cea86643c711c57012b", "tenant_id": "313be01bd0744cea86643c711c57012b", "created_at": "2016-10-05T20:11:16Z", "updated_at": "2016-10-05T20:11:16Z", "revision_number": 1, "port_id": "8027c4da-772f-4e43-bfbf-023b4a4e63de", "id": "ee98bdb4-a817-43af-943f-4318bff98f51", "description": "" } ] }