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

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

操作説明

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

QPS 制限

この操作の単一ユーザー 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:ModifyAddressBook

update

*AddressBook。

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SourceIp `deprecated`	string	任意	リクエストのソース IP アドレス。	192.0.XX.XX
Lang	string	任意	言語タイプ。有効な値: en: 英語。 zh: 中国語 (デフォルト)。列挙値: en : 英語。 zh : 中国語 (デフォルト)	zh
AddressList	string	任意	アドレス帳内のアドレスのセット。複数のアドレスはコンマ (,) で区切ります。アドレスとその説明はスペースで区切ります。GroupType が ip、port、または domain に設定されている場合、このパラメーターは必須です。 GroupType が ip に設定されている場合は、IP アドレスを指定します。例: 1.2.XX.XX/32 Development CIDR ブロック,10.0.0.X/24,1.2.XX.XX/24 Test CIDR ブロック。 GroupType が port に設定されている場合は、ポートまたはポート範囲を指定します。例: 80/80 HTTP ポート,100/200,3306 データベースポート。 GroupType が domain に設定されている場合は、ドメイン名を指定します。例: demo1.aliyun.com テストドメイン名,demo2.aliyun.com,www.aliyun.com Alibaba Cloud 公式ウェブサイト。	192.0.XX.XX/32 ,192.0.XX.XX/24
Description	string	必須	アドレス帳の説明。	bj-001
GroupName	string	必須	アドレス帳の名前。	bj-001
GroupUuid	string	必須	アドレス帳の一意の ID。説明 DescribeAddressBook 操作を呼び出して値を取得できます。	0657ab9d-fe8b-4174-b2a6-6baf358e****
AutoAddTagEcs	string	任意	新しいタグに一致する Elastic Compute Service (ECS) インスタンスのパブリック IP アドレスをアドレス帳に自動的に追加するかどうかを指定します。列挙値: 0 : 自動的に追加しない。 1 : 自動的に追加する。	1
TagRelation	string	任意	複数の ECS タグ間の論理関係。有効な値: or: インスタンスが指定されたタグのいずれかに一致する場合、ECS インスタンスのパブリック IP アドレスがアドレス帳に追加されます。 and: インスタンスが指定されたすべてのタグに一致する場合にのみ、ECS インスタンスのパブリック IP アドレスがアドレス帳に追加されます。列挙値: 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	任意	変更モード。説明 GroupType が ip、ipv6、port、または domain に設定されている場合、このパラメーターが指定されていないとデフォルト値は Cover になります。重要 GroupType が tag に設定されている場合、このパラメーターは空にする必要があります。列挙値: Delete : AddressList パラメーターで指定されたアドレスをアドレス帳から削除します。 Cover : アドレス帳を AddressList パラメーターで指定されたアドレスで上書きします。 Append : AddressList パラメーターで指定されたアドレスをアドレス帳に追加します。	Cover
AckNamespaces	array	任意	ACK クラスター Pod の名前空間のリスト。説明最大値は 10 個の名前空間です。
	string	任意	ACK クラスター Pod の名前空間。以下の操作を呼び出して値を取得できます。 DescribeAckClusterNamespaces : ACK クラスターの名前空間を照会します。説明 GroupType が ackNamespace に設定されている場合、このパラメーターは必須です。	default
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
		任意	アセットアドレス帳のメンバーアカウントのリスト。
		任意	アセットアドレス帳のリージョンおよびリソースタイプのリスト。

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

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D

例

成功レスポンス

JSONJSON

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

エラーコード

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.
401	ErrorAuthentication	An authentication error occurred.
404	ErrorAckClusterConnectorNotFound	The specified resource ACK cluster connector is not found.

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

変更履歴

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