DescribeAllowLists--云数据库 veDB MySQL 版-火山引擎

文档中心

立即注册

导航

DescribeAllowLists

最近更新时间：2024.11.08 10:14:36首次发布时间：2022.08.20 16:54:39

调用 DescribeAllowLists 接口查询当前账号下指定地域内的所有 IP 白名单信息。

请求类型

同步请求。

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必选	示例值	描述
RegionId	String	是	cn-beijing	地域 ID。说明您可以调用 DescribeRegions 接口查询可创建实例的地域信息，包括地域 ID。
InstanceId	String	否	vedbm-ca12cbqv****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有实例的基本信息，包括实例 ID。
ProjectName	String	否	default	白名单所属的项目名称。说明项目是一个虚拟的概念，包括一组资源、用户和角色。通过项目可以对一组资源进行统一的查看和管理，并且控制项目内用户和角色管理这些资源的权限。更多详情，请参见资源管理。

返回参数

名称	类型	示例值	描述
AllowLists	Array of AllowListInfo	请参见返回示例。	白名单信息列表。详细信息，请参见 AllowListInfo。

请求示例

POST /?Action=DescribeAllowLists&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: vedbm.volcengineapi.com
X-Date: 20220614T114308Z
Authorization: HMAC-SHA256 Credential=AKIAIAGMBG4SXSQQ****/20220614/cn-beijing/veDB/request, SignedHeaders=accept;content-type;host;x-date, Signature=6a593bf5f59e7c1109fb205c739d1cff4c672fe2d251963f4d48c8701d16****

{
    "RegionId":"cn-beijing",
    "InstanceId": "vedbm-ca12cbqv****"
}

返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220316143231010225099008069A****",
        "Action": "DescribeAllowLists",
        "Version": "2022-01-01",
        "Service": "vedbm",
        "Region": "cn-beijing"
    },
    "Result": {
        "AllowLists": [
            {
                "AllowListDesc": "test",
                "AllowListId": "acl-d1fd76693bd54e658912e7337d5b****",
                "AllowListName": "test",
                "AllowListIPNum": 2,
                "AllowListType": "IPv4",
                "AssociatedInstanceNum": 1,
                "ProjectName": "default"
            }
        ]
    }
}

错误码

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