ResetPassword Virtual Network Appliance

Summary

Reset Password Virtual Network Appliance.

Type

  • Action

Synchronous/Asynchronous

  • Asynchronous

Request

HTTP Request Method

  • POST

HTTP Request Path

{api_endpoint}/v1.0/virtual_network_appliances/{virtual_network_appliance_id}/reset-password

HTTP Request Header

Content-Type: application/json
Accept: application/json
X-Auth-Token: <token_id>

注釈

  • Field names in HTTP request header are case-insensitive.

HTTP Request Body

Parameters

Input Parameters

name

style

datetype

format

description

required/optional

default value

action for invalid parameter

response code for invalid parameter

token_id

Header

String

Non-Hyph-uuid

keystone authentication token

required

Terminate

401

virtual_network_appliance_id

URL

String

Hyph-uuid

ID of the Virtual Network Appliance

required

Terminate

404

注釈

  • It can not be executed when vm_status of Virtual Network Appliance is not ACTIVE or os_login_status is not ACTIVE.

Response

Response Header

Format

HTTP/1.1 <response_code> <message>       (ex. 200 OK)
  • <response_code>: see "HTTP Responses" section

  • <message>: message based on the response code

Response Code

Response Codes

response code

condition

200

OK

401

Unauthorized

404

Not Found

409

Conflicted

500

Internal Server Error

Response Body

Format

{
  "username": "root",
  "new_password": "8eEG31lMnq0h"
}

Parameters

Response Parameters

item

datatype

format

description

username

String

String(0-255)

Name of the user

new_password

String

Passowrd(12)

New Password

Sample Request and Response

Sample API Request

Request URI

https://{api_endpoint}/v1.0/virtual_network_appliances/{virtual_network_appliance_id}/reset-password

Request Header

Content-Type: application/json
Accept: application/json
X-Auth-Token: 69105c889f824efdafb56af224208ad4

Request Body

This operation does not send a request body.

Sample API Response

Response Header

HTTP/1.1 200 OK

Response Body

{
  "username": "root",
  "new_password": "4AeC36ac1k1P"
}

Example Error Message

HTTP Request

POST /v1.0/virtual_network_appliances/{virtual_network_appliance_id}/reset-password HTTP/1.1
User-Agent: curl/7.51.0
Host: 10.1.131.140
Accept:application/json
X-Auth-Token:4e54395a12b740d585d74190ba4eb14b
Content-Type: application/json

HTTP Response

HTTP/1.1 404 Not Found
Server: nginx
Date: Wed, 07 Feb 2018 06:49:20 GMT
Content-Type: application/json
Content-Length: 25
Connection: keep-alive

{
    "message": "Not Found."
}