CreateNetworkRule - 创建网络规则

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

接口说明

  • RAM 用户或 RAM 角色调用该 OpenAPI 需要被授予的权限策略详情,请参见访问控制

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

    1. 创建网络控制规则:设置允许访问 KMS 的私网 IP 或私网网段。即本文介绍的内容。
    2. 创建权限策略:设置允许应用访问的密钥和凭据,并绑定网络控制规则。更多信息,请参见 CreatePolicy
    3. 创建应用接入点:设置认证方式,并绑定权限策略。更多信息,请参见 CreateApplicationAccessPoint
    4. 创建应用身份凭证(ClientKey):设置 ClientKey 的加密口令、有效期,并绑定应用接入点。更多信息,请参见 CreateClientKey

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
Namestring

网络控制规则名称。

networkrule_test
Typestring

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

Private
Descriptionstring

描述信息。

networkrule description
SourcePrivateIpstring

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

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

返回参数

名称类型描述示例值
object
Typestring

网络类型。

Private
RequestIdstring

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

3bf02f7a-015b-4f93-be0f-cc043fda2dd3
Descriptionstring

描述信息。

networkrule description
SourcePrivateIpstring

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

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

网络控制规则的名称。

networkrule_test
Arnstring

网络控制规则的 ARN。

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

示例

正常返回示例

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"
}

错误码

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