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

IP アドレス管理 (IPAM) のスコープを作成し、プライベートおよびパブリック IP アドレスを管理します。

今すぐお試しください

この 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:CreateIpamScope

create

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	IPAM インスタンスがデプロイされているリージョンの ID。 DescribeRegions 操作を呼び出して、リージョン ID を取得します。	cn-hangzhou
IpamId	string	必須	IPAM インスタンスの ID。	ipam-ccxbnsbhew0d6t****
IpamScopeName	string	任意	IPAM スコープの名前。名前は 1～128 文字で、`http://` または `https://` で始めることはできません。	test
IpamScopeDescription	string	任意	IPAM スコープの説明。説明は 1～256 文字で、文字で始まる必要があります。 `http://` または `https://` で始めることはできません。デフォルト値は空の文字列です。	test description
ResourceGroupId	string	任意	IPAM スコープが属するリソースグループの ID。	rg-acfmxazb4ph6aiy****
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効な値: true: チェックリクエストを送信しますが、IPAM スコープは作成しません。リクエストは、有効な AccessKey、RAM ユーザーの権限、および必須パラメーターについてチェックされます。チェックが失敗した場合、対応するエラーが返されます。チェックに合格すると、`DryRunOperation` エラーコードが返されます。 false (デフォルト): 通常のリクエストを送信します。リクエストがチェックに合格すると、2xx HTTP ステータスコードが返され、IPAM スコープが作成されます。	false
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントから一意の値を生成します。トークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムはリクエストの RequestId を ClientToken として自動的に使用します。各 API リクエストの RequestId は異なる場合があります。	123e4567-e89b-12d3-a456-426655440000
IpamScopeType	string	任意	IPAM スコープのタイプ: private。説明現在、プライベートスコープのみを作成できます。	private
Tag	array<object>	任意	タグ。
	object	任意	タグ。
Key	string	任意	リソースのタグキー。最大 20 個のタグキーを指定できます。タグキーは空の文字列にすることはできません。タグキーは最大 64 文字です。文字で始まる必要があり、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を含めることができます。タグキーは `aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることはできません。	FinanceDept
Value	string	任意	リソースのタグ値。最大 20 個のタグ値を指定できます。タグ値は空の文字列にすることができます。タグ値は最大 128 文字で、`http://` または `https://` を含めることはできません。	FinanceJoshua

レスポンスフィールド

フィールド	型	説明	例
	object	応答。
RequestId	string	リクエスト ID。	E897D16A-50EB-543F-B002-C5A26AB818FF
IpamScopeId	string	IPAM スコープの ID。	ipam-scope-glfmcyldpm8lsy****

例

成功レスポンス

JSONJSON

{
  "RequestId": "E897D16A-50EB-543F-B002-C5A26AB818FF",
  "IpamScopeId": "ipam-scope-glfmcyldpm8lsy****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	ResourceNotFound.Ipam	The specified resource of ipam is not found.
400	UnsupportedFeature.PublicIpamScopeType	The feature of PublicIpamScopeType is not supported.
400	QuotaExceeded.IpamScopeQuotaPerIpam	The quota of ipamScopeQuotaPerIpam count is exceeded.
400	DryRunOperation	Request validation has been passed with DryRun flag set.

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

変更履歴

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