全CA Portの情報の取得
GET /caport概要説明
CA Portの情報を取得します。
caport_idで昇順に表示します。
リクエスト例
FC CA Port のCA Port IDとInterface Type、ステータスのみを取得する場合の例です。
$ curl -i -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X GET "https://192.168.1.1:5665/api/v1/caport?type=FC&fields=status,type"
レスポンス例
{
"total_count": 512,
"list_count": 1,
"caport_list": [
{
"caport_id": "0011",
"caport_href": "/api/v1/caport/0011",
"status": "Normal",
"ce_id": 0,
"cm_number": 0,
"ca_number": 1,
"port_number": 1,
"type": "iSCSI",
"max_speed": 1,
"mode": "CA",
"link_speed": 1,
"sfp_type": "16G_SWL_SFP_Plus",
"is_host_affinity_disabled": false,
"is_used_for_storage_cluster": false,
"mac_address": "01:02:03:04:05:06",
"iscsi_name": "iqn.2000-09.com.fujitsu:storage-system.eternus_dxl:000000",
"iscsi_alias_name": "ALIAS00",
"is_vlan_enable": true,
"ip_address_list": [
{
"ipv4_address": "192.168.1.1",
"vlan_id": 0
},
{
"link_local_ipv6_address": "fe80::290:ccff:fea4:3a49",
"connect_ipv6_address": "2001:db8::8:800:200c:417a",
"vlan_id": 1
}
]
}
]
}
Parameters
QUERY PARAMETERS
| fields | Array of strings 表示したいParameter。 指定したParameter名(Response Body Parameter)の情報のみを抜き出して取得します。 指定方法の詳細は、表示する項目の絞り込みを参照してください。 |
||||||||||||
| status | Array of strings ステータス。 情報を取得したいリソースのステータスを指定します。
入力条件：
|
||||||||||||
| ce_id | Array of strings CE ID。 情報を取得したいController EnclosureのIDを指定します。 入力条件：
|
||||||||||||
| caport_id | Array of strings CA Port ID。 Formatは以下です。 wxyz
入力条件：
|
||||||||||||
| type | Array of strings CA PortのInterface Type。 情報を取得したいInterface Typeを指定します。
入力条件：
|
||||||||||||
| mode | Array of strings Portの動作Mode。 情報を取得したいPortの動作Modeを指定します。
入力条件：
|
||||||||||||
| max_records | integer 情報を取得したいリソースの最大数。 応答する情報数を制限したい場合に指定してください。 入力条件
|
||||||||||||
| last_get_id | string 続きの情報を取得するためのリソースの識別子。 一度に応答条件に合致するすべてのリソースを応答できなかった場合、next_hrefが返却されます。 last_get_idはnext_hrefに付与される、続きの情報を取得するための情報です。 |
Responses
正常に取得できた場合、HTTPステータスコードが200 (OK)となりレスポンスボディを応答します。
RESPONSE BODY
| total_count | integer 装置に存在するResourceの総数。 フィルタリングしている場合は、条件に合致するResourceの総数です。 |
||||||||||||||||
| list_count | integer 応答するListの個数。 |
||||||||||||||||
| caport_list | Array of objects GET /caport/caport_idで取得できる情報を、list_count数分出力します。詳細は、CA Portの情報の取得の「Responses」を参照してください。 |
||||||||||||||||
| next_href | string 続きの情報を取得するためのLink。 一度にすべての情報を応答しきることができなかった場合に限り応答します。 例えば、max_recordsで指定した個数以上に応答条件に合致するResourceが存在する場合などに応答します。 |
||||||||||||||||
| sfp_type | string SFPのType。
|