AddAddressBook を呼び出してアドレス帳を作成 - Cloud Firewall - Alibaba Cloud - Cloud Firewall

IPv4 アドレス帳、ECS タグベースのアドレス帳、IPv6 アドレス帳、ドメイン名アドレス帳、ACK アドレス帳を含むアドレス帳を作成します。

操作説明

この操作は、IPv4 アドレス帳、ECS タグベースのアドレス帳、IPv6 アドレス帳、ドメイン名アドレス帳、ACK アドレス帳を含むアドレス帳を作成します。

レート制限

この操作の単一ユーザー QPS 制限は、1 秒あたり 10 回の呼び出しです。制限を超えると、API 呼び出しがスロットリングされ、ビジネスに影響を与える可能性があります。適切な周波数でこの操作を呼び出してください。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

yundun-cloudfirewall:AddAddressBook

create

*AddressBook。

acs:yundun-cloudfirewall::{#accountId}:addressbook/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SourceIp `deprecated`	string	任意	リクエストのソース IP アドレス。	192.0.XX.XX
Lang	string	任意	アドレス帳の説明の言語タイプ。列挙値: en : 英語。 zh : 中国語 (デフォルト)	zh
AddressList	string	任意	アドレス帳内のアドレス。複数のアドレスはコンマ (,) で区切ります。単一のアドレス要素内で、アドレスとその説明をスペースで区切ります。説明このパラメーターは、GroupType が `ip`、`port`、または `domain` に設定されている場合に必須です。 GroupType が `ip` に設定されている場合、アドレスリストに IP アドレスを入力します。例: 192.0.XX.XX/32 Development CIDR ブロック,10.0.0.X/24,192.0.XX.XX/24 Test CIDR ブロック。 GroupType が `port` に設定されている場合、アドレスリストにポートまたはポート範囲を入力します。例: 80 HTTP ポート,100/200,3306 データベースポート。 GroupType が `domain` に設定されている場合、アドレスリストにドメイン名を入力します。例: example.com テストドメイン名,aliyundoc.com,www.aliyun.com Alibaba Cloud 公式ウェブサイト。	192.0.XX.XX/32 ,192.0.XX.XX/24
Description	string	必須	アドレス帳の説明。	sz-001
GroupName	string	必須	アドレス帳の名前。	sz-001
GroupType	string	必須	アドレス帳のタイプ。列挙値: port : ポートアドレス帳。 ackLabel : ACK Pod ラベルアドレス帳。 ipv6 : IPv6 アドレス帳。 ip : IPv4 アドレス帳。 domain : ドメイン名。 ackNamespace : ACK 名前空間アドレス帳。 tag : ECS タグベースのパブリック IP アドレス帳。 tagPrivate : ECS ラベルベースのプライベートエンドポイントアドレス帳。 assetIpv6 : IPv6 パブリックアセットアドレス帳。 asset : IPv4 パブリックアセットアドレス帳。	ip
AutoAddTagEcs	string	任意	指定されたタグに一致する Elastic Compute Service (ECS) インスタンスのパブリック IP アドレスをアドレス帳に自動的に追加するかどうかを示します。列挙値: 0 : 自動的に追加しない (デフォルト)。 1 : 自動的に追加する。	1
TagRelation	string	任意	一致させる複数の ECS タグ間の論理関係。列挙値: or : OR。指定されたラベルのいずれかに一致する Elastic Compute Service (ECS) サービスのインスタンスのパブリック IP アドレスがアドレス帳に追加されます。 and : AND (デフォルト)。インスタンスが指定されたすべてのラベルに一致する場合にのみ、Elastic Compute Service (ECS) サービスのインスタンスのパブリック IP アドレスがアドレス帳に追加されます。	and
TagList	array<object>	任意	ECS タグリスト。
	object	任意	ECS タグ。
TagValue	string	任意	ECS タグの値。	1
TagKey	string	任意	ECS タグのキー。	TXY
AckClusterConnectorId	string	任意	ACK クラスターコネクタ ID。以下の操作から値を取得できます。 DescribeAckClusterConnectors : ACK クラスターコネクタを一覧表示します。	ac-7c1bad6c3cc84c33baab1
AckNamespaces	array	任意	ACK クラスター Pod 名前空間のリスト。説明最大値は 10 個の名前空間です。
	string	任意	ACK クラスター Pod 名前空間。以下の操作から値を取得できます。 DescribeAckClusterNamespaces : ACK クラスター名前空間を一覧表示します。説明このパラメーターは、GroupType が ackNamespace に設定されている場合に必須です。	kube-system
AckLabels	array<object>	任意	ACK クラスター Pod ラベルのリスト。説明最大値は 10 個のラベルです。
	object	任意	ACK クラスター Pod ラベル。以下の操作から値を取得できます。 DescribeAckClusterPodLabels : ACK クラスター Pod ラベルを一覧表示します。説明このパラメーターは、GroupType が ackLabel に設定されている場合に必須です。
Key	string	任意	ACK クラスター Pod ラベルのキー。	app
Value	string	任意	ACK クラスター Pod ラベルの値。	storage-operator
AssetMemberUids	array	任意	アセットアドレス帳のメンバーアカウントのリスト。
	integer	任意	メンバーアカウントのリスト。	13580xxxxxx6271
AssetRegionResourceTypes	array<object>	任意	アセットアドレス帳のリージョンおよびリソースタイプのリスト。
	array<object>	任意	リージョンおよびリソースタイプのリスト。
AssetRegionId	string	任意	アセットのリージョン ID。列挙値: all : すべてのリージョン。	all
ResourceType	object	任意	アセットタイプ。
Ipv4	object	任意	IPv4 アセットタイプ。
SlbEIP	boolean	任意	アセットタイプ: SlbEIP。列挙値: true : 有効。 false : 無効。	true
NatPublicIP	boolean	任意	アセットタイプ: NatPublicIP。列挙値: true : 有効。 false : 無効。	false
BastionHostIngressIP	boolean	任意	アセットタイプ: BastionHostIngressIP。列挙値: true : 有効。 false : 無効。	false
EniEIP	boolean	任意	アセットタイプ: EniEIP。列挙値: true : 有効。 false : 無効。	false
NlbEIP	boolean	任意	アセットタイプ: NlbEIP。列挙値: true : 有効。 false : 無効。	false
ApiGatewayEIP	boolean	任意	アセットタイプ: ApigEIP。列挙値: true : 有効。 false : 無効。	false
EcsPublicIP	boolean	任意	アセットタイプ: EcsPublicIP。列挙値: true : 有効。 false : 無効。	false
BastionHostIP	boolean	任意	アセットタイプ: BastionHostIP。列挙値: true : 有効。 false : 無効。	false
BastionHostEgressIP	boolean	任意	アセットタイプ: BastionHostEgressIP。列挙値: true : 有効。 false : 無効。	false
AlbEIP	boolean	任意	アセットタイプ: AlbEIP。列挙値: true : 有効。 false : 無効。	false
GaEIP	boolean	任意	アセットタイプ: GaEIP。列挙値: true : 有効。 false : 無効。	false
AiGatewayEIP	boolean	任意	アセットタイプ: AIGatewayEIP。列挙値: true : 有効。 false : 無効。	false
EIP	boolean	任意	アセットタイプ: EIP。列挙値: true : 有効。 false : 無効。	false
NatEIP	boolean	任意	アセットタイプ: NatEIP。列挙値: true : 有効。 false : 無効。	false
SlbPublicIP	boolean	任意	アセットタイプ: SlbPublicIP。列挙値: true : 有効。 false : 無効。	false
EcsEIP	boolean	任意	アセットタイプ: EcsEIP。列挙値: true : 有効。 false : 無効。	false
HAVIP	boolean	任意	アセットタイプ: HAVIP。列挙値: true : 有効。 false : 無効。	false
Ipv6	object	任意	IPv6 アセットタイプ。
SlbIPv6	boolean	任意	アセットタイプ: SlbIPv6。列挙値: true : 有効。 false : 無効。	false
NlbIPv6	boolean	任意	アセットタイプ: NlbIPv6。列挙値: true : 有効。 false : 無効。	false
EniEIPv6	boolean	任意	アセットタイプ: EniEIPv6。列挙値: true : 有効。 false : 無効。	false
AlbIPv6	boolean	任意	アセットタイプ: AlbIPv6。列挙値: true : 有効。 false : 無効。	false
GaEIPv6	boolean	任意	アセットタイプ: GaEIPv6。列挙値: true : 有効。 false : 無効。	false
AiGatewayEIPv6	boolean	任意	アセットタイプ: AIGatewayEIPv6。列挙値: true : 有効。 false : 無効。	false
EcsIPv6	boolean	任意	アセットタイプ: EcsIPv6。列挙値: true : 有効。 false : 無効。	false
ApiGatewayEIPv6	boolean	任意	アセットタイプ: ApigEIPv6。列挙値: true : 有効。 false : 無効。	false

この操作を呼び出す際は、本トピックで説明されている操作固有のリクエストパラメーターに加えて、共通リクエストパラメーターを含める必要があります。共通リクエストパラメーターの詳細については、「共通パラメーター」を参照してください。リクエスト形式については、本トピックの「使用例」セクションのリクエスト例を参照してください。

レスポンスフィールド

フィールド	型	説明	例
	object
GroupUuid	string	アドレス帳の作成後に返されるアドレス帳の一意の ID。	f04ac7ce-628b-4cb7-be61-310222b7****
RequestId	string	リクエスト ID。	CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2****

例

成功レスポンス

JSONJSON

{
  "GroupUuid": "f04ac7ce-628b-4cb7-be61-310222b7****",
  "RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	ErrorParametersGroupType	The group type is invalid.
400	ErrorParametersUid	The aliUid parameter is invalid.
400	ErrorParametersGroupAddress	The IP address of the address group is invalid.
400	ErrorDBSelect	An error occurred while querying database.
400	ErrorAddressCountExceed	The maximum number of addresses is exceeded.
400	ErrorAddressGroupExist	The address group already exists.
400	ErrorParamDomain	The parameter Domain is invalid.
400	ErrorUUIDNew	The UUID is invalid.
400	ErrorAddressGroupCountExceed	The maximum number of address group is exceeded.
400	ErrorDBInsert	An error occurred while performing an insert operation in the database.
400	ErrorRecordLog	An error occurred while updating the operation log.
400	ErrorDBUpdate	internal error: sql updat.
400	ErrorParametersTagKey	The tag key is invalid.
400	ErrorParametersTagList	The tag list is invalid.
400	ErrorTagCountExceed	The maximum number of tag is exceeded.
400	ErrorParametersTagRelation	The tag relation is invalid.
400	ErrorParametersGroupPort	The group port is invalid.
400	ErrorPortCountExceed	The maixmum number of port in the group is exceeded.
400	InternalError	The request processing has failed due to some unknown error.
400	ErrorAckClusterConnectorBusy	The ACK cluster connector is operating.
400	ErrorParameters	Parameters error.
400	ErrorParametersMemberUidMismatch	The memberUid mismatch the aliUid.
404	ErrorAckClusterConnectorNotFound	The specified resource ACK cluster connector is not found.

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

変更履歴

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