文档中心

ArkClaw 企业版

PrivateEgressService

DescribePrivateEgressWebAccessRules - 查询私网出口Web访问规则列表

调用 DescribePrivateEgressWebAccessRules 接口，查询私网出口Web访问规则列表。

请求参数

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

Action string 必选示例值：DescribePrivateEgressWebAccessRules

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

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

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

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

空间ID。

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

PrivateEgressWebAccessRuleIds.N string[] 可选示例值：dbr-a1b2c3****

Web访问规则的ID。

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

多个规则的 ID之间用&分隔。

PageNumber integer 可选示例值：1

列表的页码。默认值为1。

PageSize integer 可选示例值：20

分页查询时每页的行数。最大值为100，默认值为20。

PrivateEgressWebAccessPolicyId string 必选示例值：pwap-ihfm47b48gethr****

网络访问策略的ID。

Name string 可选示例值：test

Web访问规则的名称。

RuleType string 可选示例值：Custom

规则类型。取值如下：

Custom：自定义规则。

Managed：托管规则。

返回参数

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

RequestId string 示例值：20210811152539010225146063030****

请求ID。

PageNumber integer 示例值：1

当前页码。

PageSize integer 示例值：20

当前分页的行数。

TotalCount integer 示例值：20

符合条件的Web访问规则。

PrivateEgressWebAccessRules object[] 示例值：--

Web访问规则列表。

PrivateEgressWebAccessRuleId string 示例值：pwar-a1b2c3****

Web访问规则的ID。

PrivateEgressWebAccessPolicyId string 示例值：pwap-p6q7r8****

Web访问策略的ID。

Name string 示例值：block-kafka-domain

Web访问规则的名称。

Description string 示例值：封禁 Kafka 相关域名

Web访问规则的描述。

Priority integer 示例值：1

Web访问规则优先级。

RuleType string 示例值：Custom

规则类型。

Custom：自定义规则。

Managed：托管规则。

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

托管模板的ID。

SourceType string 示例值：ClawInstance

源类型。

ClawInstance：指定Claw实例。

All ：所有Claw实例。

SourceIds string[] 示例值：claw-abc***

源实例的ID。

DomainPatterns string[] 示例值：a.test.com

域名列表。

RuleAction string 示例值：Allow

执行动作。

Allow：放行。

Deny：阻断。

IsDefault boolean 示例值：true

是否为默认规则。

true

false

CreateTime string 示例值：2026-05-10T16:37:37Z

规则的创建时间。

UpdateTime string 示例值：2026-05-10T16:37:37Z

规则的最近修改时间。

请求示例

GET /?Action=DescribePrivateEgressWebAccessRules&Version=2026-03-01&SpaceId=csi-yeihfm47b48gethr****&PrivateEgressWebAccessPolicyId=pwap-ihfm47b48gethr**** HTTP/1.1​
Host: arkclaw.cn-beijing.volcengineapi.com​
X-Date: 20260729T090546Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260729/cn-beijing/arkclaw/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
​

返回示例

{​
  "ResponseMetadata": {​
    "RequestId": "20260729170552255133159031E0B5B8",​
    "Action": "DescribePrivateEgressWebAccessRules",​
    "Version": "2026-03-01",​
    "Service": "arkclaw",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "RequestId": "20210811152539010225146063030****",​
    "PageNumber": 1,​
    "PageSize": 20,​
    "TotalCount": 20,​
    "PrivateEgressWebAccessRules": [​
      {​
        "PrivateEgressWebAccessRuleId": "pwar-a1b2c3****",​
        "PrivateEgressWebAccessPolicyId": "pwap-p6q7r8****",​
        "Name": "block-kafka-domain",​
        "Description": "封禁 Kafka 相关域名",​
        "Priority": 1,​
        "RuleType": "Custom",​
        "ManagedTemplateId": "tmpl-3kusjumb1fk87bj6j43****\n",​
        "SourceType": "ClawInstance",​
        "SourceIds": [​
          "claw-abc***"​
        ],​
        "DomainPatterns": [​
          "a.test.com"​
        ],​
        "RuleAction": "Allow",​
        "IsDefault": true,​
        "CreateTime": "2026-05-10T16:37:37Z",​
        "UpdateTime": "2026-05-10T16:37:37Z"​
      }​
    ]​
  }​
}​

错误码

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

状态码	错误码	错误信息	说明
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.07.31 17:41:17

这个页面对您有帮助吗？

有用

无用