専有エンドポイント:ModifyDEPInstance
処理概要
専有エンドポイントの設定を変更します。
一度に複数の設定を変更することができます。
リクエストパラメーター
要素名 | 説明 | 必須 | 値 | 最大値 | デフォルト値 | 備考 |
---|---|---|---|---|---|---|
DEPInstanceIdentifier | 専有エンドポイント名
|
○ | 文字列 | - | - | |
DEPSecurityGroups.member.N | 専有エンドポイントFWグループのリスト
|
文字列 | - | - | この値の変更は専有エンドポイントの停止が発生しません。 | |
NewDEPInstanceIdentifier | 新しい専有エンドポイント名
|
文字列 | - | - | この値の変更は専有エンドポイントの停止が発生しません。 | |
DEPInstanceDescription | 専有エンドポイントの説明
|
文字列 | - | - | ||
PrivateAddress | 変更先のプライベートIPアドレス | 文字列 | - | - | ||
NetworkId | 変更先のプライベートLANのネットワークユニークIDプライベートLANの「net-」で始まるネットワークIDを指定してください。 | 文字列 | - | - |
レスポンス
XML
status
statusは共通の応答メッセージを返却します。
result
要素名 | 説明 | 値 | 備考 |
---|---|---|---|
ModifyDEPInstanceResponse | ルート | − | |
ModifyDEPInstanceResult | 結果 | − | |
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 | 文字列 | VLAN変更の場合は変更先のNetworkId |
ServiceName | 専有エンドポイントの接続先サービス名 | 文字列 | |
ResponseMetadata | 共通メタ | - |
エラー
コード | メッセージ | タイプ | HTTPステータスコード | 説明 |
---|---|---|---|---|
Client.InvalidParameterCannotSpecify.DEPSecurityGroupName | DEPSecurityGroupName must not contain leading or trailing spaces. | Sender | 400 | DEPSecurityGroups.member.Nの最初か最後に " " を入力した場合 |
Client.InvalidParameterCannotSpecify.NetworkId | Invalid PrivateAddress: net-COMMON_PRIVATE. | Sender | 400 | 指定できないNetWorkIdを指定した場合 |
Client.InvalidParameterDuplicate.DEPInstanceIdentifier | DEPInstance already exists. | Sender | 400 | すでに存在するIDをNewDEPInstanceIdentifierに指定した場合 |
Client.InvalidParameterDuplicate.PrivateAddress | Private address is already in use: 192.168.98.160. | Sender | 400 |
|
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.DEPInstanceIdentifier | The parameter NewDEPInstanceIdentifier 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 | NewDEPInstanceIdentifierに無効な値(@、全角文字等)を指定した場合 |
Client.InvalidParameterFormat.PrivateAddress | Invalid PrivateAddress aaa.bbb.ccc.ddd. | Sender | 400 | PrivateAddressに許可されないIPアドレスを指定したとき |
Client.InvalidParameterMissing.NetworkId | The parameter NetworkId must be provided and must not be blank. | Sender | 400 | PrivateAddressが指定されたかつNetworkIdが指定されてない場合 |
Client.InvalidParameterMissing.PrivateAddress | The parameter PrivateAddress must be provided and must not be blank. | Sender | 400 | NetworkIdを指定したが、PrivateAddressを指定しなかった場合 |
Client.InvalidParameterNotFound.DEPInstance | DEPInstance aaaa not found. | Sender | 404 | 存在しないIDをDEPInstanceIdentifierに指定した場合 |
Client.InvalidParameterNotFound.DEPSecurityGroup | DEPSecurityGroup aaaa not found. | Sender | 404 | 存在しないファイアウォールグループを DEPSecurityGroups.member.Nに指定した場合 |
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 |
|
Client.InvalidParameterRequired.DEPInstanceIdentifier | The parameter DEPInstanceIdentifier must be provided and must not be blank. | Sender | 400 | 必須のDEPInstanceIdentifierを指定しなかった場合 |
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.InvalidParameterTooLong.DEPInstanceIdentifier | The parameter NewDEPInstanceIdentifier is not a valid identifier because it is longer than 63 characters. | Sender | 400 | NewDEPInstanceIdentifierに63文字を超える値を入力した場合 |
Client.ResourceIncorrectState.DEPInstance.Unavailable | The specified DEPInstance is not in the modifiable state. | Sender | 400 | 専有エンドポイントの状態がavailableでない場合 |
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 | 400 | 指定されたゾーンと異なるゾーンに所属するNetworkIdを指定した場合 |
リクエストサンプル
https://jp-east-1.dep.api.nifcloud.com/
?Action=ModifyDEPInstance
&DEPInstanceIdentifier=example-dep-server
&SignatureVersion=2
&SignatureMethod=HmacSHA256
&Timestamp=2017-11-15T00%3A00%3A00.000Z
&AWSAccessKeyId=<Nifty Cloud Access Key ID>
&Signature=<Signature>
レスポンスサンプル
<ModifyDEPInstanceResponse>
<ModifyDEPInstanceResult>
<DEPInstance>
<AvailabilityZone>east-13</AvailabilityZone>
<DEPInstanceIdentifier>example-dep-server</DEPInstanceIdentifier>
<DEPInstanceDescription>myDep</DEPInstanceDescription>
<DEPInstanceStatus>modifying</DEPInstanceStatus>
<DEPSecurityGroups>
<DEPSecurityGroup>
<DEPSecurityGroupName>default.east-13</DEPSecurityGroupName>
<Status>available</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>
</ModifyDEPInstanceResult>
<ResponseMetadata>
<RequestId>6b76d499-add9-4ab7-9b94-89d5b03289d4</RequestId>
</ResponseMetadata>
</ModifyDEPInstanceResponse>