Oracle API (2.0.0)

Download OpenAPI specification:Download

API Reference for Oracle Menu

Revision History

Date	Version	Detail
2023/03/23	2.0.0	Change path composition
2023/01/10	1.0.0	Initial Release

Authentication

Oracle

Oracle Menu

List Licenses

path Parameters

tenant_id

required

string ^[0-9a-f]{32}$

Example: 61f1c040261d4344a6d09ed1a11aeffe

Tenant ID in gl1 region

query Parameters

page	integer >= 1 Default: 1 Page number of the results to fetch
per_page	integer [ 1 .. 100 ] Default: 30 Results per page

header Parameters

X-Auth-Token

required

string

Example: e1b37cb197d84e69af37264fc0f167a33

Authentication token generated by Keystone

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v2/oracle/{tenant_id}/licenses

https://api.ntt.com/sdpf-soy/v2/oracle/{tenant_id}/licenses

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"page": 1,
"per_page": 30,
"total_count": 2,
"licenses": 
[
{"id": "88716eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Sample Physical License",
"email_address": "user@example.com",
"status": "Deleted",
"plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
"plan_name_ja": "Oracle SE2 for General Purpose 1 v1 (1 Processor License 相当)",
"plan_name_en": "Oracle SE2 for General Purpose 1 v1 (1 Processor License Equivalent)",
"region": "jp1",
"tenant_id": "b68871ca03e24ba5a8748bfbaaa717ae",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-11-24T14:15:22Z",
"offer_start_date": "2019-08-24",
"deletion_date": "2019-11-24",
"servers": 
[
{"id": "1ba26d63-9128-469e-8cbe-9310e4431109",
"status": "Deleted"
}
]
},
{"id": "6109a773-2ff3-4fe6-8c77-bc3cdaaa2c62",
"name": "Sample vCPU License",
"email_address": "user@example.com",
"status": "Change Order Under Review",
"plan_id": "d1bac982-f6f3-4c68-9875-f4a475a2f80e",
"plan_name_ja": "Oracle SE2 - VMのvCPU数 : 1 vCPU",
"plan_name_en": "Oracle SE2 - Number of vCPUs on VM : 1 vCPU",
"region": "jp1",
"tenant_id": "b68871ca03e24ba5a8748bfbaaa717ae",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-11-24T14:15:22Z",
"offer_start_date": "2019-08-24",
"deletion_date": null,
"servers": 
[
{"id": "32b29d94-fc6e-41d8-891a-b23c8263f973",
"status": "Pending Add"
},
{"id": "ccfdb89e-4203-48a1-9233-3d32541995b8",
"status": "Active"
},
{"id": "0cbc74b1-7f88-4a99-854e-b5eef5052a91",
"status": "Pending Delete"
}
]
}
]
}

Create License

path Parameters

tenant_id

required

string ^[0-9a-f]{32}$

Example: 61f1c040261d4344a6d09ed1a11aeffe

Tenant ID in gl1 region

header Parameters

X-Auth-Token

required

string

Example: e1b37cb197d84e69af37264fc0f167a33

Authentication token generated by Keystone

Request Body schema: application/json

license

required

object

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

post/v2/oracle/{tenant_id}/licenses

https://api.ntt.com/sdpf-soy/v2/oracle/{tenant_id}/licenses

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"license": 
{"name": "Sample Physical License",
"email_address": "user@example.com",
"plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
"tenant_id": "b68871ca03e24ba5a8748bfbaaa717ae",
"servers": 
["1ba26d63-9128-469e-8cbe-9310e4431109"
]
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"license": 
{"id": "397f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Sample Physical License",
"email_address": "user@example.com",
"status": "Under Review",
"plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
"plan_name_ja": "Oracle SE2 for General Purpose 1 v1 (1 Processor License 相当)",
"plan_name_en": "Oracle SE2 for General Purpose 1 v1 (1 Processor License Equivalent)",
"region": "jp1",
"tenant_id": "b68871ca03e24ba5a8748bfbaaa717ae",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"offer_start_date": null,
"deletion_date": null,
"servers": 
[
{"id": "32b29d94-fc6e-41d8-891a-b23c8263f973",
"status": "Pending Add"
}
]
}
}

Update License

path Parameters

license_id required	string <uuid> License ID
tenant_id required	string ^[0-9a-f]{32}$ Example: 61f1c040261d4344a6d09ed1a11aeffe Tenant ID in gl1 region

header Parameters

X-Auth-Token

required

string

Example: e1b37cb197d84e69af37264fc0f167a33

Authentication token generated by Keystone

Request Body schema: application/json

license

required

object

Responses

200

OK if successful and servers property is not included in the request body

202

Accepted if successful and servers property is included in the request body

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

patch/v2/oracle/{tenant_id}/licenses/{license_id}

https://api.ntt.com/sdpf-soy/v2/oracle/{tenant_id}/licenses/{license_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"license": 
{"name": "Sample Physical License",
"email_address": "user@example.com",
"servers": 
["1ba26d63-9128-469e-8cbe-9310e4431109"
]
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"license": 
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Sample Physical License",
"email_address": "user@example.com",
"status": "Active",
"plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
"plan_name_ja": "Oracle SE2 for General Purpose 1 v1 (1 Processor License 相当)",
"plan_name_en": "Oracle SE2 for General Purpose 1 v1 (1 Processor License Equivalent)",
"region": "jp1",
"tenant_id": "b68871ca03e24ba5a8748bfbaaa717ae",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-11-24T14:15:22Z",
"offer_start_date": "2019-08-24",
"deletion_date": null,
"servers": 
[
{"id": "1ba26d63-9128-469e-8cbe-9310e4431109",
"status": "Active"
}
]
}
}

Delete License

path Parameters

license_id required	string <uuid> License ID
tenant_id required	string ^[0-9a-f]{32}$ Example: 61f1c040261d4344a6d09ed1a11aeffe Tenant ID in gl1 region

header Parameters

X-Auth-Token

required

string

Example: e1b37cb197d84e69af37264fc0f167a33

Authentication token generated by Keystone

Responses

202

Accepted

204

No Content (Only if license status is Send Back)

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

delete/v2/oracle/{tenant_id}/licenses/{license_id}

https://api.ntt.com/sdpf-soy/v2/oracle/{tenant_id}/licenses/{license_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"license": 
{"id": "777f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Sample Physical License",
"email_address": "user@example.com",
"status": "Delete Order Under Review",
"plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
"plan_name_ja": "Oracle SE2 for General Purpose 1 v1 (1 Processor License 相当)",
"plan_name_en": "Oracle SE2 for General Purpose 1 v1 (1 Processor License Equivalent)",
"region": "jp1",
"tenant_id": "b68871ca03e24ba5a8748bfbaaa717ae",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-11-24T14:15:22Z",
"offer_start_date": "2019-08-24",
"deletion_date": null,
"servers": 
[
{"id": "1ba26d63-9128-469e-8cbe-9310e4431109",
"status": "Pending Delete"
}
]
}
}

Show License

path Parameters

license_id required	string <uuid> License ID
tenant_id required	string ^[0-9a-f]{32}$ Example: 61f1c040261d4344a6d09ed1a11aeffe Tenant ID in gl1 region

header Parameters

X-Auth-Token

required

string

Example: e1b37cb197d84e69af37264fc0f167a33

Authentication token generated by Keystone

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v2/oracle/{tenant_id}/licenses/{license_id}

https://api.ntt.com/sdpf-soy/v2/oracle/{tenant_id}/licenses/{license_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"license": 
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Sample Physical License",
"email_address": "user@example.com",
"status": "Active",
"plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
"plan_name_ja": "Oracle SE2 for General Purpose 1 v1 (1 Processor License 相当)",
"plan_name_en": "Oracle SE2 for General Purpose 1 v1 (1 Processor License Equivalent)",
"region": "jp1",
"tenant_id": "b68871ca03e24ba5a8748bfbaaa717ae",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-11-24T14:15:22Z",
"offer_start_date": "2019-08-24",
"deletion_date": null,
"servers": 
[
{"id": "1ba26d63-9128-469e-8cbe-9310e4431109",
"status": "Active"
}
]
}
}

List Plans

path Parameters

tenant_id

required

string ^[0-9a-f]{32}$

Example: 61f1c040261d4344a6d09ed1a11aeffe

Tenant ID in gl1 region

query Parameters

page	integer >= 1 Default: 1 Page number of the results to fetch
per_page	integer [ 1 .. 100 ] Default: 30 Results per page

header Parameters

X-Auth-Token

required

string

Example: e1b37cb197d84e69af37264fc0f167a33

Authentication token generated by Keystone

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v2/oracle/{tenant_id}/plans

https://api.ntt.com/sdpf-soy/v2/oracle/{tenant_id}/plans

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"page": 1,
"per_page": 30,
"total_count": 2,
"plans": 
[
{"id": "00713021-9aea-41da-9a88-87760c08fa72",
"type": "physical",
"name_en": "Oracle SE2 for General Purpose 1 v1 (1 Processor License Equivalent)",
"name_ja": "Oracle SE2 for General Purpose 1 v1 (1 Processor License 相当)",
"edition": "SE2",
"status": "Active",
"flavor": "General Purpose 1 v1",
"minimum_number_of_vcpus": null,
"maximum_number_of_vcpus": null
},
{"id": "d1bac982-f6f3-4c68-9875-f4a475a2f80e",
"type": "vcpu",
"name_en": "Oracle EE (High-end) - Number of vCPUs on VM : 33 ~ 36 vCPU",
"name_ja": "Oracle EE (High-end) - VMのvCPU数 : 33 ~ 36 vCPU",
"edition": "EE (High-end)",
"status": "Suspended",
"flavor": null,
"minimum_number_of_vcpus": 33,
"maximum_number_of_vcpus": 36
}
]
}

Show Plan

path Parameters

tenant_id required	string ^[0-9a-f]{32}$ Example: 61f1c040261d4344a6d09ed1a11aeffe Tenant ID in gl1 region
plan_id required	string <uuid> Plan ID

header Parameters

X-Auth-Token

required

string

Example: e1b37cb197d84e69af37264fc0f167a33

Authentication token generated by Keystone

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v2/oracle/{tenant_id}/plans/{plan_id}

https://api.ntt.com/sdpf-soy/v2/oracle/{tenant_id}/plans/{plan_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"plan": 
{"id": "00713021-9aea-41da-9a88-87760c08fa72",
"type": "physical",
"name_en": "Oracle SE2 for General Purpose 1 v1 (1 Processor License Equivalent)",
"name_ja": "Oracle SE2 for General Purpose 1 v1 (1 Processor License 相当)",
"edition": "SE2",
"status": "Active",
"flavor": "General Purpose 1 v1",
"minimum_number_of_vcpus": null,
"maximum_number_of_vcpus": null
}
}

List Regions

path Parameters

tenant_id

required

string ^[0-9a-f]{32}$

Example: 61f1c040261d4344a6d09ed1a11aeffe

Tenant ID in gl1 region

header Parameters

X-Auth-Token

required

string

Example: e1b37cb197d84e69af37264fc0f167a33

Authentication token generated by Keystone

Responses

200

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v2/oracle/{tenant_id}/regions

https://api.ntt.com/sdpf-soy/v2/oracle/{tenant_id}/regions

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"regions": 
["jp1",
"jp2",
"jp4",
"jp5",
"jp6",
"jp7",
"jp8"
]
}