Arcserve Cloud Direct API (1.0.0)

Download OpenAPI specification:Download

API Reference for Arcserve Cloud Direct Menu

Revision History

Date	Version	Detail
2023/03/23	1.0.0	Initial Release

Authentication

Arcserve Cloud Direct

Arcserve Cloud Direct Menu

List Licenses

path Parameters

tenant_id

required

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

Example: cab37c0a5c40450d9038463783b7d53e

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/v1/arcserve-ucd/{tenant_id}/licenses

https://api.ntt.com/sdpf-soy/v1/arcserve-ucd/{tenant_id}/licenses

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"page": 1,
"per_page": 30,
"total_count": 2,
"licenses": 
[
{"id": "c79a3d51-b6bb-4d2b-a295-7080ba77eef6",
"name": "Sample Active License",
"email_address": "user1@example.com",
"arcserve_business_continuity_cloud_login_mail_address": "user2@example.com",
"status": "Active",
"tenant_id": "c9a8c3e852f64840a67528d259880bad",
"plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
"plan_name_ja": "100GB",
"plan_name_en": "100GB",
"plan_quantity": 2,
"plan_quantity_before_change": 1,
"offer_start_request_date": "2022-07-15",
"offer_start_date": "2022-07-15",
"plan_quantity_change_request_date": "2022-08-10",
"plan_quantity_change_date": "2022-08-10",
"deletion_date": null,
"created_at": "2022-07-01T14:15:22Z",
"updated_at": "2022-08-09T14:15:22Z",
"orders": 
[
{"order_id": "123456",
"fulfillment_id": "123456789",
"issued_at": "2022-07-14T14:15:22Z"
},
{"order_id": "654321",
"fulfillment_id": "987654321",
"issued_at": "2022-08-09T14:15:22Z"
}
]
},
{"id": "6e5ecdf9-730a-8fca-01b1-362eca3f40a4",
"name": "Sample Under Review License",
"email_address": "user1@example.com",
"arcserve_business_continuity_cloud_login_mail_address": "user2@example.com",
"status": "Under Review",
"tenant_id": "c9a8c3e852f64840a67528d259880bad",
"plan_id": "c855badc-4446-7f84-2b6b-f1bcd759cd6e",
"plan_name_ja": "1TB",
"plan_name_en": "1TB",
"plan_quantity": 5,
"plan_quantity_before_change": null,
"offer_start_request_date": "2022-07-15",
"offer_start_date": null,
"plan_quantity_change_request_date": null,
"plan_quantity_change_date": null,
"deletion_date": null,
"created_at": "2022-07-01T14:15:22Z",
"updated_at": "2022-07-01T14:15:22Z",
"orders": [ ]
}
]
}

Create License

path Parameters

tenant_id

required

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

Example: cab37c0a5c40450d9038463783b7d53e

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/v1/arcserve-ucd/{tenant_id}/licenses

https://api.ntt.com/sdpf-soy/v1/arcserve-ucd/{tenant_id}/licenses

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"license": 
{"name": "Sample License",
"email_address": "user1@example.com",
"arcserve_business_continuity_cloud_login_mail_address": "user2@example.com",
"plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
"plan_quantity": 1,
"offer_start_request_date": "2022-07-15"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"license": 
{"id": "b6a508c5-701c-43f2-a450-13e9d18d8e63",
"name": "Sample License",
"email_address": "user1@example.com",
"arcserve_business_continuity_cloud_login_mail_address": "user2@example.com",
"status": "Under Review",
"tenant_id": "c9a8c3e852f64840a67528d259880bad",
"plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
"plan_name_ja": "100GB",
"plan_name_en": "100GB",
"plan_quantity": 1,
"plan_quantity_before_change": null,
"offer_start_request_date": "2022-07-15",
"offer_start_date": null,
"plan_quantity_change_request_date": null,
"plan_quantity_change_date": null,
"deletion_date": null,
"created_at": "2019-07-01T14:15:22Z",
"updated_at": "2019-07-01T14:15:22Z",
"orders": [ ]
}
}

Update License

path Parameters

license_id required	string <uuid> License ID
tenant_id required	string ^[0-9a-f]{32}$ Example: cab37c0a5c40450d9038463783b7d53e 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 only name and email_address are updated

202

Accepted if properties other than name and email_address are updated

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

patch/v1/arcserve-ucd/{tenant_id}/licenses/{license_id}

https://api.ntt.com/sdpf-soy/v1/arcserve-ucd/{tenant_id}/licenses/{license_id}

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all


{"license": 
{"name": "Sample License",
"email_address": "user@example.com",
"plan_quantity": 2,
"plan_quantity_change_request_date": "2022-08-10"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"license": 
{"id": "2f380d88-c58b-4bea-b611-fe4d1f3e1eae",
"name": "Sample License",
"email_address": "user1@example.com",
"arcserve_business_continuity_cloud_login_mail_address": "user2@example.com",
"status": "Active",
"tenant_id": "c9a8c3e852f64840a67528d259880bad",
"plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
"plan_name_ja": "100GB",
"plan_name_en": "100GB",
"plan_quantity": 2,
"plan_quantity_before_change": 1,
"offer_start_request_date": "2022-07-15",
"offer_start_date": "2022-07-15",
"plan_quantity_change_request_date": "2022-08-10",
"plan_quantity_change_date": "2022-08-10",
"deletion_date": null,
"created_at": "2022-07-01T14:15:22Z",
"updated_at": "2022-08-09T14:15:22Z",
"orders": 
[
{"order_id": "123456",
"fulfillment_id": "123456789",
"issued_at": "2022-07-14T14:15:22Z"
},
{"order_id": "654321",
"fulfillment_id": "987654321",
"issued_at": "2022-08-09T14:15:22Z"
}
]
}
}

Delete License

path Parameters

license_id required	string <uuid> License ID
tenant_id required	string ^[0-9a-f]{32}$ Example: cab37c0a5c40450d9038463783b7d53e 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/v1/arcserve-ucd/{tenant_id}/licenses/{license_id}

https://api.ntt.com/sdpf-soy/v1/arcserve-ucd/{tenant_id}/licenses/{license_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"license": 
{"id": "9231fa9f-ff03-4030-91ff-e9d583e4f446",
"name": "Sample License",
"email_address": "user1@example.com",
"arcserve_business_continuity_cloud_login_mail_address": "user2@example.com",
"status": "Delete Order Under Review",
"tenant_id": "c9a8c3e852f64840a67528d259880bad",
"plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
"plan_name_ja": "100GB",
"plan_name_en": "100GB",
"plan_quantity": 2,
"plan_quantity_before_change": 1,
"offer_start_request_date": "2022-07-15",
"offer_start_date": "2022-07-15",
"plan_quantity_change_request_date": "2022-08-10",
"plan_quantity_change_date": "2022-08-10",
"deletion_date": null,
"created_at": "2022-07-01T14:15:22Z",
"updated_at": "2022-09-20T14:15:22Z",
"orders": 
[
{"order_id": "123456",
"fulfillment_id": "123456789",
"issued_at": "2022-07-14T14:15:22Z"
},
{"order_id": "654321",
"fulfillment_id": "987654321",
"issued_at": "2022-08-09T14:15:22Z"
}
]
}
}

Show License

path Parameters

license_id required	string <uuid> License ID
tenant_id required	string ^[0-9a-f]{32}$ Example: cab37c0a5c40450d9038463783b7d53e 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/v1/arcserve-ucd/{tenant_id}/licenses/{license_id}

https://api.ntt.com/sdpf-soy/v1/arcserve-ucd/{tenant_id}/licenses/{license_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"license": 
{"id": "2f380d88-c58b-4bea-b611-fe4d1f3e1eae",
"name": "Sample License",
"email_address": "user1@example.com",
"arcserve_business_continuity_cloud_login_mail_address": "user2@example.com",
"status": "Active",
"tenant_id": "c9a8c3e852f64840a67528d259880bad",
"plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
"plan_name_ja": "100GB",
"plan_name_en": "100GB",
"plan_quantity": 2,
"plan_quantity_before_change": 1,
"offer_start_request_date": "2022-07-15",
"offer_start_date": "2022-07-15",
"plan_quantity_change_request_date": "2022-08-10",
"plan_quantity_change_date": "2022-08-10",
"deletion_date": null,
"created_at": "2022-07-01T14:15:22Z",
"updated_at": "2022-08-09T14:15:22Z",
"orders": 
[
{"order_id": "123456",
"fulfillment_id": "123456789",
"issued_at": "2022-07-14T14:15:22Z"
},
{"order_id": "654321",
"fulfillment_id": "987654321",
"issued_at": "2022-08-09T14:15:22Z"
}
]
}
}

Show Shortest Delivery Date

path Parameters

tenant_id

required

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

Example: cab37c0a5c40450d9038463783b7d53e

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/v1/arcserve-ucd/{tenant_id}/shortest-delivery-date

https://api.ntt.com/sdpf-soy/v1/arcserve-ucd/{tenant_id}/shortest-delivery-date

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"shortest_delivery_date": "2019-08-24"
}

List Plans

path Parameters

tenant_id

required

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

Example: cab37c0a5c40450d9038463783b7d53e

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/v1/arcserve-ucd/{tenant_id}/plans

https://api.ntt.com/sdpf-soy/v1/arcserve-ucd/{tenant_id}/plans

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"page": 1,
"per_page": 30,
"total_count": 2,
"plans": 
[
{"id": "e9435c34-6f04-426f-8644-e4fab2e99ca4",
"name_en": "100GB",
"name_ja": "100GB",
"status": "Active",
"unit": "100GB",
"minimum_quantity": 1,
"maximum_quantity": 9
},
{"id": "0de39f1c-421f-4fdf-8d56-0c993998570f",
"name_en": "1TB",
"name_ja": "1TB",
"status": "Suspended",
"unit": "1TB",
"minimum_quantity": 1,
"maximum_quantity": 100
}
]
}

Show Plan

path Parameters

tenant_id required	string ^[0-9a-f]{32}$ Example: cab37c0a5c40450d9038463783b7d53e 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/v1/arcserve-ucd/{tenant_id}/plans/{plan_id}

https://api.ntt.com/sdpf-soy/v1/arcserve-ucd/{tenant_id}/plans/{plan_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"plan": 
{"id": "311e76fb-ed88-4352-b175-a432c7a03d00",
"name_en": "100GB",
"name_ja": "100GB",
"status": "Active",
"unit": "100GB",
"minimum_quantity": 1,
"maximum_quantity": 9
}
}