All Products
Search
Document Center

Key Management Service:ListNetworkRules

Last Updated:Jul 29, 2025

Queries a list of network access rules.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Valid values: 1 to 100. Default value: 20.

10

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

3bf02f7a-015b-4f34-be0f-cc043fda2d33
PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page.

10
TotalCountinteger

The total number of entries returned.

1
NetworkRulesarray<object>

A list of access control rules.

NetworkRuleobject

A list of access control rules.

Typestring

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
Namestring

The name of the access control rule.

networkrule_test

Examples

Sample success responses

JSONformat

{
  "RequestId": "3bf02f7a-015b-4f34-be0f-cc043fda2d33",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "NetworkRules": {
    "NetworkRule": [
      {
        "Type": "Private",
        "Name": "networkrule_test"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterThe specified parameter is invalid.An invalid value is specified for the parameter.
404InvalidAccessKeyId.NotFoundThe Access Key ID provided does not exist in our records.-

For a list of error codes, visit the Service error codes.