専有エンドポイント：CreateDEPInstance
処理概要
専有エンドポイントを新規作成します。
リクエストパラメーター
| 要素名 | 説明 | 必須 | 値 | 最大値 | デフォルト値 | 備考 |
|---|---|---|---|---|---|---|
| AvailabilityZone | 専有エンドポイントが作成されるゾーン指定可能なゾーンについては、ニフクラ ゾーン別機能対応表をご参照ください。 | ○ | 文字列 | - | - | |
| DEPInstanceIdentifier | 専有エンドポイント名
|
○ | 文字列 | - | - | |
| DEPInstanceDescription | 専有エンドポイントの説明
|
文字列 | - | - | ||
| DEPSecurityGroups.member.N | 専有エンドポイントFWグループのリスト
|
文字列 | - | プロトコルのDefaultSecurityGroup | ||
| NetworkId | プライベートLANのネットワークユニークID | ○※ | 文字列 | - | - | プライベートLAN使用のみなので必須 |
| PrivateAddress | プライベートIPアドレス | ○※ | 文字列 | - | - | プライベートLAN使用のみなので必須 |
| ServiceName | 専有エンドポイントの接続先サービス名 値：com.nifcloud.jp-east-2.storage.api | com.nifcloud.jp-west-1.storage.api | com.nifty.cloud.jp-east-2.os | com.nifty.cloud.jp-west-1.os |
○ | 文字列 | - | - |
レスポンス
XML
status
statusは共通の応答メッセージを返却します。
result
| 要素名 | 説明 | 値 | 備考 |
|---|---|---|---|
| CreateDEPInstanceResponse | ルート | − | |
| CreateDEPInstanceResult | 結果 | − | |
| DEPInstance | 専有エンドポイント | − | |
| AvailabilityZone | 専有エンドポイントのゾーン | 文字列 | |
| DEPInstanceIdentifier | 専有エンドポイント名 | 文字列 | |
| DEPInstanceDescription | 専有エンドポイントの説明 | 文字列 | |
| DEPInstanceStatus | 専有エンドポイントのステータス | 文字列 | |
| DEPInstanceErrorInfo | 専有エンドポイントのエラー情報 | 文字列 | 専有エンドポイントのステータスがfailedの場合に返却 |
| DEPInstanceErrorCode | 発生中のエラーコード | 文字列 | |
| DEPInstanceErrorMessage | 発生中のエラーメッセージ | 文字列 | |
| DEPSecurityGroups | 専有エンドポイントFWグループ情報リスト | リスト | |
| DEPSecurityGroup | 専有エンドポイントFWグループ | − | |
| DEPSecurityGroupName | 専有エンドポイントFWグループ名 | 文字列 | |
| Status | 専有エンドポイントFWグループのステータス | 文字列 | |
| Endpoint | connectionのエンドポイント | − | |
| PrivateAddress | プライベートIPアドレス | 文字列 | |
| CreateTime | 専有エンドポイントの作成日時 | 日時 | |
| NetworkId | プライベートLANのネットワークID | 文字列 | |
| ServiceName | 専有エンドポイントの接続先サービス名 | 文字列 | |
| ResponseMetadata | 共通メタ | - |
エラー
| コード | メッセージ | タイプ | HTTPステータスコード | 説明 |
|---|---|---|---|---|
| Client.InvalidParameterCannotSpecify.DEPSecurityGroupName | DEPSecurityGroupName must not contain leading or trailing spaces. | Sender | 400 | DEPSecurityGroups.member.Nの最初か最後に " " を入力した場合 |
| Client.InvalidParameterCannotSpecify.NetworkId | Invalid NetWorkId: net-COMMON_PRIVATE. | Sender | 400 | 指定できないNetWorkIdを指定した場合 |
| Client.InvalidParameterDuplicate.DEPInstanceIdentifier | DEPInstance already exists. | Sender | 400 | すでに存在するDEPInstanceIdentifierを指定した場合 |
| Client.InvalidParameterDuplicate.PrivateAddress | Private address is already in use: 192.168.98.160. | Sender | 400 | PrivateAddressに重複しているIPアドレスを指定したとき |
| Client.InvalidParameterFormat.DEPInstanceIdentifier | The parameter DEPInstanceIdentifier is not a valid identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens. | Sender | 400 | DEPInstanceIdentifierに無効な値(@、全角文字等)を指定した場合 |
| Client.InvalidParameterFormat.PrivateAddress | Invalid PrivateAddress aaa.bbb.ccc.ddd. | Sender | 400 | PrivateAddressに許可されないIPアドレスを指定したとき |
| Client.InvalidParameterIllegalInput.AvailabilityZone | aaa is not a valid availability zone. | Sender | 400 | 存在しないAvailabilityZoneを指定した場合 |
| Client.InvalidParameterIllegalInput.ServiceName | ServiceName aaaa not found. | Sender | 400 | ServiceNameに有効でない値を指定した場合 |
| Client.InvalidParameterNotFound.DEPSecurityGroup | DEPSecurityGroup aaaa not found. | Sender | 404 | 存在しないDEPSecurityGroupを指定した場合 |
| Client.InvalidParameterNotFound.NetworkId | Private LAN net-1234abcd does not exist. | Sender | 404 | 存在しないNetWorkIdを指定した場合 |
| Client.InvalidParameterOutOfRange.PrivateAddress | Invalid PrivateAddress: 192.168.128.31. Valid range is 192.168.128.1-192.168.128.30. | Sender | 400 | PrivateAddressにサブネットの範囲外のIPアドレスを指定したとき |
| Client.InvalidParameterRequired.AvailabilityZone | AvailabilityZone is required when using Private LAN. | Sender | 400 | VLAN対象インスタンスでAvailabilityZoneを指定していない場合 |
| Client.InvalidParameterRequired.DEPInstanceIdentifier | The parameter DEPInstanceIdentifier must be provided and must not be blank. | Sender | 400 | 必須のDEPInstanceIdentifierを指定しなかった場合 |
| Client.InvalidParameterRequired.NetworkId | The parameter NetworkId must be provided and must not be blank. | Sender | 400 | 必須のNetworkIdを指定しなかった場合 |
| Client.InvalidParameterRequired.PrivateAddress | The parameter PrivateAddress must be provided and must not be blank. | Sender | 400 | VLAN対象インスタンスで PrivateAddressを指定していない場合 |
| Client.InvalidParameterRequired.ServiceName | The parameter ServiceName must be provided and must not be blank. | Sender | 400 | 必須のServiceNameを指定しなかった場合 |
| Client.InvalidParameterTooLong.DEPInstanceDescription | The parameter DEPInstanceDescription is not a valid identifier because it is longer than 255 characters. | Sender | 400 | DEPInstanceDescriptionに255文字を超える値を入力した場合 |
| Client.InvalidParameterTooLong.DEPInstanceIdentifier | The parameter DEPInstanceIdentifier is not a valid identifier because it is longer than 63 characters. | Sender | 400 | DEPInstanceIdentifierに63文字を超える値を入力した場合 |
| Client.LimitExceeded.NumberOfDEPInstance | Request would result in user exceeding the allowed number of DEPInstance. | Sender | 400 | 作成可能な専有エンドポイントの個数に達している場合 |
| Client.ResourceIncorrectState.DEPSecurityGroup.Processing | DEPSecurityGroup is not in available state. | Sender | 400 | 設定しようとした専有エンドポイントFWグループのルールのうち、ステータスが、「authorizing」または「revoking」のルールが存在する場合 |
| Client.ZoneMisMatch.DEPInstance.and.DEPSecurityGroup | DEPSecurityGroup aaa cannot be used in east-11 zone. The availability zone of aaa is east-12. | Sender | 400 | 指定されたゾーンと異なるゾーンに所属する専有エンドポイントFWグループを指定した場合 |
| Client.ZoneMisMatch.DEPInstance.and.NetworkId | Private LAN net-1234abcd does not belong to availability zone east-11. | Sender | 404 | 指定されたゾーンと異なるゾーンに所属するNetworkIdを指定した場合 |
リクエストサンプル
https://jp-east-1.dep.api.nifcloud.com/
?Action=CreateDEPInstance
&?AvailabilityZone=east-13
&DEPInstanceIdentifier=mydepinstance
&DEPInstanceDescription=myDep
&DEPSecurityGroups.member.1=mydepsecuritygroup
&NetworkId=net-xxxxxxxx
&PrivateAddress=192.168.12.123
&ServiceName=com.nifcloud.jp-east-2.storage.api
&SignatureVersion=2
&SignatureMethod=HmacSHA256
&Timestamp=2017-11-15T00%3A00%3A00.000Z
&AWSAccessKeyId=<Nifty Cloud Access Key ID>
&Signature=<Signature>
レスポンスサンプル
<CreateDEPInstanceResponse>
<CreateDEPInstanceResult>
<DEPInstance>
<AvailabilityZone>east-13</AvailabilityZone>
<DEPInstanceIdentifier>mydepinstance</DEPInstanceIdentifier>
<DEPInstanceDescription>myDep</DEPInstanceDescription>
<DEPInstanceStatus>creating</DEPInstanceStatus>
<DEPInstanceErrorInfo/>
<DEPSecurityGroups>
<DEPSecurityGroup>
<DEPSecurityGroupName>default.east-13</DEPSecurityGroupName>
<Status>active</Status>
</DEPSecurityGroup>
</DEPSecurityGroups>
<Endpoint>
<PrivateAddress>192.168.12.123</PrivateAddress>
</Endpoint>
<CreateTime>2017-11-15T00:00:00.000+09:00</CreateTime>
<NetworkId>net-xxxxxxxx</NetworkId>
<ServiceName>com.nifcloud.jp-east-2.storage.api</ServiceName>
</DEPInstance>
</CreateDEPInstanceResult>
<ResponseMetadata>
<RequestId>6ce7784f-9696-4c84-adbb-d253fca05975</RequestId>
</ResponseMetadata>
</CreateDEPInstanceResponse>
