All Products
Search
Document Center

Key Management Service:DescribeNetworkRule

Last Updated:Sep 12, 2025

Queries the details of a specified network rule.

Operation description

For information about the required access policy for a Resource Access Management (RAM) user or RAM role to call this operation, see Resource Access Management.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

Name

string

Yes

The name of the network rule to query.

networkrule_test

Response elements

Element

Type

Description

Example

object

RequestId

string

The ID of the request. Alibaba Cloud generates a unique ID for each request. You can use this ID to troubleshoot issues.

3bf02f7a-015b-4f93-be0f-cc043fda2d33

Arn

string

The ARN of the network rule.

acs:kms:cn-hangzhou:119285303511****:network/networkrule_test

Type

string

The network type. The only valid value is Private, which means only private IP addresses are supported.

Private

Description

string

The description.

Create by kst-hzz62ee817bvyyr5****

SourcePrivateIp

string

The private IP addresses or private CIDR blocks.

["192.10.XX.XX","192.168.XX.XX/24"]

Examples

Success response

JSON format

{
  "RequestId": "3bf02f7a-015b-4f93-be0f-cc043fda2d33",
  "Arn": "acs:kms:cn-hangzhou:119285303511****:network/networkrule_test",
  "Type": "Private",
  "Description": "Create by kst-hzz62ee817bvyyr5****",
  "SourcePrivateIp": "[\"192.10.XX.XX\",\"192.168.XX.XX/24\"]"
}

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidParameter The specified parameter is not valid. 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.