全部产品
Search
文档中心

密钥管理服务:CreateNetworkRule

更新时间:Sep 08, 2023

创建一条网络控制规则,设置允许访问KMS的私网IP或私网网段。

使用说明

自建应用进行密码运算操作、获取凭据值前,需要通过应用身份凭证(ClientKey)访问KMS实例。创建应用接入点AAP和身份凭证(ClientKey)的整体流程如下:

1. 创建网络控制规则:设置允许访问KMS的私网IP或私网网段。即本文介绍的内容。

2. 创建权限策略:设置允许应用访问的密钥和凭据,并绑定网络控制规则。更多信息,请参见CreatePolicy

3. 创建应用接入点:设置认证方式,并绑定权限策略。更多信息,请参见CreateApplicationAccessPoint

4. 创建应用身份凭证(ClientKey):设置ClientKey的加密口令、有效期,并绑定应用接入点。更多信息,请参见CreateClientKey

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String CreateNetworkRule

要执行的操作。取值:CreateNetworkRule

Name String networkrule_test

网络控制规则名称。

Type String Private

网络类型。

取值仅支持Private,即仅支持私网IP。

Description String networkrule description

描述信息。

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

私网IP地址或者私网网段,各个IP地址间用半角逗号(,)分隔。

返回数据

名称

类型

示例值

描述

Type String Private

网络类型。

RequestId String 3bf02f7a-015b-4f93-be0f-cc043fda2dd3

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

Description String networkrule description

描述信息。

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

私网IP地址或者私网网段。

Name String networkrule_test

网络控制规则的名称。

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

网络控制规则的ARN。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateNetworkRule
&Name=networkrule_test
&Type=Private
&Description=networkrule description
&SourcePrivateIp=["192.10.XX.XX","192.168.XX.XX/24"]
&公共请求参数

正常返回示例

XML格式

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

<CreateNetworkRuleResponse>
    <Type>Private</Type>
    <RequestId>3bf02f7a-015b-4f93-be0f-cc043fda2dd3</RequestId>
    <Description>networkrule description</Description>
    <SourcePrivateIp>["192.10.XX.XX","192.168.XX.XX/24"]</SourcePrivateIp>
    <Name>networkrule_test</Name>
    <Arn>acs:kms:cn-hangzhou:119285303511****:network/networkrule_test</Arn>
</CreateNetworkRuleResponse>

JSON格式

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

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

错误码

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