文档中心

云数据库 veDB MySQL 版

安全

DescribeAllowListDetail - 获取白名单详情

调用 DescribeAllowListDetail 接口查询白名单的详细信息。

请求类型

同步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
AllowListId	String	是	acl-b2a5bf3e471c433096232082c199****	白名单 ID。说明您可以调用 DescribeAllowLists 接口查询指定地域下所有的白名单列表信息，包括白名单 ID。

返回参数

参数	类型	示例值	描述
AllowList	String	10.1..,10.2../24	白名单内的 IP 地址列表。
AllowListDesc	String	test	白名单的备注。
AllowListId	String	acl-d1fd76693bd54e658912e7337d5b****	白名单 ID。
AllowListName	String	test	白名单名称。
AllowListType	String	IPv4	白名单内的 IP 地址类型。当前仅支持指定为 IPv4，表示 IPv4 地址。
AssociatedInstanceNum	Long	0	已绑定的实例数量。
ProjectName	String	default	白名单所属的项目名称。
AssociatedInstances	Array of AssociatedInstanceInfo	请参见返回示例。	已绑定当前白名单的实例信息。
SecurityGroupBindInfos	Array of SecurityGroupBindInfo		白名单绑定的安全组信息。
UserAllowList	String		安全组之外的 IP 地址列表。

AssociatedInstanceInfo

参数	类型	示例值	描述
InstanceId	String	vedbm-ca12cbqv****	实例 ID。
InstanceName	String	test	实例名称。
VPC	String	vpc-3tgjebmlgq4e8i4m****	VPC ID。
ProjectName	String	default	白名单所属的项目名称。

SecurityGroupBindInfo

参数	类型	示例值	描述
IpList	Array of String	["10...1/32","10...2/32"]	安全组中的 IP 地址列表。
BindMode	String	IngressDirectionIp	绑定安全组的模式。取值： IngressDirectionIp：入方向 IP。 AssociateEcsIp：关联 ECSIP。
SecurityGroupId	String	sg-b8pzuwk3i4g028j06k8f****	安全组 ID。
SecurityGroupName	String	测试安全组	安全组名称。

示例

请求示例

POST /?Action=DescribeAllowListDetail&Version=2022-01-01 HTTP/1.1​
Content-Type: application/json​
Host:vedbm.cn-beijing.volcengineapi.com​
X-Date: 20220101T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20220101/cn-beijing/vedbm/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****​
{​
    "AllowListId": "acl-04908986ad034ac0ba1fb1e3a754****"​
}​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "202203161507260102252431180088****",​
        "Action": "DescribeAllowListDetail",​
        "Version": "2022-01-01",​
        "Service": "vedbm",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "AllowList": "192.***.***.6/32,0.***.***.0/0,100.***.***.0/16",​
        "AllowListDesc": "test",​
        "AllowListId": "acl-d1fd76693bd54e658912e7337d5b****",​
        "AllowListName": "test",​
        "AllowListType": "IPv4",​
        "AssociatedInstanceNum": 1,​
        "AssociatedInstances": [​
            {​
                "InstanceId": "vedbm-ca12cbqv****",​
                "InstanceName": "test",​
                "ProjectName": "default",​
                "VPC": "vpc-3tgjebmlgq4e8i4m****"​
            }​
        ],​
        "SecurityGroupBindInfos": [​
            {​
                "BindMode": "IngressDirectionIp",​
                "IpList": [​
                    "0.***.***.0/0",​
                    "100.***.***.0/16"​
                ],​
                "SecurityGroupId": "sg-w0k1jrrvuq68865yk9jsfq8z"​
            }​
        ],​
        "UserAllowList": "192.***.***.6/32",​
        "ProjectName": "default"​
    }​
}​

错误码

更多详情，请参见错误码。

最近更新时间：2026.07.31 10:06:26

这个页面对您有帮助吗？

有用

无用