Queries all network access rules in the current region.
Operation description
For more information about the access policy required by a RAM user or RAM role to call this API, see Resource Access Management.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| PageNumber |
integer |
No |
The page number. Default value: 1. |
1 |
| PageSize |
integer |
No |
The number of entries per page. Valid values: 1 to 100. Default value: 20. |
10 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The request ID. |
3bf02f7a-015b-4f34-be0f-cc043fda2d33 |
| PageNumber |
integer |
The page number. |
1 |
| PageSize |
integer |
The number of entries per page. |
10 |
| TotalCount |
integer |
The total number of entries returned. |
1 |
| NetworkRules |
object |
||
| NetworkRule |
array<object> |
A list of access control rules. |
|
|
object |
A list of access control rules. |
||
| Type |
string |
The network type. The value is fixed as Private. Self-managed applications can access KMS instances only over a private virtual private cloud (VPC). |
Private |
| Name |
string |
The name of the access control rule. |
networkrule_test |
Examples
Success response
JSON format
{
"RequestId": "3bf02f7a-015b-4f34-be0f-cc043fda2d33",
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 1,
"NetworkRules": {
"NetworkRule": [
{
"Type": "Private",
"Name": "networkrule_test"
}
]
}
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidParameter | The specified parameter is invalid. | An invalid value is specified for the parameter. |
| 404 | InvalidAccessKeyId.NotFound | The Access Key ID provided does not exist in our records. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.