CheckCanAllocateVpcPrivateIpAddress - Virtual Private Cloud - Alibaba Cloud ドキュメントセンター

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

vpc:CheckCanAllocateVpcPrivateIpAddress

none

*VSwitch

acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	クエリ対象のプライベート IP アドレスが属する vSwitch のリージョン ID です。最新のリージョンリストは、DescribeRegions 操作を呼び出して確認できます。	cn-qingdao
VSwitchId	string	必須	クエリ対象のプライベート IP アドレスが属する vSwitch の ID です。	vsw-m5ew3t46z2drmifnt****
PrivateIpAddress	string	必須	プライベート IP アドレスの利用可能性を確認するには、そのプライベート IP アドレスが VSwitchId パラメーターで指定された vSwitch に属している必要があります。	10.0.0.7
IpVersion	string	任意	プライベート IP アドレスのバージョンです。有効な値は次のとおりです。 ipv4： IPv4 アドレスをクエリする場合は、このパラメーターは省略可能です。 ipv6： IPv6 アドレスをクエリする場合は、このパラメーターは必須です。	ipv4

レスポンスフィールド

フィールド	型	説明	例
	object	スキーマオブジェクト
CanAllocate	boolean	プライベート IP アドレスが利用可能かどうかを示します。有効な値は次のとおりです。 true false	true
RequestId	string	リクエスト ID です。	93360B0-2969-40BF-8542-EBB34FD358AB

例

成功レスポンス

JSONJSON

{
  "CanAllocate": true,
  "RequestId": "93360B0-2969-40BF-8542-EBB34FD358AB"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	PARAMETER_ILLEGAL	Parameter illegal.Parameter is ipVersion
400	ResourceNotFound.VSwitchId	The specified resource vswitch is not found.
400	Mismatch.VSwitchAndPrivateIpAddress	The vswitch and privateIpAddress are mismatched.
400	IllegalParam.PrivateIpAddress	The specified PrivateIpAddress is illegal.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。