Modifying the Specifications of a Pay-Per-Use Gateway
Function
This API is used to create a specification change order of a pay-per-use gateway.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/apigw/instances/{instance_id}/postpaid-resize
Parameter | Mandatory | Type | Description |
---|---|---|---|
project_id | Yes | String | Project ID. For details about how to obtain it, see Obtaining a Project ID. |
instance_id | Yes | String | Gateway ID, which can be obtained from the gateway information on the APIG console. |
Request Parameters
Parameter | Mandatory | Type | Description |
---|---|---|---|
X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
spec_id | No | String | Target gateway specifications. |
Response Parameters
Status code: 200
Parameter | Type | Description |
---|---|---|
instance_id | String | Gateway ID. |
message | String | Gateway scale-out information. |
job_id | String | Task ID. |
Status code: 401
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Status code: 403
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Status code: 500
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Example Requests
{"spec_id" : "PROFESSIONAL"}
Example Responses
Status code: 200
ACCEPTED
{"instance_id" : "6a7d71827fd54572b1f31aa9548fcc81","message" : "JOB_ASSIGNED_FOR_RESIZE_0086I:The job JOB-5acb75c7565e42c997954774456eac79 is assigned to resize instance.","job_id" : "JOB-5acb75c7565e42c997954774456eac79"}
Status code: 401
Unauthorized
{"error_code" : "APIC.7102","error_msg" : "Incorrect token or token resolution failed"}
Status code: 403
Forbidden
{"error_code" : "APIC.7106","error_msg" : "No permissions to request for the method"}
Status code: 500
Internal Server Error
{"error_code" : "APIC.9000","error_msg" : "Failed to request internal service"}
Status Codes
Status Code | Description |
---|---|
200 | ACCEPTED |
401 | Unauthorized |
403 | Forbidden |
500 | Internal Server Error |
Error Codes
See Error Codes.
- Function
- Calling Method
- URI
- Request Parameters
- Response Parameters
- Example Requests
- Example Responses
- Status Codes
- Error Codes