専有エンドポイント：DescribeDEPInstances
処理概要
専有エンドポイントの情報を取得します。
このAPIはページングをサポートしています。
リクエストパラメーター
| 要素名 | 説明 | 必須 | 値 | 最大値 | デフォルト値 | 備考 |
|---|---|---|---|---|---|---|
| DEPInstanceIdentifier | 専有エンドポイント名
|
文字列 | - | - |
レスポンス
XML
status
statusは共通の応答メッセージを返却します。
result
| 要素名 | 説明 | 値 | 備考 |
|---|---|---|---|
| DescribeDEPInstancesResponse | ルート | − | |
| DescribeDEPInstancesResult | 結果 | − | |
| DEPInstances | 専有エンドポイントリスト | − | |
| 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.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.InvalidParameterNotFound.DEPInstance | DEPInstance aaaa not found. | Sender | 404 | 存在しないDEPInstanceIdentifierを指定した場合 |
| Client.InvalidParameterTooLong.DEPInstanceIdentifier | The parameter DEPInstanceIdentifier is not a valid identifier because it is longer than 63 characters. | Sender | 400 | DEPInstanceIdentifierに63文字を超える値を入力した場合 |
リクエストサンプル
https://jp-east-1.dep.api.nifcloud.com/
?Action=DescribeDEPInstances
&DEPInstanceIdentifier=example-dep-server
&SignatureVersion=2
&SignatureMethod=HmacSHA256
&Timestamp=2017-11-15T00%3A00%3A00.000Z
&AWSAccessKeyId=<Nifty Cloud Access Key ID>
&Signature=<Signature>
レスポンスサンプル
<DescribeDEPInstancesResponse>
<DescribeDEPInstancesResult>
<DEPInstances>
<DEPInstance>
<AvailabilityZone>east-13</AvailabilityZone>
<DEPInstanceIdentifier>mydepinstance</DEPInstanceIdentifier>
<DEPInstanceDescription>myDep</DEPInstanceDescription>
<DEPInstanceStatus>available</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>
</DescribeDEPInstancesResult>
<ResponseMetadata>
<RequestId>a7151a09-0684-4f41-9f82-2883a096907f</RequestId>
</ResponseMetadata>
</DescribeDEPInstancesResponse>
