Obtaining All the CA Port Information
GET /caportIntroduction
Obtains CA Port information.
Displays caport_id in ascending order.
Request Examples
This is an example of obtaining only the CA Port ID, Interface Type, and status of an FC CA Port.
$ curl -i -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X GET "https://192.168.1.1:5665/api/v1/caport?type=FC&fields=status,type"
Response Examples
{
"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 to display. Only the information of the specified Parameter name (Response Body Parameter) is extracted and obtained. For details about the specification methods, see Property Filter. |
||||||||||||
| status | Array of strings Status. Specify the status of the resource for which you want information.
Input criteria:
|
||||||||||||
| ce_id | Array of strings CE ID. Specify the ID of the Controller Enclosure for which you want to obtain information. Input criteria:
|
||||||||||||
| caport_id | Array of strings The CA Port ID. Format is as follows: wxyz
Input criteria:
|
||||||||||||
| type | Array of strings The Interface Type of the CA Port. Specify the Interface Type for which you want information.
Input criteria:
|
||||||||||||
| mode | Array of strings Port operating mode. Specify the mode of operation of the Port for which you want information.
Input criteria:
|
||||||||||||
| max_records | integer The maximum number of resources for which you want information. Specify this parameter when you want to limit the number of pieces of information that can be answered. Input criteria
|
||||||||||||
| last_get_id | string The identifier of the resource for which to retrieve further information. If all resources matching the response conditions cannot be answered at once, next_href is returned. The last_get_id is the information given to next_href to obtain further information. |
Responses
If successful, the HTTP status code is 200 (OK) and the response body is returned.
RESPONSE BODY
| total_count | integer The total number of Resources present in the device. If a filter is applied, this is the total number of Resources that meet the criteria. |
||||||||||||||||
| list_count | integer Number of Lists to respond. |
||||||||||||||||
| caport_list | Array of objects The information that can be obtained with GET /caport/caport_id as the number specified for list_count is output. For more information, see "Responses" in Obtaining CA Port Information. |
||||||||||||||||
| next_href | string Link to get more information. This item is returned only when it is not possible to respond all information at once. For example, this item is responded if there are more Resources that match the response condition than the number specified by max_records. |
||||||||||||||||
| sfp_type | string SFP type.
|