Low resolution monitor

Obtains a list of control port performance information (monitor information). Information about control ports existing at the time of CLI execution is obtained.

Performance information is collected internally at one minute intervals. Because of this, the following problems might occur. In such cases, if you want to obtain the latest information, wait for another cycle, and then call the CLI again.

• Depending on the timing, the same information as the last time might be returned. To verify whether the information is the latest one, compare the timestamp contained in the response data with that obtained last.

• If the storage cluster's time changes drastically, past information might be returned, or information might not be returned because it is not collected yet.

• Immediately after Virtual Storage Software block is started or a control port is added or deleted, performance information might not be returned because it is not collected yet.

• Some information might not be obtained or duplicate information might be collected in one cycle due to high load, including spikes.

If the information could not be obtained, any of the following is returned:

• If the information that could not be obtained is an array element, an array without the element is returned.

• If the information that could not be obtained is an attribute, a null value is returned.

• If no performance information, including the one that satisfies the subcommand-option specification conditions, is found or obtained, an empty data object, "data": [] is returned.

If the number of control ports is large, in order to obtain all the information, it is necessary to obtain it separately in plural times. If some control ports are not obtained, hasNext in the response data shows true, and the token used to obtain the rest of the control ports is output as enumerateContext. You can obtain the next volume by executing this CLI again with enumerateContext specified as the subcommand-option.

Also, by setting a count parameter, you can determine the number of control ports you obtain. If lengthening the obtainment period (start_time/end_time), fewer number of the control ports might return than the value set in the count parameter. If you want to obtain a large number of the control port information at once, set (start_time/end_time) briefly during the obtainment period.

totalCount in the response data is the total number of control ports whose performance records were existing when the CLI was executed. The number might be changed with each CLI operation using enumerateContext. Similarly, as the information that is returned is the update at the time of CLI execution, you might obtain a record of a different timestamp value in a series of CLI operations using enumerateContext.

The following describes data to be output according to the specification of the start_time and end_time subcommand-options:

When both start_time and end_time are omitted

• It is assumed that the time when the REST API server received the request was specified as end_time.

• It is assumed that the time which is one minute earlier than the time when the REST API server received the request was specified as start_time. However, if the end_time is 1970-01-01T00:01:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

When both start_time and end_time are specified

• The monitored information within the specified time period is returned.

• Due to addition or deletion of control ports, or no collection of information, the number of control ports at a certain point of time might be smaller than the number output for count.

When only start_time is specified

• It is assumed that the time when the REST API server received the request was specified as end_time.

When only end_time is specified

• It is assumed that the time which is one hour earlier than end_time was specified as start_time. However, if end_time is 1970-01-01T01:00:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

• Due to addition or deletion of control ports, or no collection of information, the number of control ports at a certain point of time might be smaller than the number output for count.

When the range specified by start_time and end_time is invalid

• An error is returned when any of the following conditions is satisfied:

  • A date and time later than end_time is specified as start_time, including when end_time is not specified.

  • A date and time which is earlier than 1970-01-01T00:00:01Z is specified for start_time or end_time.

  • When all the following conditions are satisfied:

    • Specify true for start_time_excluding, or false for end_time_including.

    • The same date and time is specified for start_time and end_time, including the case when start_time is not specified and 1970-01-01T00:00:01Z is specified for end_time.

hsds [master command option] control_port_performance_list
--start_time <str>  (optional)
--start_time_excluding <boolean>  (optional)
--end_time <str>  (optional)
--end_time_including <boolean>  (optional)
--enumerate_context <str>  (optional)
--count <int>  (optional)

• --start_time <time>

  Specify the start date and time (date-time) of the monitor information to be obtained.

  If you specify start_time_excluding, you can specify whether to include or exclude the specified time. By default, the specified time is included.

• --start_time_excluding {false | true}

  Specify determines whether to include information of the specified --start_time.

  • false (default): The information is included.

  • true: The information is not included.

• --end_time <time>

  Specify the end date and time (date-time) of the monitor information to be obtained.

  If you specify --end_time_including, you can specify whether to include or exclude the specified time. By default, the specified time is excluded. If it is omitted, it is the request receipt time.

• --end_time_including {false | true}

  Specify whether to include the specified --end_time.

  • false (default): The specified time is not included.

  • true: The specified time is included.

• --enumerate_context <token>

  Specify token (uuid) that helps obtain the next batch records. Do not specify this parameter for initial information extraction.

• --count <count>

  Specify the number (0 to 32,768, default: "0") of control port records to be obtained.

  If nothing is specified or 0 is specified, all records are output.

• Normal termination

  Description A list of control port performance information (monitor information) at the specified time and the information about performanceObjects. Properties data: object[] A list of control port performance information (monitor information) at the specified time. Items controlPortPerformanceListResponseData: object totalCount: integer The total number of control ports whose performance information exists within the specified period. hasNext: boolean Indicates if some control ports remain to be listed in performanceObjects. enumerateContext: string (uuid)nullable A token used to obtain the next value of performanceObjects for the applicable information. A null value is output if the information is the last one.

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication

Obtains the performance information (monitor information) about the specified control port.

Performance information is collected internally at one minute intervals. Because of this, the following problems might occur. In such cases, if you want to obtain the latest information, wait for another cycle, and then call the CLI again.

• Depending on the timing, the same information as the last time might be returned. To verify whether the information is the latest one, compare the timestamp contained in the response data with that obtained last.

• If the storage cluster's time changes drastically, past information might be returned, or information might not be returned because it is not collected yet.

• Immediately after Virtual Storage Software block is started or a control port is added or deleted, performance information might not be returned because it is not collected yet.

• Some information might not be obtained or duplicate information might be collected in one cycle due to high load, including spikes.

If the information could not be obtained, any of the following is returned:

• If the information that could not be obtained is an array element, an array without the element is returned.

• If the information that could not be obtained is an attribute, a null value is returned.

• If no performance information, including the one that satisfies the subcommand-option specification conditions, is found or obtained, an empty data object, "data": [] is returned.

The following describes data to be output according to the specification of the start_time and end_time subcommand-options:

When both start_time and end_time are omitted

• It is assumed that the time when the REST API server received the request was specified as end_time.

• It is assumed that the time which is one minute earlier than the time when the REST API server received the request was specified as start_time. However, if the end_time is 1970-01-01T00:01:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

When both start_time and end_time are specified

• The monitored information within the specified time period is returned.

When only start_time is specified

• It is assumed that the time when the REST API server received the request was specified as end_time.

When only end_time is specified

• It is assumed that the time which is one hour earlier than end_time was specified as start_time. However, if end_time is 1970-01-01T01:00:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

When the range specified by start_time and end_time is invalid

• An error is returned when any of the following conditions is satisfied:

  • A date and time later than end_time is specified as start_time, including when end_time is not specified.

  • A date and time which is earlier than 1970-01-01T00:00:01Z is specified for start_time or end_time.

  • When all the following conditions are satisfied:

    • Specify true for start_time_excluding, or false for end_time_including.

    • The same date and time is specified for start_time and end_time, including the case when start_time is not specified and 1970-01-01T00:00:01Z is specified for end_time.

hsds [master command option] control_port_performance_show
--id <str>  (required)
--start_time <str>  (optional)
--start_time_excluding <boolean>  (optional)
--end_time <str>  (optional)
--end_time_including <boolean>  (optional)

• --id <control port ID>

  Specify the ID (uuid) of the control port.

• --start_time <time>

  Specify the start date and time (date-time) of the monitor information to be obtained.

  If you specify --start_time_excluding, you can specify whether to include or exclude the specified time. By default, the specified time is included.

• --start_time_excluding {false | true}

  Specify determines whether to include information of the specified --start_time.

  • false (default): The information is included.

  • true: The information is not included.

• --end_time <time>

  Specify the end date and time (date-time) of the monitor information to be obtained.

  If you specify --end_time_including, you can specify whether to include or exclude the specified time. By default, the specified time is excluded. If it is omitted, it is the request receipt time.

• --end_time_including {false | true}

  Specify whether to include the specified end_time.

  • false (default): The specified time is not included.

  • true: The specified time is included.

• Normal termination

  controlPortPerformanceListResponse: object

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication

Obtains a list of drive performance information (monitor information). Information about drives existing at the time of CLI execution is obtained.

Performance information is collected internally at one minute intervals. Because of this, the following problems might occur. In such cases, if you want to obtain the latest information, wait for another cycle, and then call the CLI again.

• Depending on the timing, the same information as the last time might be returned.

• If the storage cluster's time changes drastically, past information might be returned, or information might not be returned because it is not collected yet.

• Immediately after Virtual Storage Software block is started or a drive is added or deleted, performance information might not be returned because it is not collected yet.

• Some information might not be obtained or duplicate information might be collected in one cycle due to high load, including spikes.

If the information could not be obtained, any of the following is returned:

• If the information that could not be obtained is an array element, an array without the element is returned.

• If the information that could not be obtained is an attribute, a null value is returned.

• If no performance information, including the one that satisfies the subcommand-option specification conditions, is found or obtained, an empty data object, "data": [] is returned.

If the number of drives is large, in order to obtain all the information, it is necessary to obtain it separately in plural times. If some drives are not obtained, hasNext in the response data shows true, and the token used to obtain the rest of the drives is output as enumerate_context. You can obtain the next volume by executing this CLI again with enumerate_context specified as the subcommand-option.

Also, by setting a count parameter, you can determine the number of drives you obtain. If lengthening the obtainment period (start_time/end_time), fewer number of the drives might return than the value set in the count parameter. If you want to obtain a large number of the drive information at once, set (start_time/end_time) briefly during the obtainment period.

totalCount in the response data is the total number of drives whose performance records were existing when the CLI was executed. The number might be changed with each CLI operation using enumerate_context. Similarly, as the information that is returned is the update at the time of CLI execution, you might obtain a record of a different timestamp value in a series of CLI operations using enumerate_context.

The following describes data to be output according to the specification of the start_time and end_time subcommand-options:

When both start_time and end_time are omitted

• It is assumed that the time when the REST API server received the request was specified as end_time.

• It is assumed that the time which is one minute earlier than the time when the REST API server received the request was specified as start_time. However, if the end_time is 1970-01-01T00:01:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

When both start_time and end_time are specified

• The monitored information within the specified time period is returned.

• Due to addition or deletion of drives, or no collection of information, the number of drives at a certain point of time might be smaller than the number output for count.

When only start_time is specified

• It is assumed that the time when the REST API server received the request was specified as end_time.

When only end_time is specified

• It is assumed that the time which is one hour earlier than end_time was specified as start_time. However, if end_time is 1970-01-01T01:00:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

• Due to addition or deletion of drives, or no collection of information, the number of drives at a certain point of time might be smaller than the number output for count.

When the range specified by start_time and end_time is invalid

• An error is returned when any of the following conditions is satisfied:

  • A date and time later than end_time is specified as start_time, including when end_time is not specified.

  • A date and time which is earlier than 1970-01-01T00:00:01Z is specified for start_time or end_time.

  • When all the following conditions are satisfied:

    • Specify true for start_time_excluding, or false for end_time_including.

    • The same date and time is specified for start_time and end_time, including the case when start_time is not specified and 1970-01-01T00:00:01Z is specified for end_time.

hsds [master command option] drive_performance_list
--start_time <str>  (optional)
--start_time_excluding <boolean>  (optional)
--end_time <str>  (optional)
--end_time_including <boolean>  (optional)
--enumerate_context <str>  (optional)
--count <int>  (optional)

• --start_time <time>

  Specify the start date and time (date-time) of the monitor information to be obtained.

  If you specify --start_time_excluding, you can specify whether to include or exclude the specified time. By default, the specified time is included.

• --start_time_excluding {false | true}

  Specify determines whether to include information of the specified --start_time.

  • false (default): The information is included.

  • true: The information is not included.

• --end_time <time>

  Specify the end date and time (date-time) of the monitor information to be obtained.

  If you specify --end_time_including, you can specify whether to include or exclude the specified time. By default, the specified time is excluded. If it is omitted, it is the request receipt time.

• --end_time_including {false | true}

  Specify whether to include the specified --end_time.

  • false (default): The specified time is not included.

  • true : The specified time is included.

• --enumerate_context <token>

  Specify token (uuid) that helps obtain the next batch records. Do not specify this parameter for initial information extraction.

• --count <count>

  Specify the number of drive records to be obtained (0 to 32,768, default: "0").

  If nothing is specified or 0 is specified, all records are output.

• Normal termination

  Description A list of drive performance information (monitor information) at the specified time and the information about performanceObjects. Properties data: object[] A list of drive performance information (monitor information) at the specified time. Items drivePerformanceListResponseData: object totalCount: integer The total number of drives whose performance information exists within the specified period. hasNext: boolean Indicates if some drives remain to be listed in performanceObjects. enumerateContext: string (uuid) nullable A token used to obtain the next value of performanceObjects for the applicable information. A null value is output if the information is the last one.

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication

Obtains the performance information (monitor information) about the specified drive.

Performance information is collected internally at one minute intervals. Because of this, the following problems might occur. In such cases, if you want to obtain the latest information, wait for another cycle, and then call the CLI again.

• Depending on the timing, the same information as the last time might be returned.

• If the storage cluster's time changes drastically, past information might be returned, or information might not be returned because it is not collected yet.

• Immediately after Virtual Storage Software block is started or a drive is added or deleted, performance information might not be returned because it is not collected yet.

• Some information might not be obtained or duplicate information might be collected in one cycle due to high load, including spikes.

If the information could not be obtained, any of the following is returned:

• If the information that could not be obtained is an array element, an array without the element is returned.

• If the information that could not be obtained is an attribute, a null value is returned.

• If no performance information, including the one that satisfies the subcommand-option specification conditions, is found or obtained, an empty data object, "data": [] is returned.

The following describes data to be output according to the specification of the start_time and end_time subcommand-options:

When both start_time and end_time are omitted

• It is assumed that the time when the REST API server received the request was specified as end_time.

• It is assumed that the time which is one minute earlier than the time when the REST API server received the request was specified as start_time. However, if the end_time is 1970-01-01T00:01:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

When both start_time and end_time are specified

• The monitored information within the specified time period is returned.

When only start_time is specified

• It is assumed that the time when the REST API server received the request was specified as end_time.

When only end_time is specified

• It is assumed that the time which is one hour earlier than end_time was specified as start_time. However, if end_time is 1970-01-01T01:00:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

When the range specified by start_time and end_time is invalid

• An error is returned when any of the following conditions is satisfied:

  • A date and time later than end_time is specified as start_time, including when end_time is not specified.

  • A date and time which is earlier than 1970-01-01T00:00:01Z is specified for start_time or end_time.

  • When all the following conditions are satisfied:

    • Specify true for start_time_excluding, or false for end_time_including.

    • The same date and time is specified for start_time and end_time, including the case when start_time is not specified and 1970-01-01T00:00:01Z is specified for end_time.

hsds [master command option] drive_performance_show
--id <str>  (required)
--start_time <str>  (optional)
--start_time_excluding <boolean>  (optional)
--end_time <str>  (optional)
--end_time_including <boolean>  (optional)

• --id <drive ID>

  Specify drive ID (uuid).

• --start_time <time>

  Specify the start date and time (date-time) of the monitor information to be obtained.

  If you specify --start_time_excluding, you can specify whether to include or exclude the specified time. By default, the specified time is included.

• --start_time_excluding {false | true}

  Specify determines whether to include information of the specified --start_time.

  • false (default): The information is included.

  • true: The information is not included.

• --end_time <time>

  Specify the end date and time (date-time) of the monitor information to be obtained.

  If you specify --end_time_including, you can specify whether to include or exclude the specified time. By default, the specified time is excluded. If it is omitted, it is the request receipt time.

• --end_time_including {false | true}

  Specify whether to include the specified --end_time.

  • false (default): The specified time is not included.

  • true : The specified time is included.

• Normal termination

  drivePerformanceListResponse: object

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication

Obtains a list of internode port performance information (monitor information). Information about internode ports existing at the time of CLI execution is obtained.

Performance information is collected internally at one minute intervals. Because of this, the following problems might occur. In such cases, if you want to obtain the latest information, wait for another cycle, and then call the CLI again.

• Depending on the timing, the same information as the last time might be returned. To verify whether the information is the latest one, compare the timestamp contained in the response data with that obtained last.

• If the storage cluster's time changes drastically, past information might be returned, or information might not be returned because it is not collected yet.

• Immediately after Virtual Storage Software block is started or an internode port is added or deleted, performance information might not be returned because it is not collected yet.

• Some information might not be obtained or duplicate information might be collected in one cycle due to high load, including spikes.

If the information could not be obtained, any of the following is returned:

• If the information that could not be obtained is an array element, an array without the element is returned.

• If the information that could not be obtained is an attribute, a null value is returned.

• If no performance information, including the one that satisfies the subcommand-option specification conditions, is found or obtained, an empty data object, "data": [] is returned.

If the number of internode ports is large, in order to obtain all the information, it is necessary to obtain it separately in plural times. If some internode ports are not obtained, hasNext in the response data shows true, and the token used to obtain the rest of the internode ports is output as enumerateContext. You can obtain the next volume by executing this CLI again with enumerateContext specified as the subcommand-option.

Also, by setting a count parameter, you can determine the number of internode ports you obtain. If lengthening the obtainment period (start_time/end_time), fewer number of the internode ports might return than the value set in the count parameter. If you want to obtain a large number of the internode port information at once, set (start_time/end_time) briefly during the obtainment period.

totalCount in the response data is the total number of internode ports whose performance records were existing when the CLI was executed. The number might be changed with each CLI operation using enumerateContext. Similarly, as the information that is returned is the update at the time of CLI execution, you might obtain a record of a different timestamp value in a series of CLI operations using enumerateContext.

The following describes data to be output according to the specification of the start_time and end_time subcommand-options:

When both start_time and end_time are omitted

• It is assumed that the time when the REST API server received the request was specified as end_time.

• It is assumed that the time which is one minute earlier than the time when the REST API server received the request was specified as start_time. However, if the end_time is 1970-01-01T00:01:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

When both start_time and end_time are specified

• The monitored information within the specified time period is returned.

• Due to addition or deletion of internode ports, or no collection of information, the number of internode ports at a certain point of time might be smaller than the number output for count.

When only start_time is specified

• It is assumed that the time when the REST API server received the request was specified as end_time.

When only end_time is specified

• It is assumed that the time which is one hour earlier than end_time was specified as start_time. However, if end_time is 1970-01-01T01:00:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

• Due to addition or deletion of internode ports, or no collection of information, the number of internode ports at a certain point of time might be smaller than the number output for count.

When the range specified by start_time and end_time is invalid

• An error is returned when any of the following conditions is satisfied:

  • A date and time later than end_time is specified as start_time, including when end_time is not specified.

  • A date and time which is earlier than 1970-01-01T00:00:01Z is specified for start_time or end_time.

  • When all the following conditions are satisfied:

    • Specify true for start_time_excluding, or false for end_time_including.

    • The same date and time is specified for start_time and end_time, including the case when start_time is not specified and 1970-01-01T00:00:01Z is specified for end_time.

hsds [master command option] internode_port_performance_list
--start_time <str>  (optional)
--start_time_excluding <boolean>  (optional)
--end_time <str>  (optional)
--end_time_including <boolean>  (optional)
--enumerate_context <str>  (optional)
--count <int>  (optional)

• --start_time <time>

  Specify the start date and time (date-time) of the monitor information to be obtained.

  If you specify --start_time_excluding, you can specify whether to include or exclude the specified time. By default, the specified time is included.

• --start_time_excluding {false | true}

  Specify determines whether to include information of the specified --start_time.

  • false (default): The information is included.

  • true: The information is not included.

• --end_time <time>

  Specify the end date and time (date-time) of the monitor information to be obtained.

  If you specify --end_time_including, you can specify whether to include or exclude the specified time. By default, the specified time is excluded. If it is omitted, it is the request receipt time.

• --end_time_including {false | true}

  Specify whether to include the specified --end_time.

  • false (default): The specified time is not included.

  • true: The specified time is included.

• --enumerate_context <token>

  Specify token (uuid) that helps obtain the next batch records. Do not specify this parameter for initial information extraction.

• --count <count>

  Specify the number of internode port records to be obtained (0 to 32,768 , default: "0").

  If nothing is specified or 0 is specified, all records are output.

• Normal termination

  Description A list of internode port performance information (monitor information) at the specified time and the information about performanceObjects. Properties data: object[] A list of internode port performance information (monitor information) at the specified time. Items internodePortPerformanceListResponseData: object totalCount: integer The total number of internode ports whose performance information exists within the specified period. hasNext: boolean Indicates if some internode ports remain to be listed in performanceObjects. enumerateContext: string (uuid) nullable A token used to obtain the next value of performanceObjects for the applicable information. A null value is output if the information is the last one.

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication

Obtains the performance information (monitor information) about the specified internode port.

Performance information is collected internally at one minute intervals. Because of this, the following problems might occur. In such cases, if you want to obtain the latest information, wait for another cycle, and then call the CLI again.

• Depending on the timing, the same information as the last time might be returned. To verify whether the information is the latest one, compare the timestamp contained in the response data with that obtained last.

• If the storage cluster's time changes drastically, past information might be returned, or information might not be returned because it is not collected yet.

• Immediately after Virtual Storage Software block is started or an internode port is added or deleted, performance information might not be returned because it is not collected yet.

• Some information might not be obtained or duplicate information might be collected in one cycle due to high load, including spikes.

If the information could not be obtained, any of the following is returned:

• If the information that could not be obtained is an array element, an array without the element is returned.

• If the information that could not be obtained is an attribute, a null value is returned.

• If no performance information, including the one that satisfies the subcommand-option specification conditions, is found or obtained, an empty data object, "data": [] is returned.

The following describes data to be output according to the specification of the start_time and end_time subcommand-options:

When both start_time and end_time are omitted

• It is assumed that the time when the REST API server received the request was specified as end_time.

• It is assumed that the time which is one minute earlier than the time when the REST API server received the request was specified as start_time. However, if the end_time is 1970-01-01T00:01:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

When both start_time and end_time are specified

• The monitored information within the specified time period is returned.

When only start_time is specified

• It is assumed that the time when the REST API server received the request was specified as end_time.

When only end_time is specified

• It is assumed that the time which is one hour earlier than end_time was specified as start_time. However, if end_time is 1970-01-01T01:00:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

When the range specified by start_time and end_time is invalid

• An error is returned when any of the following conditions is satisfied:

  • A date and time later than end_time is specified as start_time, including when end_time is not specified.

  • A date and time which is earlier than 1970-01-01T00:00:01Z is specified for start_time or end_time.

  • When all the following conditions are satisfied:

    • Specify true for start_time_excluding, or false for end_time_including.

    • The same date and time is specified for start_time and end_time, including the case when start_time is not specified and 1970-01-01T00:00:01Z is specified for end_time.

hsds [master command option] internode_port_performance_show
--id <str>  (required)
--start_time <str>  (optional)
--start_time_excluding <boolean>  (optional)
--end_time <str>  (optional)
--end_time_including <boolean>  (optional)

• --id <internode port ID>

  Specify the ID (uuid) of the internode port.

• --start_time <time>

  Specify the start date and time (date-time) of the monitor information to be obtained.

  If you specify --start_time_excluding, you can specify whether to include or exclude the specified time. By default, the specified time is included.

• --start_time_excluding {false | true}

  Specify determines whether to include information of the specified --start_time.

  • false (default): The information is included.

  • true: The information is not included.

• --end_time <time>

  Specify the end date and time (date-time) of the monitor information to be obtained.

  If you specify --end_time_including, you can specify whether to include or exclude the specified time. By default, the specified time is excluded. If it is omitted, it is the request receipt time.

• --end_time_including {false | true}

  Specify whether to include the specified --end_time.

  • false (default): The specified time is not included.

  • true: The specified time is included.

• Normal termination

  internodePortPerformanceListResponse: object

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication

Obtains a list of storage pool capacity information (monitor information). Information about storage pools existing at the time of CLI execution is obtained.

The capacity information is internally collected on a one-minute cycle. Because of this, problems listed below might occur. In that case, if you want to obtain the latest information, wait for another cycle, and then call the CLI again.

• Depending on the timing, the same information as the last time might be returned.

• If the storage cluster's time changes drastically, past information might be returned, or information might not be returned because it is not collected yet.

• Immediately after Virtual Storage Software block is started or a storage pool is added or deleted, performance information might not be returned because it is not collected yet.

• Some information might not be obtained or duplicate information might be collected in one cycle due to high load, including spikes.

If the information could not be obtained, any of the following is returned:

• If the information that could not be obtained is an array element, an array without the element is returned.

• If the information that could not be obtained is an attribute, a null value is returned.

• If no capacity information, including the one that satisfies the subcommand-option specification conditions, is found or obtained, an empty data object, "data": [] is returned.

If the number of storage pools is large, in order to obtain all the information, it is necessary to obtain it separately in plural times. If some storage pools are not obtained, hasNext in the response data shows true, and the token used to obtain the rest of the pools is output as enumerate_context. You can obtain the next volume by executing this CLI again with enumerate_context specified as the subcommand-option.

Also, by setting a count parameter, you can determine the number of storage pools you obtain. If lengthening the obtainment period (start_time/end_time), fewer number of the storage pools might return than the value set in the count parameter. If you want to obtain a large number of the storage pool information at once, set (start_time/end_time) briefly during the obtainment period.

totalCount in the response data is the total number of storage pools whose capacity records were existing when the CLI was executed. The number might be changed with each CLI operation using enumerate_context. Similarly, as the information that is returned is the update at the time of CLI execution, you might obtain a record of a different timestamp value in a series of CLI operations using enumerate_context.

The following describes data to be output according to the specification of the start_time and end_time subcommand-options:

When both start_time and end_time are omitted

• It is assumed that the time when the REST API server received the request was specified as end_time.

• It is assumed that the time which is one minute earlier than the time when the REST API server received the request was specified as start_time. However, if the end_time is 1970-01-01T00:01:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

When both start_time and end_time are specified

• The monitored information within the specified time period is returned.

• Due to addition or deletion of storage pools, or no collection of information, the number of storage pools at a certain point of time might be smaller than the number output for count.

When only start_time is specified

• It is assumed that the time when the REST API server received the request was specified as end_time.

When only end_time is specified

• It is assumed that the time which is one hour earlier than end_time was specified as start_time. However, if end_time is 1970-01-01T01:00:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

• Due to addition or deletion of storage pools, or no collection of information, the number of storage pools at a certain point of time might be smaller than the number output for count.

When the range specified by start_time and end_time is invalid

• An error is returned when any of the following conditions is satisfied:

  • A date and time later than end_time is specified as start_time, including when end_time is not specified.

  • A date and time which is earlier than 1970-01-01T00:00:01Z is specified for start_time or end_time.

  • When all the following conditions are satisfied:

    • Specify true for start_time_excluding, or false for end_time_including.

    • The same date and time is specified for start_time and end_time, including the case when start_time is not specified and 1970-01-01T00:00:01Z is specified for end_time.

hsds [master command option] pool_capacity_performance_list
--start_time <str>  (optional)
--start_time_excluding <boolean>  (optional)
--end_time <str>  (optional)
--end_time_including <boolean>  (optional)
--enumerate_context <str>  (optional)
--count <int>  (optional)

• --start_time <time>

  Specify the start date and time (date-time) of the monitor information to be obtained.

  If you specify --start_time_excluding, you can specify whether to include or exclude the specified time. By default, the specified time is included.

• --start_time_excluding {false | true}

  Specify determines whether to include information of the specified --start_time.

  • false (default): The information is included.

  • true: The information is not included.

• --end_time <time>

  Specify the end date and time (date-time) of the monitor information to be obtained.

  If you specify --end_time_including, you can specify whether to include or exclude the specified time. By default, the specified time is excluded. If it is omitted, it is the request receipt time.

• --end_time_including {false | true}

  Specify whether to include the specified --end_time.

  • false (default): The specified time is not included.

  • true : The specified time is included.

• --enumerate_context <token>

  Specify token (uuid) that helps obtain the next batch records. Do not specify this parameter for initial information extraction.

• --count <count>

  Specify the number (0 to 32,768, default: "0") of storage pool records to be obtained.

  If nothing is specified or 0 is specified, all records are output.

• Normal termination

  Description A list of storage pool capacity information (monitor information) at the specified time and the information about performanceObjects. Properties data: object[] A list of storage pool capacity information (monitor information) at the specified time. Items poolCapacityListResponseData: object totalCount: integer The total number of storage pools whose capacity information exists within the specified period. hasNext: boolean Indicates if some storage pools remain to be listed in performanceObjects. enumerateContext: string (uuid) nullable A token used to obtain the next value of performanceObjects for the applicable information. A null value is output if the information is the last one.

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication

Obtains the capacity information (monitor information) about the specified storage pool.

The capacity information is internally collected on a one-minute cycle. Because of this, problems listed below might occur. In that case, if you want to obtain the latest information, wait for another cycle, and then call the CLI again.

• Depending on the timing, the same information as the last time might be returned.

• If the storage cluster's time changes drastically, past information might be returned, or information might not be returned because it is not collected yet.

• Immediately after Virtual Storage Software block is started or a storage pool is added or deleted, performance information might not be returned because it is not collected yet.

• Some information might not be obtained or duplicate information might be collected in one cycle due to high load, including spikes.

If the information could not be obtained, any of the following is returned:

• If the information that could not be obtained is an array element, an array without the element is returned.

• If the information that could not be obtained is an attribute, a null value is returned.

• If no capacity information, including the one that satisfies the subcommand-option specification conditions, is found or obtained, an empty data object, "data": [] is returned.

The following describes data to be output according to the specification of the start_time and end_time subcommand-options:

When both start_time and end_time are omitted

• It is assumed that the time when the REST API server received the request was specified as end_time.

• It is assumed that the time which is one minute earlier than the time when the REST API server received the request was specified as start_time. However, if the end_time is 1970-01-01T00:01:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

When both start_time and end_time are specified

• The monitored information within the specified time period is returned.

When only start_time is specified

• It is assumed that the time when the REST API server received the request was specified as end_time.

When only end_time is specified

• It is assumed that the time which is one hour earlier than end_time was specified as start_time. However, if end_time is 1970-01-01T01:00:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

<When the range specified by start_time and end_time is invalid>

• An error is returned when any of the following conditions is satisfied:

  • A date and time later than end_time is specified as start_time, including when end_time is not specified.

  • A date and time which is earlier than 1970-01-01T00:00:01Z is specified for start_time or end_time.

  • When all the following conditions are satisfied:

    • Specify true for start_time_excluding, or false for end_time_including.

    • The same date and time is specified for start_time and end_time, including the case when start_time is not specified and 1970-01-01T00:00:01Z is specified for end_time.

hsds [master command option] pool_capacity_performance_show
--id <str>  (required *1)
--id_name <str>  (required *1)
--start_time <str>  (optional)
--start_time_excluding <boolean>  (optional)
--end_time <str>  (optional)
--end_time_including <boolean>  (optional)

• --id <storage pool ID>

  Specify the ID (uuid) of the storage pool.

  Either --id or --id_name must be specified.

• --id_name <storage pool name>

  Specify the name of the storage pool.

  Specify a value instead of --id.¹

  Either --id or --id_name must be specified.

  must match /^[\-A-Za-z0-9_]{1,32}$/

• --start_time <time>

  Specify the start date and time (date-time) of the monitor information to be obtained.

  If you specify --start_time_excluding, you can specify whether to include or exclude the specified time. By default, the specified time is included.

• --start_time_excluding {false | true}

  Specify determines whether to include information of the specified --start_time.

  • false (default): The information is included.

  • true: The information is not included.

• --end_time <time>

  Specify the end date and time (date-time) of the monitor information to be obtained.

  If you specify --end_time_including, you can specify whether to include or exclude the specified time. By default, the specified time is excluded. If it is omitted, it is the request receipt time.

• --end_time_including {false | true}

  Specify whether to include the specified --end_time.

  • false (default): The specified time is not included.

  • true : The specified time is included.

• Normal termination

  Description A list of storage pool capacity information (monitor information) at the specified time. Properties data: object[] Items poolCapacityListResponseData: object

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication

Obtains a list of storage pool performance information (monitor information). Information about storage pools existing at the time of CLI execution is obtained.

Performance information is collected internally at one minute intervals. Because of this, the following problems might occur. In such cases, if you want to obtain the latest information, wait for another cycle, and then call the CLI again.

• Depending on the timing, the same information as the last time might be returned.

• If the storage cluster's time changes drastically, past information might be returned, or information might not be returned because it is not collected yet.

• Immediately after Virtual Storage Software block is started or a storage pool is added or deleted, performance information might not be returned because it is not collected yet.

• Some information might not be obtained or duplicate information might be collected in one cycle due to high load, including spikes.

If the information could not be obtained, any of the following is returned:

• If the information that could not be obtained is an array element, an array without the element is returned.

• If the information that could not be obtained is an attribute, a null value is returned.

• If no performance information, including the one that satisfies the subcommand-option specification conditions, is found or obtained, an empty data object, "data": [] is returned.

If the number of storage pools is large, in order to obtain all the information, it is necessary to obtain it separately in plural times. If some storage pools are not obtained, hasNext in the response data shows true, and the token used to obtain the rest of the pools is output as enumerate_context. You can obtain the next volume by executing this CLI again with enumerate_context specified as the subcommand-option.

Also, by setting a count parameter, you can determine the number of storage pools you obtain. If lengthening the obtainment period (start_time/end_time), fewer number of the storage pools might return than the value set in the count parameter. If you want to obtain a large number of the storage pool information at once, set (start_time/end_time) briefly during the obtainment period.

totalCount in the response data is the total number of storage pools whose performance records were existing when the CLI was executed. The number might be changed with each CLI operation using enumerate_context. Similarly, as the information that is returned is the update at the time of CLI execution, you might obtain a record of a different timestamp value in a series of CLI operations using enumerate_context.

The following describes data to be output according to the specification of the start_time and end_time subcommand-options:

When both start_time and end_time are omitted

• It is assumed that the time when the REST API server received the request was specified as end_time.

• It is assumed that the time which is one minute earlier than the time when the REST API server received the request was specified as start_time. However, if the end_time is 1970-01-01T00:01:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

When both start_time and end_time are specified

• The monitored information within the specified time period is returned.

• Due to addition or deletion of storage pools, or no collection of information, the number of storage pools at a certain point of time might be smaller than the number output for count.

When only start_time is specified

• It is assumed that the time when the REST API server received the request was specified as end_time.

When only end_time is specified

• It is assumed that the time which is one hour earlier than end_time was specified as start_time. However, if end_time is 1970-01-01T01:00:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

• Due to addition or deletion of storage pools, or no collection of information, the number of storage pools at a certain point of time might be smaller than the number output for count.

When the range specified by start_time and end_time is invalid

• An error is returned when any of the following conditions is satisfied:

  • A date and time later than end_time is specified as start_time, including when end_time is not specified.

  • A date and time which is earlier than 1970-01-01T00:00:01Z is specified for start_time or end_time.

  • When all the following conditions are satisfied:

    • Specify true for start_time_excluding, or false for end_time_including.

    • The same date and time is specified for start_time and end_time, including the case when start_time is not specified and 1970-01-01T00:00:01Z is specified for end_time.

hsds [master command option] pool_performance_list
--start_time <str>  (optional)
--start_time_excluding <boolean>  (optional)
--end_time <str>  (optional)
--end_time_including <boolean>  (optional)
--enumerate_context <str>  (optional)
--count <int>  (optional)

• --start_time <time>

  Specify the start date and time (date-time) of the monitor information to be obtained.

  If you specify --start_time_excluding, you can specify whether to include or exclude the specified time. By default, the specified time is included.

• --start_time_excluding {false | true}

  Specify determines whether to include information of the specified --start_time.

  • false (default): The information is included.

  • true: The information is not included.

• --end_time <time>

  Specify the end date and time (date-time) of the monitor information to be obtained.

  If you specify --end_time_including, you can specify whether to include or exclude the specified time. By default, the specified time is excluded. If it is omitted, it is the request receipt time.

• --end_time_including {false | true}

  Specify whether to include the specified --end_time.

  • false (default): The specified time is not included.

  • true : The specified time is included.

• --enumerate_context <token>

  Specify token (uuid) that helps obtain the next batch records. Do not specify this parameter for initial information extraction.

• --count <count>

  Specify the number (0 to 32,768, default: "0") of storage pool records to be obtained.

  If nothing is specified or 0 is specified, all records are output.

• Normal termination

  Description A list of storage pool performance information (monitor information) at the specified time. Properties data: object[] Items poolPerformanceListResponseData: object totalCount: integer The total number of storage pools whose performance information exists within the specified period. hasNext: boolean Indicates if some storage pools remain to be listed in performanceObjects. enumerateContext: string (uuid) nullable A token used to obtain the next value of performanceObjects for the applicable information. A null value is output if the information is the last one.

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication

Obtains the performance information (monitor information) about the specified storage pool.

Performance information is collected internally at one minute intervals. Because of this, the following problems might occur. In such cases, if you want to obtain the latest information, wait for another cycle, and then call the CLI again.

• Depending on the timing, the same information as the last time might be returned.

• If the storage cluster's time changes drastically, past information might be returned, or information might not be returned because it is not collected yet.

• Immediately after Virtual Storage Software block is started or a storage pool is added or deleted, performance information might not be returned because it is not collected yet.

• Some information might not be obtained or duplicate information might be collected in one cycle due to high load, including spikes.

If the information could not be obtained, any of the following is returned:

• If the information that could not be obtained is an array element, an array without the element is returned.

• If the information that could not be obtained is an attribute, a null value is returned.

• If no performance information, including the one that satisfies the subcommand-option specification conditions, is found or obtained, an empty data object, "data": [] is returned.

The following describes data to be output according to the specification of the start_time and end_time subcommand-options:

When both start_time and end_time are omitted

• It is assumed that the time when the REST API server received the request was specified as end_time.

• It is assumed that the time which is one minute earlier than the time when the REST API server received the request was specified as start_time. However, if the end_time is 1970-01-01T00:01:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

When both start_time and end_time are specified

• The monitored information within the specified time period is returned.

When only start_time is specified

• It is assumed that the time when the REST API server received the request was specified as end_time.

When only end_time is specified

• It is assumed that the time which is one hour earlier than end_time was specified as start_time. However, if end_time is 1970-01-01T01:00:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

<When the range specified by start_time and end_time is invalid>

• An error is returned when any of the following conditions is satisfied:

  • A date and time later than end_time is specified as start_time, including when end_time is not specified.

  • A date and time which is earlier than 1970-01-01T00:00:01Z is specified for start_time or end_time.

  • When all the following conditions are satisfied:

    • Specify true for start_time_excluding, or false for end_time_including.

    • The same date and time is specified for start_time and end_time, including the case when start_time is not specified and 1970-01-01T00:00:01Z is specified for end_time.

hsds [master command option] pool_performance_show
--id <str>  (required *1)
--id_name <str>  (required *1)
--start_time <str>  (optional)
--start_time_excluding <boolean>  (optional)
--end_time <str>  (optional)
--end_time_including <boolean>  (optional)

• --id <storage pool ID>

  Specify the ID (uuid) of the storage pool.

  Either --id or --id_name must be specified.

• --id_name <storage pool name>

  Specify the name of the storage pool.

  Specify a value instead of --id.¹

  Either --id or --id_name must be specified.

  must match /^[\-A-Za-z0-9_]{1,32}$/

• --start_time <time>

  Specify the start date and time (date-time) of the monitor information to be obtained.

  If you specify --start_time_excluding, you can specify whether to include or exclude the specified time. By default, the specified time is included.

• --start_time_excluding {false | true}

  Specify determines whether to include information of the specified --start_time.

  • false (default): The information is included.

  • true: The information is not included.

• --end_time <time>

  Specify the end date and time (date-time) of the monitor information to be obtained.

  If you specify --end_time_including, you can specify whether to include or exclude the specified time. By default, the specified time is excluded. If it is omitted, it is the request receipt time.

• --end_time_including {false | true}

  Specify whether to include the specified --end_time.

  • false (default): The specified time is not included.

  • true : The specified time is included.

• Normal termination

  Description A list of storage pool performance information (monitor information) at the specified time. Properties data: object[] Items poolPerformanceListResponseData: object

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication

Obtains a list of compute port performance information (monitor information). Information about compute ports existing at the time of CLI execution is obtained.

Performance information is collected internally at one minute intervals. Because of this, the following problems might occur. In such cases, if you want to obtain the latest information, wait for another cycle, and then call the CLI again.

• Depending on the timing, the same information as the last time might be returned. To verify whether the information is the latest one, compare the timestamp contained in the response data with that obtained last.

• If the storage cluster's time changes drastically, past information might be returned, or information might not be returned because it is not collected yet.

• Immediately after Virtual Storage Software block is started or a compute port is added or deleted, performance information might not be returned because it is not collected yet.

• Some information might not be obtained or duplicate information might be collected in one cycle due to high load, including spikes.

If the information could not be obtained, any of the following is returned:

• If the information that could not be obtained is an array element, an array without the element is returned.

• If the information that could not be obtained is an attribute, a null value is returned.

• If no performance information, including the one that satisfies the subcommand-option specification conditions, is found or obtained, an empty data object, "data": [] is returned.

If the number of compute ports is large, in order to obtain all the information, it is necessary to obtain it separately in plural times. If some compute ports are not obtained, hasNext in the response data shows true, and the token used to obtain the rest of the compute ports is output as enumerateContext. You can obtain the next volume by executing this CLI again with enumerateContext specified as the subcommand-option.

Also, by setting a count parameter, you can determine the number of compute ports you obtain. If lengthening the obtainment period (start_time/end_time), fewer number of the compute ports might return than the value set in the count parameter. If you want to obtain a large number of the compute port information at once, set (start_time/end_time) briefly during the obtainment period.

totalCount in the response data is the total number of compute ports whose performance records were existing when the CLI was executed. The number might be changed with each CLI operation using enumerateContext. Similarly, as the information that is returned is the update at the time of CLI execution, you might obtain a record of a different timestamp value in a series of CLI operations using enumerateContext.

The following describes data to be output according to the specification of the start_time and end_time subcommand-options:

When both start_time and end_time are omitted

• It is assumed that the time when the REST API server received the request was specified as end_time.

• It is assumed that the time which is one minute earlier than the time when the REST API server received the request was specified as start_time. However, if the end_time is 1970-01-01T00:01:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

When both start_time and end_time are specified

• The monitored information within the specified time period is returned.

• Due to addition or deletion of compute ports, or no collection of information, the number of compute ports at a certain point of time might be smaller than the number output for count.

When only start_time is specified

• It is assumed that the time when the REST API server received the request was specified as end_time.

When only end_time is specified

• It is assumed that the time which is one hour earlier than end_time was specified as start_time. However, if end_time is 1970-01-01T01:00:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

• Due to addition or deletion of compute ports, or no collection of information, the number of compute ports at a certain point of time might be smaller than the number output for count.

When the range specified by start_time and end_time is invalid

• An error is returned when any of the following conditions is satisfied:

  • A date and time later than end_time is specified as start_time, including when end_time is not specified.

  • A date and time which is earlier than 1970-01-01T00:00:01Z is specified for start_time or end_time.

  • When all the following conditions are satisfied:

    • Specify true for start_time_excluding, or false for end_time_including.

    • The same date and time is specified for start_time and end_time, including the case when start_time is not specified and 1970-01-01T00:00:01Z is specified for end_time.

hsds [master command option] port_performance_list
--start_time <str>  (optional)
--start_time_excluding <boolean>  (optional)
--end_time <str>  (optional)
--end_time_including <boolean>  (optional)
--enumerate_context <str>  (optional)
--count <int>  (optional)

• --start_time <time>

  Specify the start date and time (date-time) of the monitor information to be obtained.

  If you specify --start_time_excluding, you can specify whether to include or exclude the specified time. By default, the specified time is included.

• --start_time_excluding {false | true}

  Specify determines whether to include information of the specified --start_time.

  • false (default): The information is included.

  • true: The information is not included.

• --end_time <time>

  Specify the end date and time (date-time) of the monitor information to be obtained.

  If you specify --end_time_including, you can specify whether to include or exclude the specified time. By default, the specified time is excluded. If it is omitted, it is the request receipt time.

• --end_time_including {false | true}

  Specify whether to include the specified --end_time.

  • false (default): The specified time is not included.

  • true: The specified time is included.

• --enumerate_context <token>

  Specify token (uuid) that helps obtain the next batch records. Do not specify this parameter for initial information extraction.

• --count <count>

  Specify the number (0 to 32,768, default: "0") of compute port records to be obtained.

  If nothing is specified or 0 is specified, all records are output.

• Normal termination

  Description A list of compute port performance information (monitor information) at the specified time and the information about performanceObjects. Properties data: object[] A list of compute port performance information (monitor information) at the specified time. Items portPerformanceListResponseData: object totalCount: integer The total number of compute ports whose performance information exists within the specified period. hasNext: boolean Indicates if some compute ports remain to be listed in performanceObjects. enumerateContext: string (uuid) nullable A token used to obtain the next value of performanceObjects for the applicable information. A null value is output if the information is the last one.

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication

Obtains the performance information (monitor information) about the specified compute port.

Performance information is collected internally at one minute intervals. Because of this, the following problems might occur. In such cases, if you want to obtain the latest information, wait for another cycle, and then call the CLI again.

• Depending on the timing, the same information as the last time might be returned. To verify whether the information is the latest one, compare the timestamp contained in the response data with that obtained last.

• If the storage cluster's time changes drastically, past information might be returned, or information might not be returned because it is not collected yet.

• Immediately after Virtual Storage Software block is started or a compute port is added or deleted, performance information might not be returned because it is not collected yet.

• Some information might not be obtained or duplicate information might be collected in one cycle due to high load, including spikes.

If the information could not be obtained, any of the following is returned:

• If the information that could not be obtained is an array element, an array without the element is returned.

• If the information that could not be obtained is an attribute, a null value is returned.

• If no performance information, including the one that satisfies the subcommand-option specification conditions, is found or obtained, an empty data object, "data": [] is returned.

The following describes data to be output according to the specification of the start_time and end_time subcommand-options:

When both start_time and end_time are omitted

• It is assumed that the time when the REST API server received the request was specified as end_time.

• It is assumed that the time which is one minute earlier than the time when the REST API server received the request was specified as start_time. However, if the end_time is 1970-01-01T00:01:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

When both start_time and end_time are specified

• The monitored information within the specified time period is returned.

When only start_time is specified

• It is assumed that the time when the REST API server received the request was specified as end_time.

When only end_time is specified

• It is assumed that the time which is one hour earlier than end_time was specified as start_time. However, if end_time is 1970-01-01T01:00:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

When the range specified by start_time and end_time is invalid

• An error is returned when any of the following conditions is satisfied:

  • A date and time later than end_time is specified as start_time, including when end_time is not specified.

  • A date and time which is earlier than 1970-01-01T00:00:01Z is specified for start_time or end_time.

  • When all the following conditions are satisfied:

    • Specify true for start_time_excluding, or false for end_time_including.

    • The same date and time is specified for start_time and end_time, including the case when start_time is not specified and 1970-01-01T00:00:01Z is specified for end_time.

hsds [master command option] port_performance_show
--id <str>  (required *1)
--id_name <str>  (required *1)
--start_time <str>  (optional)
--start_time_excluding <boolean>  (optional)
--end_time <str>  (optional)
--end_time_including <boolean>  (optional)

• --id <compute port ID>

  Specify the ID (uuid) of the compute port.

  Either --id or --id_name must be specified.

• --id_name {<WWN> | <iSCSI name>}

  Specify WWN of the compute port for FC connection or the iSCSI name for iSCSI connections.¹

  Specify a value instead of --id.²

  Either --id or --id_name must be specified.

  must match /^[a-f0-9]{16}$|^[A-F0-9]{16}$|^((iqn\.[0-9]{4}\-[0-9]{2}\.[a-zA-Z0-9\-:\.]{0,211})|(eui\.[0-9a-fA-F]{16}))$/

• --start_time <time>

  Specify the start date and time (date-time) of the monitor information to be obtained.

  If you specify --start_time_excluding, you can specify whether to include or exclude the specified time. By default, the specified time is included.

• --start_time_excluding {false | true}

  Specify determines whether to include information of the specified --start_time.

  • false (default): The information is included.

  • true: The information is not included.

• --end_time <time>

  Specify the end date and time (date-time) of the monitor information to be obtained.

  If you specify --end_time_including, you can specify whether to include or exclude the specified time. By default, the specified time is excluded. If it is omitted, it is the request receipt time.

• --end_time_including {false | true}

  Specify whether to include the specified --end_time.

  • false (default): The specified time is not included.

  • true: The specified time is included.

• Normal termination

  portPerformanceListResponse: object

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication

Obtains the storage cluster performance information (monitor information).

Performance information is collected internally at one minute intervals. Because of this, the following problems might occur. In such cases, if you want to obtain the latest information, wait for another cycle, and then call the CLI again.

• Depending on the timing, the same information as the last time might be returned.

• If the storage cluster's time changes drastically, past information might be returned, or information might not be returned because it is not collected yet.

• Immediately after Virtual Storage Software block is started, performance information might not be returned because it is not collected yet.

• Some information might not be obtained or duplicate information might be collected in one cycle due to high load, including spikes.

If the information could not be obtained, any of the following is returned:

• If the information that could not be obtained is an array element, an array without the element is returned.

• If the information that could not be obtained is an attribute, a null value is returned.

• If no performance information, including the one that satisfies the subcommand-option specification conditions, is found or obtained, an empty data object, "data": [] is returned.

The following describes data to be output according to the specification of the start_time and end_time subcommand-options:

When both start_time and end_time are omitted

• It is assumed that the time when the REST API server received the request was specified as end_time.

• It is assumed that the time which is one minute earlier than the time when the REST API server received the request was specified as start_time. However, if the end_time is 1970-01-01T00:01:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

When both start_time and end_time are specified

• The monitored information within the specified time period is returned.

When only start_time is specified

• It is assumed that the time when the REST API server received the request was specified as end_time.

When only end_time is specified

• It is assumed that the time which is one hour earlier than end_time was specified as start_time. However, if end_time is 1970-01-01T01:00:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

When the range specified by start_time and end_time is invalid

• An error is returned when any of the following conditions is satisfied:

  • A date and time later than end_time is specified as start_time, including when end_time is not specified.

  • A date and time which is earlier than 1970-01-01T00:00:01Z is specified for start_time or end_time.

  • When all the following conditions are satisfied:

    • Specify true for start_time_excluding, or false for end_time_including.

    • The same date and time is specified for start_time and end_time, including the case when start_time is not specified and 1970-01-01T00:00:01Z is specified for end_time.

hsds [master command option] storage_performance_show
--start_time <str>  (optional)
--start_time_excluding <boolean>  (optional)
--end_time <str>  (optional)
--end_time_including <boolean>  (optional)

• --start_time <time>

  Specify the start date and time (date-time) of the monitor information to be obtained.

  If you specify --start_time_excluding, you can specify whether to include or exclude the specified time. By default, the specified time is included.

• --start_time_excluding {false | true}

  Specify determines whether to include information of the specified --start_time.

  • false (default): The information is included.

  • true: The information is not included.

• --end_time <time>

  Specify the end date and time (date-time) of the monitor information to be obtained.

  If you specify --end_time_including, you can specify whether to include or exclude the specified time. By default, the specified time is excluded. If it is omitted, it is the request receipt time.

• --end_time_including {false | true}

  Specify whether to include the specified --end_time.

  • false (default): The specified time is not included.

  • true : The specified time is included.

• Normal termination

  Description A list of storage cluster performance information (monitor information) at the specified time. Properties data: object[] Items storagePerformanceListResponseData: object

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication

Obtains a list of storage node performance information (monitor information). Information about storage nodes existing at the time of CLI execution is obtained.

Performance information is collected internally at one minute intervals. Because of this, the following problems might occur. In such cases, if you want to obtain the latest information, wait for another cycle, and then call the CLI again.

• Depending on the timing, the same information as the last time might be returned.

• If the storage cluster's time changes drastically, past information might be returned, or information might not be returned because it is not collected yet.

• Immediately after Virtual Storage Software block is started or a storage node is added or deleted, performance information might not be returned because it is not collected yet.

• Some information might not be obtained or duplicate information might be collected in one cycle due to high load, including spikes.

If the information could not be obtained, any of the following is returned:

• If the information that could not be obtained is an array element, an array without the element is returned.

• If the information that could not be obtained is an attribute, a null value is returned.

• If no performance information, including the one that satisfies the subcommand-option specification conditions, is found or obtained, an empty data object, "data": [] is returned.

If the number of storage nodes is large, in order to obtain all the information, it is necessary to obtain it separately in plural times. If some storage nodes are not obtained, hasNext in the response data shows true, and the token used to obtain the rest of the nodes is output as enumerate_context. You can obtain the next volume by executing this CLI again with enumerate_context specified as the subcommand-option.

Also, by setting a count parameter, you can determine the number of storage nodes you obtain. If lengthening the obtainment period (start_time/end_time), fewer number of the storage nodes might return than the value set in the count parameter. If you want to obtain a large number of the storage node information at once, set (start_time/end_time) briefly during the obtainment period.

totalCount in the response data is the total number of storage nodes whose performance records were existing when the CLI was executed. The number might be changed with each CLI operation using enumerate_context. Similarly, as the information that is returned is the update at the time of CLI execution, you might obtain a record of a different timestamp value in a series of CLI operations using enumerate_context.

The following describes data to be output according to the specification of the start_time and end_time subcommand-options:

When both start_time and end_time are omitted

• It is assumed that the time when the REST API server received the request was specified as end_time.

• It is assumed that the time which is one minute earlier than the time when the REST API server received the request was specified as start_time. However, if the end_time is 1970-01-01T00:01:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

When both start_time and end_time are specified

• The monitored information within the specified time period is returned.

• Due to addition or deletion of storage nodes, or no collection of information, the number of storage nodes at a certain point of time might be smaller than the number output for count.

When only start_time is specified

• It is assumed that the time when the REST API server received the request was specified as end_time.

When only end_time is specified

• It is assumed that the time which is one hour earlier than end_time was specified as start_time. However, if end_time is 1970-01-01T01:00:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

• Due to addition or deletion of storage nodes, or no collection of information, the number of storage nodes at a certain point of time might be smaller than the number output for count.

When the range specified by start_time and end_time is invalid

• An error is returned when any of the following conditions is satisfied:

  • A date and time later than end_time is specified as start_time, including when end_time is not specified.

  • A date and time which is earlier than 1970-01-01T00:00:01Z is specified for start_time or end_time.

  • When all the following conditions are satisfied:

    • Specify true for start_time_excluding, or false for end_time_including.

    • The same date and time is specified for start_time and end_time, including the case when start_time is not specified and 1970-01-01T00:00:01Z is specified for end_time.

hsds [master command option] storage_node_performance_list
--start_time <str>  (optional)
--start_time_excluding <boolean>  (optional)
--end_time <str>  (optional)
--end_time_including <boolean>  (optional)
--enumerate_context <str>  (optional)
--count <int>  (optional)

• --start_time <time>

  Specify the start date and time (date-time) of the monitor information to be obtained.

  If you specify start_time_excluding, you can specify whether to include or exclude the specified time. By default, the specified time is included.

• --start_time_excluding {false | true}

  Specify determines whether to include information of the specified start_time.

  • false (default): The information is included.

  • true: The information is not included.

• --end_time <time>

  Specify the end date and time (date-time) of the monitor information to be obtained.

  If you specify end_time_including, you can specify whether to include or exclude the specified time. By default, the specified time is excluded. If it is omitted, it is the request receipt time.

• --end_time_including {false | true}

  Specify whether to include the specified end_time.

  • false (default): The specified time is not included.

  • true : The specified time is included.

• --enumerate_context <token>

  Specify token (uuid) that helps obtain the next batch records. Do not specify this parameter for initial information extraction.

• --count <count>

  Specify the number (0 to 32,768, default: "0") of storage node records to be obtained.

  If nothing is specified or 0 is specified, all records are output.

• Normal termination

  Description A list of storage node performance information (monitor information) at the specified time and the information about performanceObjects. Properties data: object[] Items storageNodePerformanceListResponseData: object totalCount: integer The total number of storage nodes whose performance information exists within the specified period. hasNext: boolean Indicates if some storage nodes remain to be listed in performanceObjects. enumerateContext: string (uuid) nullable A token used to obtain the next value of performanceObjects for the applicable information. A null value is output if the information is the last one.

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication

Obtains the performance information (monitor information) about the specified storage node.

Performance information is collected internally at one minute intervals. Because of this, the following problems might occur. In such cases, if you want to obtain the latest information, wait for another cycle, and then call the CLI again.

• Depending on the timing, the same information as the last time might be returned.

• If the storage cluster's time changes drastically, past information might be returned, or information might not be returned because it is not collected yet.

• Immediately after Virtual Storage Software block is started or a storage node is added or deleted, performance information might not be returned because it is not collected yet.

• Some information might not be obtained or duplicate information might be collected in one cycle due to high load, including spikes.

If the information could not be obtained, any of the following is returned:

• If the information that could not be obtained is an array element, an array without the element is returned.

• If the information that could not be obtained is an attribute, a null value is returned.

• If no performance information, including the one that satisfies the subcommand-option specification conditions, is found or obtained, an empty data object, "data": [] is returned.

The following describes data to be output according to the specification of the start_time and end_time subcommand-options:

When both start_time and end_time are omitted

• It is assumed that the time when the REST API server received the request was specified as end_time.

• It is assumed that the time which is one minute earlier than the time when the REST API server received the request was specified as start_time. However, if the end_time is 1970-01-01T00:01:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

When both start_time and end_time are specified

• The monitored information within the specified time period is returned.

When only start_time is specified

• It is assumed that the time when the REST API server received the request was specified as end_time.

When only end_time is specified

• It is assumed that the time which is one hour earlier than end_time was specified as start_time. However, if end_time is 1970-01-01T01:00:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

When the range specified by start_time and end_time is invalid

• An error is returned when any of the following conditions is satisfied:

  • A date and time later than end_time is specified as start_time, including when end_time is not specified.

  • A date and time which is earlier than 1970-01-01T00:00:01Z is specified for start_time or end_time.

  • When all the following conditions are satisfied:

    • Specify true for start_time_excluding, or false for end_time_including.

    • The same date and time is specified for start_time and end_time, including the case when start_time is not specified and 1970-01-01T00:00:01Z is specified for end_time.

hsds [master command option] storage_node_performance_show
--id <str>  (required)
--start_time <str>  (optional)
--start_time_excluding <boolean>  (optional)
--end_time <str>  (optional)
--end_time_including <boolean>  (optional)

• --id <storage node ID>

  Specify storage node ID (uuid).

• --start_time <time>

  Specify the start date and time (date-time) of the monitor information to be obtained.

  If you specify start_time_excluding, you can specify whether to include or exclude the specified time. By default, the specified time is included.

• --start_time_excluding {false | true}

  Specify determines whether to include information of the specified start_time.

  • false (default): The information is included.

  • true: The information is not included.

• --end_time <time>

  Specify the end date and time (date-time) of the monitor information to be obtained.

  If you specify end_time_including, you can specify whether to include or exclude the specified time. By default, the specified time is excluded. If it is omitted, it is the request receipt time.

• --end_time_including {false | true}

  Specify whether to include the specified end_time.

  • false (default): The specified time is not included.

  • true : The specified time is included.

• Normal termination

  storageNodePerformanceListResponse: object

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication

Obtains a list of volume capacity information (monitor information). Information about volumes existing at the time of CLI execution is obtained.

The capacity information is internally collected on a one-minute cycle. Because of this, problems listed below might occur. In that case, if you want to obtain the latest information, wait for another cycle, and then call the CLI again.

• Depending on the timing, the same information as the last time might be returned.

• If the storage cluster's time changes drastically, past information might be returned, or information might not be returned because it is not collected yet.

• Immediately after Virtual Storage Software block is started or a volume is added or deleted, performance information might not be returned because it is not collected yet.

• Some information might not be obtained or duplicate information might be collected in one cycle due to high load, including spikes.

If the information could not be obtained, any of the following is returned:

• If the information that could not be obtained is an array element, an array without the element is returned.

• If the information that could not be obtained is an attribute, a null value is returned.

• If no capacity information, including the one that satisfies the subcommand-option specification conditions, is found or obtained, an empty data object, "data": [] is returned.

If the number of volumes is large, in order to obtain all the information, it is necessary to obtain it separately in plural times. If some volumes are not obtained, hasNext in the response data shows true, and the token used to obtain the rest of the volumes is output as enumerate_context. You can obtain the next volume by executing this CLI again with enumerate_context specified as the subcommand-option.

Also, by setting a count parameter, you can determine the number of volume records you obtain. If lengthening the obtainment period (start_time/end_time), fewer number of the volumes might return than the value set in the count parameter. If you want to obtain a large number of the volume information at once, set (start_time/end_time) briefly during the obtainment period.

totalCount in the response data is the total number of volumes whose capacity records were existing when the CLI was executed. The number might be changed with each CLI operation using enumerate_context. Similarly, as the information that is returned is the update at the time of CLI execution, you might obtain a record of a different timestamp value in a series of CLI operations using enumerate_context.

The following describes data to be output according to the specification of the start_time and end_time subcommand-options:

When both start_time and end_time are omitted

• It is assumed that the time when the REST API server received the request was specified as end_time.

• It is assumed that the time which is one minute earlier than the time when the REST API server received the request was specified as start_time. However, if the end_time is 1970-01-01T00:01:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

When both start_time and end_time are specified

• The monitored information within the specified time period is returned.

• Due to addition or deletion of volumes, or no collection of information, the number of volumes at a certain point of time might be smaller than the number output for count.

When only start_time is specified

• It is assumed that the time when the REST API server received the request was specified as end_time.

When only end_time is specified

• It is assumed that the time which is one hour earlier than end_time was specified as start_time. However, if end_time is 1970-01-01T01:00:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

• Due to addition or deletion of volumes, or no collection of information, the number of volumes at a certain point of time might be smaller than the number output for count.

When the range specified by start_time and end_time is invalid

• An error is returned when any of the following conditions is satisfied:

  • A date and time later than end_time is specified as start_time, including when end_time is not specified.

  • A date and time which is earlier than 1970-01-01T00:00:01Z is specified for start_time or end_time.

  • When all the following conditions are satisfied:

    • Specify true for start_time_excluding, or false for end_time_including.

    • The same date and time is specified for start_time and end_time, including the case when start_time is not specified and 1970-01-01T00:00:01Z is specified for end_time.

hsds [master command option] volume_capacity_performance_list
--start_time <str>  (optional)
--start_time_excluding <boolean>  (optional)
--end_time <str>  (optional)
--end_time_including <boolean>  (optional)
--enumerate_context <str>  (optional)
--count <int>  (optional)
--vps_id <str>  (optional)
--vps_id_name <str>  (optional)

• --start_time <time>

  Specify the start date and time (date-time) of the monitor information to be obtained.

  If you specify --start_time_excluding, you can specify whether to include or exclude the specified time. By default, the specified time is included.

• --start_time_excluding {false | true}

  Specify determines whether to include information of the specified --start_time.

  • false (default): The information is included.

  • true: The information is not included.

• --end_time <time>

  Specify the end date and time (date-time) of the monitor information to be obtained.

  If you specify --end_time_including, you can specify whether to include or exclude the specified time. By default, the specified time is excluded. If it is omitted, it is the request receipt time.

• --end_time_including {false | true}

  Specify whether to include the specified --end_time.

  • false (default): The specified time is not included.

  • true : The specified time is included.

• --enumerate_context <token>

  Specify token (uuid) that helps obtain the next batch records. Do not specify this parameter for initial information extraction.

• --count <count>

  Specify the number (0 to 32,768, default: "0") of volume records to be obtained.

  If nothing is specified or 0 is specified, all records are output.

• --vps_id <VPS ID>

  The ID of the virtual private storage (VPS) that the acquisition-target resource belongs to.

  To filter out the resources that do not belong to the VPS, specify "system".

  To filter the resources by the VPS that the resources belong to, specify it in UUID format.

  -- vps_id and --vps_id_name cannot be specified simultaneously.

  must match /^system$|^[A-Fa-f0-9]{8}(-[A-Fa-f0-9]{4}){3}-[A-Fa-f0-9]{12}$/

• --vps_id_name <VPS name>

  The name of the virtual private storage (VPS) that the acquisition-target resource belongs to.

  To filter out the resources that do not belong to the VPS, specify "system".

  -- vps_id and --vps_id_name cannot be specified simultaneously.

  must match /^[\-A-Za-z0-9,\.:@_]{1,32}$/

• Normal termination

  Description A list of capacity information of a volume (monitor information) at the specified time, and information about performanceObjects. Properties data: object[] A list of capacity information of a volume (monitor information) at the specified time. Items volumeCapacityListResponseData: object totalCount: integer The total number of volumes whose capacity information exists within the specified time period. hasNext: boolean Indicates if some volumes remain to be listed in performanceObjects. enumerateContext: string (uuid) nullable A token used to obtain the next value of performanceObjects for the applicable information. A null value is output if the information is the last one.

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication

Obtains the capacity information (monitor information) about of the specified volume.

The capacity information is internally collected on a one-minute cycle. Because of this, problems listed below might occur. In that case, if you want to obtain the latest information, wait for another cycle, and then call the CLI again.

• Depending on the timing, the same information as the last time might be returned.

• If the storage cluster's time changes drastically, past information might be returned, or information might not be returned because it is not collected yet.

• Immediately after Virtual Storage Software block is started or a volume is added or deleted, performance information might not be returned because it is not collected yet.

• Some information might not be obtained or duplicate information might be collected in one cycle due to high load, including spikes.

If the information could not be obtained, any of the following is returned:

• If the information that could not be obtained is an array element, an array without the element is returned.

• If the information that could not be obtained is an attribute, a null value is returned.

• If no capacity information, including the one that satisfies the subcommand-option specification conditions, is found or obtained, an empty data object, "data": [] is returned.

The following describes data to be output according to the specification of the start_time and end_time subcommand-options:

When both start_time and end_time are omitted

• It is assumed that the time when the REST API server received the request was specified as end_time.

• It is assumed that the time which is one minute earlier than the time when the REST API server received the request was specified as start_time. However, if the end_time is 1970-01-01T00:01:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

When both start_time and end_time are specified

• The monitored information within the specified time period is returned.

When only start_time is specified

• It is assumed that the time when the REST API server received the request was specified as end_time.

When only end_time is specified

• It is assumed that the time which is one hour earlier than end_time was specified as start_time. However, if end_time is 1970-01-01T01:00:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

When the range specified by start_time and end_time is invalid

• An error is returned when any of the following conditions is satisfied:

  • A date and time later than end_time is specified as start_time, including when end_time is not specified.

  • A date and time which is earlier than 1970-01-01T00:00:01Z is specified for start_time or end_time.

  • When all the following conditions are satisfied:

    • Specify true for start_time_excluding, or false for end_time_including.

    • The same date and time is specified for start_time and end_time, including the case when start_time is not specified and 1970-01-01T00:00:01Z is specified for end_time.

hsds [master command option] volume_capacity_performance_show
--id <str>  (required *1)
--id_name <str>  (required *1)
--start_time <str>  (optional)
--start_time_excluding <boolean>  (optional)
--end_time <str>  (optional)
--end_time_including <boolean>  (optional)

• --id <volume ID>

  Specify volume ID (uuid).

  Either --id or --id_name must be specified.

• --id_name <volume name>

  Specify the volume name.

  Specify a value instead of --id.¹

  Either --id or --id_name must be specified.

  must match /^[\-A-Za-z0-9,\.:@_]{1,32}$/

• --start_time <time>

  Specify the start date and time (date-time) of the monitor information to be obtained.

  If you specify --start_time_excluding, you can specify whether to include or exclude the specified time. By default, the specified time is included.

• --start_time_excluding {false | true}

  Specify determines whether to include information of the specified --start_time.

  • false (default): The information is included.

  • true: The information is not included.

• --end_time <time>

  Specify the end date and time (date-time) of the monitor information to be obtained.

  If you specify --end_time_including, you can specify whether to include or exclude the specified time. By default, the specified time is excluded. If it is omitted, it is the request receipt time.

• --end_time_including {false | true}

  Specify whether to include the specified --end_time.

  • false (default): The specified time is not included.

  • true : The specified time is included.

• Normal termination

  Description A list of capacity information of a volume (monitor information) at the specified time. Properties data: object[] Items volumeCapacityListResponseData: object

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication

Obtains a list of volume performance information (monitor information). Information about volumes existing at the time of CLI execution is obtained.

Performance information is collected internally at one minute intervals. Because of this, the following problems might occur. In such cases, if you want to obtain the latest information, wait for another cycle, and then call the CLI again.

• Depending on the timing, the same information as the last time might be returned.

• If the storage cluster's time changes drastically, past information might be returned, or information might not be returned because it is not collected yet.

• Immediately after Virtual Storage Software block is started or a volume is added or deleted, performance information might not be returned because it is not collected yet.

• Some information might not be obtained or duplicate information might be collected in one cycle due to high load, including spikes.

If the information could not be obtained, any of the following is returned:

• If the information that could not be obtained is an array element, an array without the element is returned.

• If the information that could not be obtained is an attribute, a null value is returned.

• If no performance information, including the one that satisfies the subcommand-option specification conditions, is found or obtained, an empty data object, "data": [] is returned.

If the number of volumes is large, in order to obtain all the information, it is necessary to obtain it separately in plural times. If some volumes are not obtained, hasNext in the response data shows true, and the token used to obtain the rest of the volumes is output as enumerate_context. You can obtain the next volume by executing this CLI again with enumerate_context specified as the subcommand-option.

Also, by setting a count parameter, you can determine the number of volume records you obtain. If lengthening the obtainment period (start_time/end_time), fewer number of the volumes might return than the value set in the count parameter. If you want to obtain a large number of the volume information at once, set (start_time/end_time) briefly during the obtainment period.

totalCount in the response data is the total number of volumes whose performance records were existing when the CLI was executed. The number might be changed with each CLI operation using enumerate_context. Similarly, as the information that is returned is the update at the time of CLI execution, you might obtain a record of a different timestamp value in a series of CLI operations using enumerate_context.

The following describes data to be output according to the specification of the start_time and end_time subcommand-options:

When both start_time and end_time are omitted

• It is assumed that the time when the REST API server received the request was specified as end_time.

• It is assumed that the time which is one minute earlier than the time when the REST API server received the request was specified as start_time. However, if the end_time is 1970-01-01T00:01:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

When both start_time and end_time are specified

• The monitored information within the specified time period is returned.

• Due to addition or deletion of volumes, or no collection of information, the number of volumes at a certain point of time might be smaller than the number output for count.

When only start_time is specified

• It is assumed that the time when the REST API server received the request was specified as end_time.

When only end_time is specified

• It is assumed that the time which is one hour earlier than end_time was specified as start_time. However, if end_time is 1970-01-01T01:00:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

• Due to addition or deletion of volumes, or no collection of information, the number of volumes at a certain point of time might be smaller than the number output for count.

When the range specified by start_time and end_time is invalid

• An error is returned when any of the following conditions is satisfied:

  • A date and time later than end_time is specified as start_time, including when end_time is not specified.

  • A date and time which is earlier than 1970-01-01T00:00:01Z is specified for start_time or end_time.

  • When all the following conditions are satisfied:

    • Specify true for start_time_excluding, or false for end_time_including.

    • The same date and time is specified for start_time and end_time, including the case when start_time is not specified and 1970-01-01T00:00:01Z is specified for end_time.

hsds [master command option] volume_performance_list
--start_time <str>  (optional)
--start_time_excluding <boolean>  (optional)
--end_time <str>  (optional)
--end_time_including <boolean>  (optional)
--enumerate_context <str>  (optional)
--count <int>  (optional)
--vps_id <str>  (optional)
--vps_id_name <str>  (optional)

• --start_time <time>

  Specify the start date and time (date-time) of the monitor information to be obtained.

  If you specify --start_time_excluding, you can specify whether to include or exclude the specified time. By default, the specified time is included.

• --start_time_excluding {false | true}

  Specify determines whether to include information of the specified --start_time.

  • false (default): The information is included.

  • true: The information is not included.

• --end_time <time>

  Specify the end date and time (date-time) of the monitor information to be obtained.

  If you specify --end_time_including, you can specify whether to include or exclude the specified time. By default, the specified time is excluded. If it is omitted, it is the request receipt time.

• --end_time_including {false | true}

  Specify whether to include the specified --end_time.

  • false (default): The specified time is not included.

  • true : The specified time is included.

• --enumerate_context <token>

  Specify token (uuid) that helps obtain the next batch records. Do not specify this parameter for initial information extraction.

• --count <count>

  Specify the number (0 to 32,768, default: "0") of volume records to be obtained.

  If nothing is specified or 0 is specified, all records are output.

• --vps_id <VPS ID>

  The ID of the virtual private storage (VPS) that the acquisition-target resource belongs to.

  To filter out the resources that do not belong to the VPS, specify "system".

  To filter the resources by the VPS that the resources belong to, specify it in UUID format.

  -- vps_id and --vps_id_name cannot be specified simultaneously.

  must match /^system$|^[A-Fa-f0-9]{8}(-[A-Fa-f0-9]{4}){3}-[A-Fa-f0-9]{12}$/

• --vps_id_name <VPS name>

  The name of the virtual private storage (VPS) that the acquisition-target resource belongs to.

  To filter out the resources that do not belong to the VPS, specify "system".

  -- vps_id and --vps_id_name cannot be specified simultaneously.

  must match /^[\-A-Za-z0-9,\.:@_]{1,32}$/

• Normal termination

  Description A list of volume performance information (monitor information) at the specified time and information about performanceObjects. Properties data: object[] A list of volume performance information (monitor information) at the specified time. Items volumePerformanceListResponseData: object totalCount: integer The total number of volumes whose performance information exists within the specified time period. hasNext: boolean Indicates if some volumes remain to be listed in performanceObjects. enumerateContext: string (uuid) nullable A token used to obtain the next value of performanceObjects for the applicable information. A null value is output if the information is the last one.

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication

Obtains the performance information (monitor information) about the specified volume.

Performance information is collected internally at one minute intervals. Because of this, the following problems might occur. In such cases, if you want to obtain the latest information, wait for another cycle, and then call the CLI again.

• Depending on the timing, the same information as the last time might be returned.

• If the storage cluster's time changes drastically, past information might be returned, or information might not be returned because it is not collected yet.

• Immediately after Virtual Storage Software block is started or a volume is added or deleted, performance information might not be returned because it is not collected yet.

• Some information might not be obtained or duplicate information might be collected in one cycle due to high load, including spikes.

If the information could not be obtained, any of the following is returned:

• If the information that could not be obtained is an array element, an array without the element is returned.

• If the information that could not be obtained is an attribute, a null value is returned.

• If no performance information, including the one that satisfies the subcommand-option specification conditions, is found or obtained, an empty data object, "data": [] is returned.

The following describes data to be output according to the specification of the start_time and end_time subcommand-options:

When both start_time and end_time are omitted

• It is assumed that the time when the REST API server received the request was specified as end_time.

• It is assumed that the time which is one minute earlier than the time when the REST API server received the request was specified as start_time. However, if the end_time is 1970-01-01T00:01:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

When both start_time and end_time are specified

• The monitored information within the specified time period is returned.

When only start_time is specified

• It is assumed that the time when the REST API server received the request was specified as end_time.

When only end_time is specified

• It is assumed that the time which is one hour earlier than end_time was specified as start_time. However, if end_time is 1970-01-01T01:00:00Z or earlier, it is assumed that 1970-01-01T00:00:01Z is specified as start_time.

<When the range specified by start_time and end_time is invalid>

• An error is returned when any of the following conditions is satisfied:

  • A date and time later than end_time is specified as start_time, including when end_time is not specified.

  • A date and time which is earlier than 1970-01-01T00:00:01Z is specified for start_time or end_time.

  • When all the following conditions are satisfied:

    • Specify true for start_time_excluding, or false for end_time_including.

    • The same date and time is specified for start_time and end_time, including the case when start_time is not specified and 1970-01-01T00:00:01Z is specified for end_time.

hsds [master command option] volume_performance_show
--id <str>  (required *1)
--id_name <str>  (required *1)
--start_time <str>  (optional)
--start_time_excluding <boolean>  (optional)
--end_time <str>  (optional)
--end_time_including <boolean>  (optional) 

• --id <volume ID>

  Specify volume ID (uuid).

  Either --id or --id_name must be specified.

• --id_name <volume name>

  Specify the volume name.

  Specify a value instead of --id.¹

  Either --id or --id_name must be specified.

  must match /^[\-A-Za-z0-9,\.:@_]{1,32}$/

• --start_time <time>

  Specify the start date and time (date-time) of the monitor information to be obtained.

  If you specify --start_time_excluding, you can specify whether to include or exclude the specified time. By default, the specified time is included.

• --start_time_excluding {false | true}

  Specify determines whether to include information of the specified --start_time.

  • false (default): The information is included.

  • true: The information is not included.

• --end_time <time>

  Specify the end date and time (date-time) of the monitor information to be obtained.

  If you specify --end_time_including, you can specify whether to include or exclude the specified time. By default, the specified time is excluded. If it is omitted, it is the request receipt time.

• --end_time_including {false | true}

  Specify whether to include the specified --end_time.

  • false (default): The specified time is not included.

  • true : The specified time is included.

• Normal termination

  volumePerformanceListResponse: object

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication