From 58785c4a67a706f6033649fa4d3beb6e6f33ddd2 Mon Sep 17 00:00:00 2001 From: Takashi NATSUME Date: Tue, 14 Jun 2016 13:20:38 +0900 Subject: [PATCH] api-ref: Fix parameters in os-instance-usage-audit-log The parameters have been verified in Ia7af3cab3c0ed82418a6fa140fea061074ccd8b5. But response parameters are missing, so fix them. And fix some wrong description. Change-Id: Ic1a307c405f769cadd037ae45e921d88b6a2bea5 Implements: blueprint api-ref-in-rst --- .../source/os-instance-usage-audit-log.inc | 40 +++++ api-ref/source/parameters.yaml | 144 ++++++++++++++++-- 2 files changed, 168 insertions(+), 16 deletions(-) diff --git a/api-ref/source/os-instance-usage-audit-log.inc b/api-ref/source/os-instance-usage-audit-log.inc index a4760d669e56..4355440b7219 100644 --- a/api-ref/source/os-instance-usage-audit-log.inc +++ b/api-ref/source/os-instance-usage-audit-log.inc @@ -20,6 +20,26 @@ Error response codes: unauthorized(401), forbidden(403) Response -------- +.. rest_parameters:: parameters.yaml + + - instance_usage_audit_logs: instance_usage_audit_logs + - hosts_not_run: host_not_run + - log: instance_usage_audit_log + - errors: errors + - instances: instances_usage_audit + - message: instance_usage_audit_log_message + - state: instance_usage_audit_task_state + - num_hosts: host_num + - num_hosts_done: host_done_num + - num_hosts_not_run: host_not_run_num + - num_hosts_running: host_running_num + - overall_status: overall_status + - period_beginning: period_beginning + - period_ending: period_ending + - total_errors: total_errors + - total_instances: total_instances + + **Example List Usage Audits For All Servers on tenant** .. literalinclude:: ../../doc/api_samples/os-instance-usage-audit-log/inst-usage-audit-log-index-get-resp.json @@ -46,6 +66,26 @@ Request Response -------- +.. rest_parameters:: parameters.yaml + + - instance_usage_audit_logs: instance_usage_audit_logs + - hosts_not_run: host_not_run + - log: instance_usage_audit_log + - errors: errors + - instances: instances_usage_audit + - message: instance_usage_audit_log_message + - state: instance_usage_audit_task_state + - num_hosts: host_num + - num_hosts_done: host_done_num + - num_hosts_not_run: host_not_run_num + - num_hosts_running: host_running_num + - overall_status: overall_status + - period_beginning: period_beginning + - period_ending: period_ending + - total_errors: total_errors + - total_instances: total_instances + + **Example List Usage Audits Before Specified Time** .. literalinclude:: ../../doc/api_samples/os-instance-usage-audit-log/inst-usage-audit-log-show-get-resp.json diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 4e9fc8f0f0cf..5c9d4736d836 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -46,6 +46,20 @@ attachment_id: in: path required: true type: string +before_timestamp: + description: | + Filters the response by the date and time before which to list usage + audits. + The date and time stamp format is as follows: + + :: + + CCYY-MM-DD hh:mm:ss.NNNNNN + + For example, ``2015-08-27 09:49:58`` or ``2015-08-27 09:49:58.123456``. + in: path + required: true + type: string cell_id: description: | The UUID of the cell. @@ -284,22 +298,6 @@ all_tenants_query: in: query required: false type: integer -before_timestamp: - description: | - Filters the response by the date and time before which to list usage - audits. - The date and time stamp format is `ISO 8601 `_: - - :: - - CCYY-MM-DDThh:mm:ss±hh:mm - - The ``±hh:mm`` value, if included, returns the time zone as an offset from UTC. - For example, ``2015-08-27T09:49:58-05:00``. - If you omit the time zone, the UTC time zone is assumed. - in: query - required: true - type: string changes-since: description: | Filters the response by a date and time when the image last changed status. @@ -1147,6 +1145,12 @@ display_name: in: body required: false type: string +errors: + description: | + The number of errors. + in: body + required: true + type: integer evacuate: description: | Specify the ``evacuate`` action in the request body. @@ -1512,6 +1516,12 @@ host_disk_gb: in: body required: true type: string +host_done_num: + description: | + The number of the hosts whose instance audit tasks have been done. + in: body + required: true + type: integer host_ip: description: | The IP address of the hypervisor's host. @@ -1543,6 +1553,24 @@ host_name_body: in: body required: true type: string +host_not_run: + description: | + A list of the hosts whose instance audit tasks have not run. + in: body + required: true + type: array +host_not_run_num: + description: | + The number of the hosts whose instance audit tasks have not run. + in: body + required: true + type: integer +host_num: + description: | + The number of the hosts. + in: body + required: true + type: integer host_power_action: description: | The power action on the host. @@ -1567,6 +1595,12 @@ host_resource_array: in: body required: true type: array +host_running_num: + description: | + The number of the hosts whose instance audit tasks are running. + in: body + required: true + type: integer host_service: description: | The service name which is running on the host. @@ -1850,6 +1884,31 @@ instance_name: in: body required: true type: string +instance_usage_audit_log: + description: | + The object of instance usage audit logs. + in: body + required: true + type: object +instance_usage_audit_log_message: + description: | + The log message of the instance usage audit task. + in: body + required: true + type: string +instance_usage_audit_logs: + description: | + The object of instance usage audit log information. + in: body + required: true + type: object +instance_usage_audit_task_state: + description: | + The state of the instance usage audit task. + ``DONE`` or ``RUNNING``. + in: body + required: true + type: string instances: description: | The number of allowed instances for each tenant. @@ -1869,6 +1928,12 @@ instances_quota_optional: in: body required: false type: integer +instances_usage_audit: + description: | + The number of instances. + in: body + required: true + type: integer interfaceAttachment: description: | Specify the ``interfaceAttachment`` action in the request body. @@ -2487,6 +2552,27 @@ os:scheduler_hints: in: body required: false type: object +overall_status: + description: | + The overall status of instance audit tasks. + + :: + + M of N hosts done. K errors. + + The ``M`` value is the number of hosts whose instance audit tasks have + been done in the period. The ``N`` value is the number of all hosts. + The ``K`` value is the number of hosts whose instance audit tasks + cause errors. If instance audit tasks have been done at all hosts + in the period, the overall status is as follows: + + :: + + ALL hosts done. K errors. + + in: body + required: true + type: string parent_group_id: description: | Security group ID. @@ -2505,6 +2591,20 @@ pause: in: body required: true type: string +period_beginning: + description: | + The beginning time of the instance usage audit period. + For example, ``2016-05-01 00:00:00``. + in: body + required: true + type: string +period_ending: + description: | + The ending time of the instance usgae audit period. + For example, ``2016-06-01 00:00:00``. + in: body + required: true + type: string personality: description: | The file path and contents, text only, to inject into the server at launch. The @@ -3066,6 +3166,18 @@ to_port: in: body required: true type: integer +total_errors: + description: | + The total number of instance audit task errors. + in: body + required: true + type: integer +total_instances: + description: | + The total number of VM instances in the period. + in: body + required: true + type: integer trigger_crash_dump: in: body required: true