ModifyContext0SecurityIps - PolarDB - Alibaba Cloud Documentation Center

Synchronously modifies the whitelists for the context service and dashboard.

Operation description

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardbx:ModifyContext0SecurityIps

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the instance resides.	cn-hangzhou
DBInstanceName	string	Yes	The ID of the instance.	pxc-********
SecurityIPList	string	Yes	The IP addresses in the whitelist. Separate multiple IP addresses with commas (,).	127.0.0.1,192.168.0.0
GroupName	string	No	The name of the whitelist group for the instance.	default
ModifyMode	string	No	The modification mode of the whitelist. Valid values: 0: Overwrites the whitelist group. 1: Adds a whitelist group. 2: Deletes a whitelist group.	1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	9B2F3840-5C98-475C-B269-2D5C3A31797C
Data	object	The returned data.
DBInstanceId	integer	The instance ID.	pxsp-xxxxxxxxxx
DBInstanceName	string	The name of the instance.	pxc-hzjasd****
TaskId	integer	The ID of the task.	******
TaskIds	array	The list of task IDs in the task group.
	integer	The list of task IDs in the task group.	f6f2e335-74b4-47ff-9d63-f9c613f4b524
Context0InstanceName	string	The name of the context service instance.	context0-example
AccessDeniedDetail	object	The details of the access denial.
AuthAction	string	The authentication action.	xxx
AuthPrincipalType	string	The type of identity used for authentication in the request. Valid values: SubUser: RAM user. AssumedRoleUser: RAM role. Federated: SSO federated identity.	222
AuthPrincipalOwnerId	string	The owner ID of the authentication principal.	111
AuthPrincipalDisplayName	string	The name of the authentication principal.	xxx
PolicyType	string	PolicyType	PRIORITY
NoPermissionType	string	NoPermissionType	ImplicitDeny
EncodedDiagnosticMessage	string	The diagnostic information.	AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==

Examples

Success response

JSON format

{
  "RequestId": "9B2F3840-5C98-475C-B269-2D5C3A31797C",
  "Data": {
    "DBInstanceId": 0,
    "DBInstanceName": "pxc-hzjasd****",
    "TaskId": 0,
    "TaskIds": [
      0
    ],
    "Context0InstanceName": "context0-example"
  },
  "AccessDeniedDetail": {
    "AuthAction": "xxx",
    "AuthPrincipalType": "222",
    "AuthPrincipalOwnerId": "111",
    "AuthPrincipalDisplayName": "xxx",
    "PolicyType": "PRIORITY",
    "NoPermissionType": "ImplicitDeny",
    "EncodedDiagnosticMessage": "AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=="
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.