bytepluscc.rdspostgresql.getAllowList

bytepluscc v0.0.16, Mar 9 26

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Using getAllowList

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAllowList(args: GetAllowListArgs, opts?: InvokeOptions): Promise<GetAllowListResult>
function getAllowListOutput(args: GetAllowListOutputArgs, opts?: InvokeOptions): Output<GetAllowListResult>

def get_allow_list(id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetAllowListResult
def get_allow_list_output(id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetAllowListResult]

func LookupAllowList(ctx *Context, args *LookupAllowListArgs, opts ...InvokeOption) (*LookupAllowListResult, error)
func LookupAllowListOutput(ctx *Context, args *LookupAllowListOutputArgs, opts ...InvokeOption) LookupAllowListResultOutput

> Note: This function is named LookupAllowList in the Go SDK.

public static class GetAllowList 
{
    public static Task<GetAllowListResult> InvokeAsync(GetAllowListArgs args, InvokeOptions? opts = null)
    public static Output<GetAllowListResult> Invoke(GetAllowListInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAllowListResult> getAllowList(GetAllowListArgs args, InvokeOptions options)
public static Output<GetAllowListResult> getAllowList(GetAllowListArgs args, InvokeOptions options)

fn::invoke:
  function: bytepluscc:rdspostgresql/getAllowList:getAllowList
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: Uniquely identifies the resource.

Id string: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

id string: Uniquely identifies the resource.

id str: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

getAllowList Result

The following output properties are available:

AllowListCategory string: 白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时无默认值，不传入时则查询所有类别的白名单。
AllowListDesc string: 白名单的描述信息。长度在 200 字符以内。默认值为空字符串。
AllowListId string: 白名单 ID。
AllowListIpNum int: 白名单中 IP 地址或 IP 地址段的数量。
AllowListName string: 白名单名称的命名规则如下：在当前地域内，白名单名称唯一。以中文、字母或下划线（）开头。只能包含中文、字母、数字、下划线（）和中划线（-）。长度为 1~128 个字符。
AllowListType string: 白名单采用的网络协议类型。取值为 IPv4（默认值）。
AllowLists List<string>: 白名单中包含的 IP 地址。支持以下两种格式：IP 地址格式。例如：10.23.12.24。CIDR 的 IP 地址段格式。例如：10.23.12.0/24（无类别域间路由，24 表示了地址中前缀的长度，范围为 1~32）。说明每个白名单最多可添加 300 个 IP 或 IP 地址段，当 IP 较多时，建议合并为 IP 段填入，例如10.23.12.0/24。禁止将 0.0.0.0/0 之外的形如 x.x.x.x/0 结尾的 IP 地址加入白名单。该字段不能与 UserAllowList 字段同时使用。
AssociatedInstanceNum int: 该白名单绑定的实例数量。
AssociatedInstances List<Byteplus.GetAllowListAssociatedInstance>: 该白名单绑定的实例列表，包含实例 ID 和实例名称信息。
Id string: Uniquely identifies the resource.
IpAddress string: 按 IP 地址查询白名单。支持传入多个 IP 地址，多个 IP 地址使用英文逗号（,）分隔。说明如果白名单包含了多个 IP 地址的任意子集，该白名单就会被返回。
ModifyMode string: 修改白名单的方式。取值：Cover：覆盖，即使用 AllowList 字段的值覆盖原白名单。默认值。Append：追加，即在原白名单中增加 AllowList 字段包含的 IP 地址。Delete：删除，即在原白名单中删除 AllowList 字段包含的 IP 地址。至少需要保留一个 IP 地址。注意如需修改的白名单绑定有安全组，或需要在修改白名单时为白名单绑定安全组，则 ModifyMode 只能取值为 Cover。
SecurityGroupBindInfos List<Byteplus.GetAllowListSecurityGroupBindInfo>: 该白名单绑定的安全组列表。
UpdateSecurityGroup bool: 是否更新白名单所绑定的安全组。取值：true：更新。false：不更新。默认值。
UserAllowList string: 安全组之外的、需要加入白名单的 IP 地址。可输入 IP 地址或 CIDR 格式的 IP 地址段。说明该字段不能与 AllowList 字段同时使用。

AllowListCategory string: 白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时无默认值，不传入时则查询所有类别的白名单。
AllowListDesc string: 白名单的描述信息。长度在 200 字符以内。默认值为空字符串。
AllowListId string: 白名单 ID。
AllowListIpNum int: 白名单中 IP 地址或 IP 地址段的数量。
AllowListName string: 白名单名称的命名规则如下：在当前地域内，白名单名称唯一。以中文、字母或下划线（）开头。只能包含中文、字母、数字、下划线（）和中划线（-）。长度为 1~128 个字符。
AllowListType string: 白名单采用的网络协议类型。取值为 IPv4（默认值）。
AllowLists []string: 白名单中包含的 IP 地址。支持以下两种格式：IP 地址格式。例如：10.23.12.24。CIDR 的 IP 地址段格式。例如：10.23.12.0/24（无类别域间路由，24 表示了地址中前缀的长度，范围为 1~32）。说明每个白名单最多可添加 300 个 IP 或 IP 地址段，当 IP 较多时，建议合并为 IP 段填入，例如10.23.12.0/24。禁止将 0.0.0.0/0 之外的形如 x.x.x.x/0 结尾的 IP 地址加入白名单。该字段不能与 UserAllowList 字段同时使用。
AssociatedInstanceNum int: 该白名单绑定的实例数量。
AssociatedInstances []GetAllowListAssociatedInstance: 该白名单绑定的实例列表，包含实例 ID 和实例名称信息。
Id string: Uniquely identifies the resource.
IpAddress string: 按 IP 地址查询白名单。支持传入多个 IP 地址，多个 IP 地址使用英文逗号（,）分隔。说明如果白名单包含了多个 IP 地址的任意子集，该白名单就会被返回。
ModifyMode string: 修改白名单的方式。取值：Cover：覆盖，即使用 AllowList 字段的值覆盖原白名单。默认值。Append：追加，即在原白名单中增加 AllowList 字段包含的 IP 地址。Delete：删除，即在原白名单中删除 AllowList 字段包含的 IP 地址。至少需要保留一个 IP 地址。注意如需修改的白名单绑定有安全组，或需要在修改白名单时为白名单绑定安全组，则 ModifyMode 只能取值为 Cover。
SecurityGroupBindInfos []GetAllowListSecurityGroupBindInfo: 该白名单绑定的安全组列表。
UpdateSecurityGroup bool: 是否更新白名单所绑定的安全组。取值：true：更新。false：不更新。默认值。
UserAllowList string: 安全组之外的、需要加入白名单的 IP 地址。可输入 IP 地址或 CIDR 格式的 IP 地址段。说明该字段不能与 AllowList 字段同时使用。

allowListCategory String: 白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时无默认值，不传入时则查询所有类别的白名单。
allowListDesc String: 白名单的描述信息。长度在 200 字符以内。默认值为空字符串。
allowListId String: 白名单 ID。
allowListIpNum Integer: 白名单中 IP 地址或 IP 地址段的数量。
allowListName String: 白名单名称的命名规则如下：在当前地域内，白名单名称唯一。以中文、字母或下划线（）开头。只能包含中文、字母、数字、下划线（）和中划线（-）。长度为 1~128 个字符。
allowListType String: 白名单采用的网络协议类型。取值为 IPv4（默认值）。
allowLists List<String>: 白名单中包含的 IP 地址。支持以下两种格式：IP 地址格式。例如：10.23.12.24。CIDR 的 IP 地址段格式。例如：10.23.12.0/24（无类别域间路由，24 表示了地址中前缀的长度，范围为 1~32）。说明每个白名单最多可添加 300 个 IP 或 IP 地址段，当 IP 较多时，建议合并为 IP 段填入，例如10.23.12.0/24。禁止将 0.0.0.0/0 之外的形如 x.x.x.x/0 结尾的 IP 地址加入白名单。该字段不能与 UserAllowList 字段同时使用。
associatedInstanceNum Integer: 该白名单绑定的实例数量。
associatedInstances List<GetAllowListAssociatedInstance>: 该白名单绑定的实例列表，包含实例 ID 和实例名称信息。
id String: Uniquely identifies the resource.
ipAddress String: 按 IP 地址查询白名单。支持传入多个 IP 地址，多个 IP 地址使用英文逗号（,）分隔。说明如果白名单包含了多个 IP 地址的任意子集，该白名单就会被返回。
modifyMode String: 修改白名单的方式。取值：Cover：覆盖，即使用 AllowList 字段的值覆盖原白名单。默认值。Append：追加，即在原白名单中增加 AllowList 字段包含的 IP 地址。Delete：删除，即在原白名单中删除 AllowList 字段包含的 IP 地址。至少需要保留一个 IP 地址。注意如需修改的白名单绑定有安全组，或需要在修改白名单时为白名单绑定安全组，则 ModifyMode 只能取值为 Cover。
securityGroupBindInfos List<GetAllowListSecurityGroupBindInfo>: 该白名单绑定的安全组列表。
updateSecurityGroup Boolean: 是否更新白名单所绑定的安全组。取值：true：更新。false：不更新。默认值。
userAllowList String: 安全组之外的、需要加入白名单的 IP 地址。可输入 IP 地址或 CIDR 格式的 IP 地址段。说明该字段不能与 AllowList 字段同时使用。

allowListCategory string: 白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时无默认值，不传入时则查询所有类别的白名单。
allowListDesc string: 白名单的描述信息。长度在 200 字符以内。默认值为空字符串。
allowListId string: 白名单 ID。
allowListIpNum number: 白名单中 IP 地址或 IP 地址段的数量。
allowListName string: 白名单名称的命名规则如下：在当前地域内，白名单名称唯一。以中文、字母或下划线（）开头。只能包含中文、字母、数字、下划线（）和中划线（-）。长度为 1~128 个字符。
allowListType string: 白名单采用的网络协议类型。取值为 IPv4（默认值）。
allowLists string[]: 白名单中包含的 IP 地址。支持以下两种格式：IP 地址格式。例如：10.23.12.24。CIDR 的 IP 地址段格式。例如：10.23.12.0/24（无类别域间路由，24 表示了地址中前缀的长度，范围为 1~32）。说明每个白名单最多可添加 300 个 IP 或 IP 地址段，当 IP 较多时，建议合并为 IP 段填入，例如10.23.12.0/24。禁止将 0.0.0.0/0 之外的形如 x.x.x.x/0 结尾的 IP 地址加入白名单。该字段不能与 UserAllowList 字段同时使用。
associatedInstanceNum number: 该白名单绑定的实例数量。
associatedInstances GetAllowListAssociatedInstance[]: 该白名单绑定的实例列表，包含实例 ID 和实例名称信息。
id string: Uniquely identifies the resource.
ipAddress string: 按 IP 地址查询白名单。支持传入多个 IP 地址，多个 IP 地址使用英文逗号（,）分隔。说明如果白名单包含了多个 IP 地址的任意子集，该白名单就会被返回。
modifyMode string: 修改白名单的方式。取值：Cover：覆盖，即使用 AllowList 字段的值覆盖原白名单。默认值。Append：追加，即在原白名单中增加 AllowList 字段包含的 IP 地址。Delete：删除，即在原白名单中删除 AllowList 字段包含的 IP 地址。至少需要保留一个 IP 地址。注意如需修改的白名单绑定有安全组，或需要在修改白名单时为白名单绑定安全组，则 ModifyMode 只能取值为 Cover。
securityGroupBindInfos GetAllowListSecurityGroupBindInfo[]: 该白名单绑定的安全组列表。
updateSecurityGroup boolean: 是否更新白名单所绑定的安全组。取值：true：更新。false：不更新。默认值。
userAllowList string: 安全组之外的、需要加入白名单的 IP 地址。可输入 IP 地址或 CIDR 格式的 IP 地址段。说明该字段不能与 AllowList 字段同时使用。

allow_list_category str: 白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时无默认值，不传入时则查询所有类别的白名单。
allow_list_desc str: 白名单的描述信息。长度在 200 字符以内。默认值为空字符串。
allow_list_id str: 白名单 ID。
allow_list_ip_num int: 白名单中 IP 地址或 IP 地址段的数量。
allow_list_name str: 白名单名称的命名规则如下：在当前地域内，白名单名称唯一。以中文、字母或下划线（）开头。只能包含中文、字母、数字、下划线（）和中划线（-）。长度为 1~128 个字符。
allow_list_type str: 白名单采用的网络协议类型。取值为 IPv4（默认值）。
allow_lists Sequence[str]: 白名单中包含的 IP 地址。支持以下两种格式：IP 地址格式。例如：10.23.12.24。CIDR 的 IP 地址段格式。例如：10.23.12.0/24（无类别域间路由，24 表示了地址中前缀的长度，范围为 1~32）。说明每个白名单最多可添加 300 个 IP 或 IP 地址段，当 IP 较多时，建议合并为 IP 段填入，例如10.23.12.0/24。禁止将 0.0.0.0/0 之外的形如 x.x.x.x/0 结尾的 IP 地址加入白名单。该字段不能与 UserAllowList 字段同时使用。
associated_instance_num int: 该白名单绑定的实例数量。
associated_instances Sequence[GetAllowListAssociatedInstance]: 该白名单绑定的实例列表，包含实例 ID 和实例名称信息。
id str: Uniquely identifies the resource.
ip_address str: 按 IP 地址查询白名单。支持传入多个 IP 地址，多个 IP 地址使用英文逗号（,）分隔。说明如果白名单包含了多个 IP 地址的任意子集，该白名单就会被返回。
modify_mode str: 修改白名单的方式。取值：Cover：覆盖，即使用 AllowList 字段的值覆盖原白名单。默认值。Append：追加，即在原白名单中增加 AllowList 字段包含的 IP 地址。Delete：删除，即在原白名单中删除 AllowList 字段包含的 IP 地址。至少需要保留一个 IP 地址。注意如需修改的白名单绑定有安全组，或需要在修改白名单时为白名单绑定安全组，则 ModifyMode 只能取值为 Cover。
security_group_bind_infos Sequence[GetAllowListSecurityGroupBindInfo]: 该白名单绑定的安全组列表。
update_security_group bool: 是否更新白名单所绑定的安全组。取值：true：更新。false：不更新。默认值。
user_allow_list str: 安全组之外的、需要加入白名单的 IP 地址。可输入 IP 地址或 CIDR 格式的 IP 地址段。说明该字段不能与 AllowList 字段同时使用。

allowListCategory String: 白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时无默认值，不传入时则查询所有类别的白名单。
allowListDesc String: 白名单的描述信息。长度在 200 字符以内。默认值为空字符串。
allowListId String: 白名单 ID。
allowListIpNum Number: 白名单中 IP 地址或 IP 地址段的数量。
allowListName String: 白名单名称的命名规则如下：在当前地域内，白名单名称唯一。以中文、字母或下划线（）开头。只能包含中文、字母、数字、下划线（）和中划线（-）。长度为 1~128 个字符。
allowListType String: 白名单采用的网络协议类型。取值为 IPv4（默认值）。
allowLists List<String>: 白名单中包含的 IP 地址。支持以下两种格式：IP 地址格式。例如：10.23.12.24。CIDR 的 IP 地址段格式。例如：10.23.12.0/24（无类别域间路由，24 表示了地址中前缀的长度，范围为 1~32）。说明每个白名单最多可添加 300 个 IP 或 IP 地址段，当 IP 较多时，建议合并为 IP 段填入，例如10.23.12.0/24。禁止将 0.0.0.0/0 之外的形如 x.x.x.x/0 结尾的 IP 地址加入白名单。该字段不能与 UserAllowList 字段同时使用。
associatedInstanceNum Number: 该白名单绑定的实例数量。
associatedInstances List<Property Map>: 该白名单绑定的实例列表，包含实例 ID 和实例名称信息。
id String: Uniquely identifies the resource.
ipAddress String: 按 IP 地址查询白名单。支持传入多个 IP 地址，多个 IP 地址使用英文逗号（,）分隔。说明如果白名单包含了多个 IP 地址的任意子集，该白名单就会被返回。
modifyMode String: 修改白名单的方式。取值：Cover：覆盖，即使用 AllowList 字段的值覆盖原白名单。默认值。Append：追加，即在原白名单中增加 AllowList 字段包含的 IP 地址。Delete：删除，即在原白名单中删除 AllowList 字段包含的 IP 地址。至少需要保留一个 IP 地址。注意如需修改的白名单绑定有安全组，或需要在修改白名单时为白名单绑定安全组，则 ModifyMode 只能取值为 Cover。
securityGroupBindInfos List<Property Map>: 该白名单绑定的安全组列表。
updateSecurityGroup Boolean: 是否更新白名单所绑定的安全组。取值：true：更新。false：不更新。默认值。
userAllowList String: 安全组之外的、需要加入白名单的 IP 地址。可输入 IP 地址或 CIDR 格式的 IP 地址段。说明该字段不能与 AllowList 字段同时使用。

Supporting Types

GetAllowListAssociatedInstance

InstanceId string: 实例 ID。
InstanceName string: 实例名称。
Vpc string: 实例所属的 VPC ID。

InstanceId string: 实例 ID。
InstanceName string: 实例名称。
Vpc string: 实例所属的 VPC ID。

instanceId String: 实例 ID。
instanceName String: 实例名称。
vpc String: 实例所属的 VPC ID。

instanceId string: 实例 ID。
instanceName string: 实例名称。
vpc string: 实例所属的 VPC ID。

instance_id str: 实例 ID。
instance_name str: 实例名称。
vpc str: 实例所属的 VPC ID。

instanceId String: 实例 ID。
instanceName String: 实例名称。
vpc String: 实例所属的 VPC ID。

GetAllowListSecurityGroupBindInfo

BindMode string: 关联安全组的模式。取值：IngressDirectionIp：入方向 IP。AssociateEcsIp：关联 ECSIP。
IpLists List<string>: 安全组中的 IP 列表。
SecurityGroupId string: 安全组 ID。
SecurityGroupName string: 安全组名称。

BindMode string: 关联安全组的模式。取值：IngressDirectionIp：入方向 IP。AssociateEcsIp：关联 ECSIP。
IpLists []string: 安全组中的 IP 列表。
SecurityGroupId string: 安全组 ID。
SecurityGroupName string: 安全组名称。

bindMode String: 关联安全组的模式。取值：IngressDirectionIp：入方向 IP。AssociateEcsIp：关联 ECSIP。
ipLists List<String>: 安全组中的 IP 列表。
securityGroupId String: 安全组 ID。
securityGroupName String: 安全组名称。

bindMode string: 关联安全组的模式。取值：IngressDirectionIp：入方向 IP。AssociateEcsIp：关联 ECSIP。
ipLists string[]: 安全组中的 IP 列表。
securityGroupId string: 安全组 ID。
securityGroupName string: 安全组名称。

bind_mode str: 关联安全组的模式。取值：IngressDirectionIp：入方向 IP。AssociateEcsIp：关联 ECSIP。
ip_lists Sequence[str]: 安全组中的 IP 列表。
security_group_id str: 安全组 ID。
security_group_name str: 安全组名称。

bindMode String: 关联安全组的模式。取值：IngressDirectionIp：入方向 IP。AssociateEcsIp：关联 ECSIP。
ipLists List<String>: 安全组中的 IP 列表。
securityGroupId String: 安全组 ID。
securityGroupName String: 安全组名称。