ModifyAddressBook API リファレンス - Cloud Firewall - Alibaba Cloud - Cloud Firewall

アドレス帳を変更します。

操作説明

この操作は、アドレス帳を変更するために使用されます。

今すぐお試しください

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

update

*AddressBook。

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ClientToken	string	任意	冪等性トークン。	ddadxefexxxx
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。
SourceIp `deprecated`	string	任意	リクエストのソース IP アドレス。	192.0.XX.XX
Lang	string	任意	言語タイプ。列挙値: en : 英語。 zh : 中国語 (デフォルト)	zh
AddressList	string	任意	アドレス帳内のアドレス。複数のアドレスはコンマ (,) で区切ります。アドレスとその説明はスペースで区切ります。GroupType が ip、ポート、またはドメインにセットされている場合、このパラメーターは必須です。	192.0.XX.XX/32 ,192.0.XX.XX/24
Description	string	必須	アドレス帳の説明。	bj-001
GroupName	string	必須	アドレス帳の名前。	bj-001
GroupUuid	string	必須	アドレス帳の一意の ID。	0657ab9d-fe8b-4174-b2a6-6baf358e****
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
ModifyMode	string	任意	変更モード。列挙値: Delete : AddressList パラメーターで指定されたアドレスをアドレス帳から削除します。 Append : AddressList パラメーターで指定されたアドレスをアドレス帳に追加します。 Cover : アドレス帳を AddressList パラメーターで指定されたアドレスで上書きします。	Cover
AckNamespaces	array	任意	ACK クラスター内の Pod の名前空間のリスト。
	string	任意	ACK クラスター内の Pod の名前空間。有効な値は以下から取得されます:	default
AckLabels	array<object>	任意	ACK クラスター内の Pod のラベルのリスト。
	object	任意	ACK クラスター内の Pod のラベル。有効な値は以下から取得されます:	default
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。列挙値: false : 無効。 true : 有効。	true
NatPublicIP	boolean	任意	アセットタイプ: NatPublicIP。列挙値: false : 無効。 true : 有効。	false
BastionHostIngressIP	boolean	任意	アセットタイプ: BastionHostIngressIP。列挙値: false : 無効。 true : 有効。	false
EniEIP	boolean	任意	アセットタイプ: EniEIP。列挙値: false : 無効。 true : 有効。	false
NlbEIP	boolean	任意	アセットタイプ: NlbEIP。列挙値: false : 無効。 true : 有効。	false
ApiGatewayEIP	boolean	任意	アセットタイプ: ApigEIP。列挙値: false : 無効。 true : 有効。	false
EcsPublicIP	boolean	任意	アセットタイプ: EcsPublicIP。列挙値: false : 無効。 true : 有効。	false
BastionHostIP	boolean	任意	アセットタイプ: BastionHostIP。列挙値: false : 無効。 true : 有効。	false
BastionHostEgressIP	boolean	任意	アセットタイプ: BastionHostEgressIP。列挙値: false : 無効。 true : 有効。	false
AlbEIP	boolean	任意	アセットタイプ: AlbEIP。列挙値: false : 無効。 true : 有効。	false
GaEIP	boolean	任意	アセットタイプ: GaEIP。列挙値: false : 無効。 true : 有効。	false
AiGatewayEIP	boolean	任意	アセットタイプ: AIGatewayEIP。列挙値: false : 無効。 true : 有効。	false
EIP	boolean	任意	アセットタイプ: EIP。列挙値: false : 無効。 true : 有効。	false
NatEIP	boolean	任意	アセットタイプ: NatEIP。列挙値: false : 無効。 true : 有効。	false
SlbPublicIP	boolean	任意	アセットタイプ: SlbPublicIP。列挙値: false : 無効。 true : 有効。	false
EcsEIP	boolean	任意	アセットタイプ: EcsEIP。列挙値: false : 無効。 true : 有効。	false
HAVIP	boolean	任意	アセットタイプ: HAVIP。列挙値: false : 無効。 true : 有効。	false
Ipv6	object	任意	IPv6 アセットタイプ。
SlbIPv6	boolean	任意	アセットタイプ: SlbIPv6。列挙値: false : 無効。 true : 有効。	false
NlbIPv6	boolean	任意	アセットタイプ: NlbIPv6。列挙値: false : 無効。 true : 有効。	false
EniEIPv6	boolean	任意	アセットタイプ: EniEIPv6。列挙値: false : 無効。 true : 有効。	false
AlbIPv6	boolean	任意	アセットタイプ: AlbIPv6。列挙値: false : 無効。 true : 有効。	false
GaEIPv6	boolean	任意	アセットタイプ: GaEIPv6。列挙値: false : 無効。 true : 有効。	false
AiGatewayEIPv6	boolean	任意	アセットタイプ: AIGatewayEIPv6。列挙値: false : 無効。 true : 有効。	false
EcsIPv6	boolean	任意	アセットタイプ: EcsIPv6。列挙値: false : 無効。 true : 有効。	false
ApiGatewayEIPv6	boolean	任意	アセットタイプ: ApigEIPv6。列挙値: false : 無効。 true : 有効。	false

この API 操作を呼び出す際は、本トピックで説明されているリクエストパラメーターに加えて、Alibaba Cloud API の共通リクエストパラメーターも含める必要があります。共通リクエストパラメーターの詳細については、「共通パラメーター」を参照してください。

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID。	CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D
DryRun	boolean	これが正常なドライラン応答であることを示します。値が true の場合、ドライランのみが完了し、実際の変更は実行されなかったことを示します。

例

成功レスポンス

JSONJSON

{
  "RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D",
  "DryRun": false
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	ErrorParametersUid	The aliUid parameter is invalid.
400	ErrorDBSelect	An error occurred while querying database.
400	ErrorAddressCountExceed	The maximum number of addresses is exceeded.
400	ErrorParametersGroupAddress	The IP address of the address group is invalid.
400	ErrorParamDomain	The parameter Domain is invalid.
400	ErrorAddressGroupNotExist	The address group does not exist.
400	ErrorDBInsert	An error occurred while performing an insert operation in the database.
400	ErrorRecordLog	An error occurred while updating the operation log.
400	ErrorParametersGroupPort	The group port is invalid.
400	ErrorAclExtendedCountExceed	ACL or extended ACL rules are not matched.
400	ErrorDBDelete	An error occurred while deleting the database.
400	ErrorAddressGroupExist	The address group already exists.
400	ErrorAclDomainAnyCountExceed	The number of resolved domain names cannot exceed 200. ACL configuration can be continued for HTTP, HTTPS, SMTP, SMTPS, and SSL applications.
400	ErrorParametersAddressGroupAddressNotFound	The address to be deleted does not exist in the address book.
400	InvalidParameter.AddressBook.AddressDuplicate	The address book address %s is already exist.
400	ErrorAckClusterConnectorBusy	The ACK cluster connector is operating.
400	ErrorParameters	Parameters error.
400	ErrorParametersMemberUidMismatch	The memberUid mismatch the aliUid.
400	InvalidClientToken	ClientToken format invalid. Only ASCII letters, digits, hyphens and underscores are allowed, max 64 characters.
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.
401	ErrorAuthentication	An authentication error occurred.
404	ErrorAckClusterConnectorNotFound	The specified resource ACK cluster connector is not found.
409	IdempotentToken.Processing	A previous request with the same ClientToken is still being processed.

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

変更履歴

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