Plan - Distributed Secure Internet GateWay API References (1.5.0)
Download OpenAPI specification:Download
Plan is kind of a Cell size.
Get Plan
Get Plan resources.
Authorizations:
query Parameters
| id | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The ID of the resource. |
| name | string ^[a-zA-Z0-9-_]{1,255}$ A name of the resource. |
| publicIpNum | integer Number of IP Addresses asssign to a Cell for NAT. |
Responses
200
OK
400
Bad Request
401
Unauthorized
500
Internal Server Error
get/v1/plans
https://api.ntt.com/dsigw-erg/v1/plans
Response samples
- 200
- 400
- 401
- 500
Content type
application/json
Copy
Expand all Collapse all {- "plans": [
- {
- "id": "a564678f-75c7-4ce4-a411-e869fd0f5016",
- "name": "Small-BE",
- "description": "small-besteffort-plan",
- "publicIpNum": 1,
- "status": "ACTIVE"
}, - {
- "id": "c3e9bbb5-af93-4992-a4d2-a655c935b880",
- "name": "Large-BE",
- "description": "large-besteffort-plan",
- "publicIpNum": 2,
- "status": "ACTIVE"
}, - {
- "id": "a564678f-75c7-4ce4-a411-e869fd0f5017",
- "name": "Small-GA",
- "description": "small-guarantee-plan",
- "publicIpNum": 1,
- "status": "ACTIVE"
}, - {
- "id": "c3e9bbb5-af93-4992-a4d2-a655c935b881",
- "name": "Large-GA",
- "description": "large-guarantee-plan",
- "publicIpNum": 2,
- "status": "ACTIVE"
}
]
}Get Plan Details
Get a Plan resource.
Authorizations:
path Parameters
| plan_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ |
header Parameters
| X-Auth-Token required | string ^[a-fA-F0-9]{32}$ The keystone token. |
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found
500
Internal Server Error
get/v1/plans/{plan_id}
https://api.ntt.com/dsigw-erg/v1/plans/{plan_id}
Response samples
- 200
- 400
- 401
- 404
- 500
Content type
application/json
Copy
Expand all Collapse all {- "plan": {
- "id": "a564678f-75c7-4ce4-a411-e869fd0f5016",
- "name": "Small-BE",
- "description": "small-besteffort-plan",
- "publicIpNum": 1,
- "status": "ACTIVE"
}
}