文档中心

ArkClaw 企业版

请输入

PrivateEgressService

CreatePrivateEgressWebAccessRule - 创建私网出口Web访问规则

调用 CreatePrivateEgressWebAccessRule 接口，创建私网出口Web访问规则。

使用说明

调用本API之前，已开启私网出口Web访问策略。

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：CreatePrivateEgressWebAccessRule

要执行的操作，取值：CreatePrivateEgressWebAccessRule。

Version string 必选示例值：2026-03-01

API的版本，取值：2026-03-01。

SpaceId string 必选示例值：csi-yeihfm47b48gethr****

空间ID。

您可以调用 ListClawSpaces 接口，获取空间ID。

Name string 可选示例值：test

Web访问规则的名称。

长度限制为1 ~ 128个字符。

需要以字母、中文或数字开头，可包含点号（.）、下划线（_）和短横线（-）。

不能以http://或https://开头。

Description string 可选示例值：test

Web访问规则的描述。

长度限制为0~ 255个字符。

需要以字母、中文或数字开头。可包含英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。

不能以http://或https://开头。

SourceType string 可选示例值：ClawInstance

源类型。取值如下：

ClawInstance：指定Claw实例。

All ：所有Claw实例。

说明

当 RuleType 为 Managed 时，无需传入 ResourceType 和 RuleAction。其他情况下，ResourceType 和 RuleAction 均为必填参数。

SourceIds string 可选示例值：SourceIds.1=claw-abc**** & SourceIds.2=claw-def****

源实例ID。

您可以调用 ListClawInstances接口，获取Claw实例的ID。

参数 - N：表示源实例ID的序号，单次调用数量上限为100个。

多个源实例ID之间用&分隔。

当SourceType=ClawInstance 时，传入Claw实例的ID。当SourceType传入All时，仅支持传入All。

RuleAction string 可选示例值：Allow

执行动作。取值如下：

Allow ：放行。

Deny：阻断。

说明

当 RuleType 为 Managed 时，无需传入 ResourceType 和 RuleAction。其他情况下，ResourceType 和 RuleAction 均为必填参数。

DomainPatterns string 可选示例值：a.test.com

域名。

All代表所有域名。

PrivateEgressWebAccessPolicyId string 必选示例值：pwar-2irekkpstr7cw3snftvmi****

Web访问策略的 ID。

Priority integer 必选示例值：10

优先级。

取值范围为1-10000。

数字越小，优先级越高。

RuleType string 可选示例值：Custom

规则类型。取值如下：

Custom（默认值）：自定义规则。

Managed：托管规则。

ManagedTemplateId string 可选示例值：tmpl-3kusjumb1fk87bj6j43****

托管模板 ID。

您可以调用 DescribePrivateEgressManagedWebAccessRuleTemplates 接口，获取托管模板的ID。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

RequestId string 示例值：202605281952040651192030174E6****

请求ID。

AsyncTaskId string 示例值：asynctask_0924yr7ybl3****

异步任务ID。

PrivateEgressWebAccessRuleId string 示例值：pwar-2irekkpstr7cw3snftvmi****

Web访问规则的ID。

请求示例

GET /?Action=CreatePrivateEgressWebAccessRule&Version=2026-03-01&SpaceId=csi-yeihfm47b48gethr****&PrivateEgressNetworkAccessPolicyId=pre-p6q7r8****&Name=test&Description=test&SourceType=ClawInstance&SourceIds=SourceIds.1%3Dclaw-abc****%20%26%20SourceIds.2%3Dclaw-def****&RuleAction=Permit&DomainPatterns=a.test.com HTTP/1.1​
Host: arkclaw.cn-beijing.volcengineapi.com​
X-Date: 20260723T092650Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260723/cn-beijing/arkclaw/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
​

返回示例

{​
  "ResponseMetadata": {​
    "RequestId": "202607241153180190441411728D2A28",​
    "Action": "CreatePrivateEgressWebAccessRule",​
    "Version": "2026-03-01",​
    "Service": "arkclaw",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "RequestId": "202605281952040651192030174E6****",​
    "PrivateEgressWebAccessRuleId": "pwar-2irekkpstr7cw3snftvmi****"​
  }​
}​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter	Invalid request parameters: %s.	参数不合法。
403	AccessDenied	You are not authorized to perform this action.	请求未通过权限验证。
404	NotFound	Resource not found: %s.	资源不存在。
500	InternalError	Internal server error: %s.	内部服务错误。

最近更新时间：2026.09.16 16:41:47

这个页面对您有帮助吗？

有用

无用