全部产品
Search
文档中心

密钥管理服务:ListNetworkRules

更新时间:Sep 08, 2023

查询网络控制规则列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

是否必选

示例值

描述

Action String ListNetworkRules

系统规定参数。取值:ListNetworkRules

PageNumber Integer 1

分页查询时,设置当前页面的页码。默认值为1。

PageSize Integer 10

分页查询时,设置每页包含网络控制规则的数量。取值范围:1~100,默认值为20。

返回数据

名称

类型

示例值

描述

RequestId String 3bf02f7a-015b-4f34-be0f-cc043fda2d33

本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

PageNumber Integer 1

分页查询时,当前页面的页码。

PageSize Integer 10

分页查询时,每页包含网络控制规则的数量。

TotalCount Integer 1

网络控制规则的总数量。

NetworkRules Array of NetworkRule

网络控制规则列表。

NetworkRule
Type String Private

网络类型。取值仅支持Private,即自建应用仅支持通过私网VPC访问KMS实例。

Name String networkrule_test

网络控制规则名称。

示例

请求示例

http(s)://[Endpoint]/?Action=ListNetworkRules
&PageNumber=1
&PageSize=10
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListNetworkRulesResponse>
    <RequestId>3bf02f7a-015b-4f34-be0f-cc043fda2d33</RequestId>
    <PageNumber>1</PageNumber>
    <PageSize>10</PageSize>
    <TotalCount>1</TotalCount>
    <NetworkRules>
        <Type>Private</Type>
        <Name>networkrule_test</Name>
    </NetworkRules>
</ListNetworkRulesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode

错误码

错误信息

描述

400 InvalidParameter The specified parameter is invalid. 参数错误
404 InvalidAccessKeyId.NotFound The Access Key ID provided does not exist in our records. 提供的 Access Key ID不存在

访问错误中心查看更多错误码。