KDDIクラウドプラットフォームサービス ナレッジサイト

  • HOME
  • 提供API一覧
  • createSnapshot

createSnapshot

処理概要

スナップショットの作成

 

注意事項

・「listVolumes」で取得する「id」を利用

 

リクエスト

・リクエストパラメータ

Parameter Name Description Required
volumeid The ID of the disk volume true

 

・リクエストサンプル

$ ./kick_api.sh command=createSnapshot volumeid=8c3763b4-6c50-49df-a9fe-ecb53653f1f5
 

 

レスポンス

・レスポンスボディ

Response Name Description
id ID of the snapshot
account the account associated with the snapshot
created the date the snapshot was created
domain the domain name of the snapshot’s account
domainid the domain ID of the snapshot’s account
intervaltype valid types are hourly, daily, weekly, monthy, template, and none.
name name of the snapshot
project the project name of the snapshot
projectid the project id of the snapshot
revertable indicates whether the underlying storage supports reverting the volume to this snapshot
snapshottype the type of the snapshot
state the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating – the snapshot is being allocated on the primary storage; BackingUp – the snapshot is being backed up on secondary storage
volumeid ID of the disk volume
volumename name of the disk volume
volumetype type of the disk volume
zoneid id of the availability zone
tags(*) the list of resource tags associated with snapshot
account the account associated with the tag
customer customer associated with the tag
domain the domain associated with the tag
domainid the ID of the domain associated with the tag
key tag key name
project the project name where tag belongs to
projectid the project id the tag belongs to
resourceid id of the resource
resourcetype resource type
value tag value
jobid the ID of the latest async job acting on this object
jobstatus the current status of the latest async job acting on this object

 

・レスポンスサンプル

【コマンド実行結果】

<?xml version=”1.0″ encoding=”UTF-8″?>
<createsnapshotresponse cloud-stack-version=”4.3.0.2″>
<id>763da263-a632-4c5e-a790-d4d33fb9fc47</id>
<jobid>33379143-1212-458d-943f-1750f744b05a</jobid>
</createsnapshotresponse>

 
【queryAsyncJobResultでの確認結果】

<?xml version=”1.0″ encoding=”UTF-8″?>
<queryasyncjobresultresponse cloud-stack-version=”4.3.0.2″>
<accountid>d344caf5-24dc-4194-ac5f-2d78d5e38039</accountid>
<userid>0212ea46-0529-4250-9e3e-bcb03c114002</userid>
<cmd>org.apache.cloudstack.api.command.user.snapshot.CreateSnapshotCmd</cmd>
<jobstatus>1</jobstatus>
<jobprocstatus>0</jobprocstatus>
<jobresultcode>0</jobresultcode>
<jobresulttype>object</jobresulttype>
<jobresult>
<snapshot>
<id>763da263-a632-4c5e-a790-d4d33fb9fc47</id>
<account>xxxx</account>
<domainid>57edb9da-0279-45f0-842a-d768c4ed0d47</domainid>
<domain>MXXXXXXXX</domain>
<snapshottype>MANUAL</snapshottype>
<volumeid>8c3763b4-6c50-49df-a9fe-ecb53653f1f5</volumeid>
<volumename>ROOT-352140</volumename>
<volumetype>ROOT</volumetype>
<created>2016-09-24T11:15:43+0900</created>
<name>v-TEST01-MXXXXXXXX_ROOT-352140_20160924021543</name>
<intervaltype>MANUAL</intervaltype>
<state>BackedUp</state>
<revertable>false</revertable>
</snapshot>
</jobresult>
<created>2016-09-24T11:15:43+0900</created>
<jobid>33379143-1212-458d-943f-1750f744b05a</jobid>
</queryasyncjobresultresponse>

提供API一覧

2022/07/05 2022/07/05