bytepluscc.rdsmysql.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:rdsmysql/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：默认白名单。说明该参数作为请求参数时，默认值为 Ordinary。
AllowListDesc string: 白名单的备注。
AllowListId string: 白名单 ID 。
AllowListIpNum int: 白名单内的 IP 地址（或地址段）总数。
AllowListName string: 白名单名称。
AllowListType string: 白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
AllowLists List<string>: 白名单内的 IP 地址列表
AssociatedInstanceNum int: 白名单下绑定的实例总数。
AssociatedInstances List<Byteplus.GetAllowListAssociatedInstance>: 已绑定当前白名单的实例信息。
Id string: Uniquely identifies the resource.
IgnoreInstanceStatus bool: 是否忽略实例状态校验。取值：true：是。false：否。默认值。
InstanceId string: 实例 ID。
IpLists List<string>: 白名单包含的 IP 地址和 IP 地址段的列表。在请求参数 WithIpList 取值为 true 时返回，在取值为 false 或不为其传值时返回为 null。
ModifyMode string: 修改方式，取值范围如下：Cover（默认值）：使用 AllowList 参数中的值覆盖原白名单。Append：在原白名单中增加 AllowList 参数中输入的 IP 地址。Delete：在原白名单中删除 AllowList 参数中输入的 IP 地址。至少需要保留一个 IP 地址。
ProjectName string: 所属的项目。说明如您调用接口使用的 AK/SK 属于某个子账号，且该子账号只拥有某个项目的权限，需要传入该请求参数。
SecurityGroupBindInfos List<Byteplus.GetAllowListSecurityGroupBindInfo>: 白名单关联的安全组的信息。说明该字段不能与 SecurityGroupIds 同时使用。
SecurityGroupIds List<string>: 需要关联的安全组 ID 列表。说明您可以调用 DescribeSecurityGroups 接口查询安全组信息，包括安全组 ID。单个白名单单次最多可选择添加 10 个安全组。该字段不能与 SecurityGroupBindInfos 同时使用。
UpdateSecurityGroup bool: 是否更新白名单所绑定的安全组。true：更新。false：不更新。默认值。说明该字段仅在白名单已绑定了安全组时生效。可调用 DescribeAllowLists 接口查询白名单是否绑定了安全组。
UserAllowLists List<string>: 该名单中由用户输入的 IP 地址。AllowList 字段中的 IP 为 UserAllowList 和 SecurityGroupBindInfos 包含的 IP 的并集。

AllowListCategory string: 白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时，默认值为 Ordinary。
AllowListDesc string: 白名单的备注。
AllowListId string: 白名单 ID 。
AllowListIpNum int: 白名单内的 IP 地址（或地址段）总数。
AllowListName string: 白名单名称。
AllowListType string: 白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
AllowLists []string: 白名单内的 IP 地址列表
AssociatedInstanceNum int: 白名单下绑定的实例总数。
AssociatedInstances []GetAllowListAssociatedInstance: 已绑定当前白名单的实例信息。
Id string: Uniquely identifies the resource.
IgnoreInstanceStatus bool: 是否忽略实例状态校验。取值：true：是。false：否。默认值。
InstanceId string: 实例 ID。
IpLists []string: 白名单包含的 IP 地址和 IP 地址段的列表。在请求参数 WithIpList 取值为 true 时返回，在取值为 false 或不为其传值时返回为 null。
ModifyMode string: 修改方式，取值范围如下：Cover（默认值）：使用 AllowList 参数中的值覆盖原白名单。Append：在原白名单中增加 AllowList 参数中输入的 IP 地址。Delete：在原白名单中删除 AllowList 参数中输入的 IP 地址。至少需要保留一个 IP 地址。
ProjectName string: 所属的项目。说明如您调用接口使用的 AK/SK 属于某个子账号，且该子账号只拥有某个项目的权限，需要传入该请求参数。
SecurityGroupBindInfos []GetAllowListSecurityGroupBindInfo: 白名单关联的安全组的信息。说明该字段不能与 SecurityGroupIds 同时使用。
SecurityGroupIds []string: 需要关联的安全组 ID 列表。说明您可以调用 DescribeSecurityGroups 接口查询安全组信息，包括安全组 ID。单个白名单单次最多可选择添加 10 个安全组。该字段不能与 SecurityGroupBindInfos 同时使用。
UpdateSecurityGroup bool: 是否更新白名单所绑定的安全组。true：更新。false：不更新。默认值。说明该字段仅在白名单已绑定了安全组时生效。可调用 DescribeAllowLists 接口查询白名单是否绑定了安全组。
UserAllowLists []string: 该名单中由用户输入的 IP 地址。AllowList 字段中的 IP 为 UserAllowList 和 SecurityGroupBindInfos 包含的 IP 的并集。

allowListCategory String: 白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时，默认值为 Ordinary。
allowListDesc String: 白名单的备注。
allowListId String: 白名单 ID 。
allowListIpNum Integer: 白名单内的 IP 地址（或地址段）总数。
allowListName String: 白名单名称。
allowListType String: 白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
allowLists List<String>: 白名单内的 IP 地址列表
associatedInstanceNum Integer: 白名单下绑定的实例总数。
associatedInstances List<GetAllowListAssociatedInstance>: 已绑定当前白名单的实例信息。
id String: Uniquely identifies the resource.
ignoreInstanceStatus Boolean: 是否忽略实例状态校验。取值：true：是。false：否。默认值。
instanceId String: 实例 ID。
ipLists List<String>: 白名单包含的 IP 地址和 IP 地址段的列表。在请求参数 WithIpList 取值为 true 时返回，在取值为 false 或不为其传值时返回为 null。
modifyMode String: 修改方式，取值范围如下：Cover（默认值）：使用 AllowList 参数中的值覆盖原白名单。Append：在原白名单中增加 AllowList 参数中输入的 IP 地址。Delete：在原白名单中删除 AllowList 参数中输入的 IP 地址。至少需要保留一个 IP 地址。
projectName String: 所属的项目。说明如您调用接口使用的 AK/SK 属于某个子账号，且该子账号只拥有某个项目的权限，需要传入该请求参数。
securityGroupBindInfos List<GetAllowListSecurityGroupBindInfo>: 白名单关联的安全组的信息。说明该字段不能与 SecurityGroupIds 同时使用。
securityGroupIds List<String>: 需要关联的安全组 ID 列表。说明您可以调用 DescribeSecurityGroups 接口查询安全组信息，包括安全组 ID。单个白名单单次最多可选择添加 10 个安全组。该字段不能与 SecurityGroupBindInfos 同时使用。
updateSecurityGroup Boolean: 是否更新白名单所绑定的安全组。true：更新。false：不更新。默认值。说明该字段仅在白名单已绑定了安全组时生效。可调用 DescribeAllowLists 接口查询白名单是否绑定了安全组。
userAllowLists List<String>: 该名单中由用户输入的 IP 地址。AllowList 字段中的 IP 为 UserAllowList 和 SecurityGroupBindInfos 包含的 IP 的并集。

allowListCategory string: 白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时，默认值为 Ordinary。
allowListDesc string: 白名单的备注。
allowListId string: 白名单 ID 。
allowListIpNum number: 白名单内的 IP 地址（或地址段）总数。
allowListName string: 白名单名称。
allowListType string: 白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
allowLists string[]: 白名单内的 IP 地址列表
associatedInstanceNum number: 白名单下绑定的实例总数。
associatedInstances GetAllowListAssociatedInstance[]: 已绑定当前白名单的实例信息。
id string: Uniquely identifies the resource.
ignoreInstanceStatus boolean: 是否忽略实例状态校验。取值：true：是。false：否。默认值。
instanceId string: 实例 ID。
ipLists string[]: 白名单包含的 IP 地址和 IP 地址段的列表。在请求参数 WithIpList 取值为 true 时返回，在取值为 false 或不为其传值时返回为 null。
modifyMode string: 修改方式，取值范围如下：Cover（默认值）：使用 AllowList 参数中的值覆盖原白名单。Append：在原白名单中增加 AllowList 参数中输入的 IP 地址。Delete：在原白名单中删除 AllowList 参数中输入的 IP 地址。至少需要保留一个 IP 地址。
projectName string: 所属的项目。说明如您调用接口使用的 AK/SK 属于某个子账号，且该子账号只拥有某个项目的权限，需要传入该请求参数。
securityGroupBindInfos GetAllowListSecurityGroupBindInfo[]: 白名单关联的安全组的信息。说明该字段不能与 SecurityGroupIds 同时使用。
securityGroupIds string[]: 需要关联的安全组 ID 列表。说明您可以调用 DescribeSecurityGroups 接口查询安全组信息，包括安全组 ID。单个白名单单次最多可选择添加 10 个安全组。该字段不能与 SecurityGroupBindInfos 同时使用。
updateSecurityGroup boolean: 是否更新白名单所绑定的安全组。true：更新。false：不更新。默认值。说明该字段仅在白名单已绑定了安全组时生效。可调用 DescribeAllowLists 接口查询白名单是否绑定了安全组。
userAllowLists string[]: 该名单中由用户输入的 IP 地址。AllowList 字段中的 IP 为 UserAllowList 和 SecurityGroupBindInfos 包含的 IP 的并集。

allow_list_category str: 白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时，默认值为 Ordinary。
allow_list_desc str: 白名单的备注。
allow_list_id str: 白名单 ID 。
allow_list_ip_num int: 白名单内的 IP 地址（或地址段）总数。
allow_list_name str: 白名单名称。
allow_list_type str: 白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
allow_lists Sequence[str]: 白名单内的 IP 地址列表
associated_instance_num int: 白名单下绑定的实例总数。
associated_instances Sequence[GetAllowListAssociatedInstance]: 已绑定当前白名单的实例信息。
id str: Uniquely identifies the resource.
ignore_instance_status bool: 是否忽略实例状态校验。取值：true：是。false：否。默认值。
instance_id str: 实例 ID。
ip_lists Sequence[str]: 白名单包含的 IP 地址和 IP 地址段的列表。在请求参数 WithIpList 取值为 true 时返回，在取值为 false 或不为其传值时返回为 null。
modify_mode str: 修改方式，取值范围如下：Cover（默认值）：使用 AllowList 参数中的值覆盖原白名单。Append：在原白名单中增加 AllowList 参数中输入的 IP 地址。Delete：在原白名单中删除 AllowList 参数中输入的 IP 地址。至少需要保留一个 IP 地址。
project_name str: 所属的项目。说明如您调用接口使用的 AK/SK 属于某个子账号，且该子账号只拥有某个项目的权限，需要传入该请求参数。
security_group_bind_infos Sequence[GetAllowListSecurityGroupBindInfo]: 白名单关联的安全组的信息。说明该字段不能与 SecurityGroupIds 同时使用。
security_group_ids Sequence[str]: 需要关联的安全组 ID 列表。说明您可以调用 DescribeSecurityGroups 接口查询安全组信息，包括安全组 ID。单个白名单单次最多可选择添加 10 个安全组。该字段不能与 SecurityGroupBindInfos 同时使用。
update_security_group bool: 是否更新白名单所绑定的安全组。true：更新。false：不更新。默认值。说明该字段仅在白名单已绑定了安全组时生效。可调用 DescribeAllowLists 接口查询白名单是否绑定了安全组。
user_allow_lists Sequence[str]: 该名单中由用户输入的 IP 地址。AllowList 字段中的 IP 为 UserAllowList 和 SecurityGroupBindInfos 包含的 IP 的并集。

allowListCategory String: 白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时，默认值为 Ordinary。
allowListDesc String: 白名单的备注。
allowListId String: 白名单 ID 。
allowListIpNum Number: 白名单内的 IP 地址（或地址段）总数。
allowListName String: 白名单名称。
allowListType String: 白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
allowLists List<String>: 白名单内的 IP 地址列表
associatedInstanceNum Number: 白名单下绑定的实例总数。
associatedInstances List<Property Map>: 已绑定当前白名单的实例信息。
id String: Uniquely identifies the resource.
ignoreInstanceStatus Boolean: 是否忽略实例状态校验。取值：true：是。false：否。默认值。
instanceId String: 实例 ID。
ipLists List<String>: 白名单包含的 IP 地址和 IP 地址段的列表。在请求参数 WithIpList 取值为 true 时返回，在取值为 false 或不为其传值时返回为 null。
modifyMode String: 修改方式，取值范围如下：Cover（默认值）：使用 AllowList 参数中的值覆盖原白名单。Append：在原白名单中增加 AllowList 参数中输入的 IP 地址。Delete：在原白名单中删除 AllowList 参数中输入的 IP 地址。至少需要保留一个 IP 地址。
projectName String: 所属的项目。说明如您调用接口使用的 AK/SK 属于某个子账号，且该子账号只拥有某个项目的权限，需要传入该请求参数。
securityGroupBindInfos List<Property Map>: 白名单关联的安全组的信息。说明该字段不能与 SecurityGroupIds 同时使用。
securityGroupIds List<String>: 需要关联的安全组 ID 列表。说明您可以调用 DescribeSecurityGroups 接口查询安全组信息，包括安全组 ID。单个白名单单次最多可选择添加 10 个安全组。该字段不能与 SecurityGroupBindInfos 同时使用。
updateSecurityGroup Boolean: 是否更新白名单所绑定的安全组。true：更新。false：不更新。默认值。说明该字段仅在白名单已绑定了安全组时生效。可调用 DescribeAllowLists 接口查询白名单是否绑定了安全组。
userAllowLists List<String>: 该名单中由用户输入的 IP 地址。AllowList 字段中的 IP 为 UserAllowList 和 SecurityGroupBindInfos 包含的 IP 的并集。

Supporting Types

GetAllowListAssociatedInstance

InstanceId string: 已绑定当前白名单的实例 ID。
InstanceName string: 已绑定当前白名单的实例名称。
InstanceStatus string: 实例状态。
IsLatest bool: 是否已同步最新的白名单。取值：true：是。false：否。说明在修改白名单时，如实例状态未处于运行中，白名单的修改不会立即同步到实例。
Vpc string: 实例所属的私有网络 ID。

InstanceId string: 已绑定当前白名单的实例 ID。
InstanceName string: 已绑定当前白名单的实例名称。
InstanceStatus string: 实例状态。
IsLatest bool: 是否已同步最新的白名单。取值：true：是。false：否。说明在修改白名单时，如实例状态未处于运行中，白名单的修改不会立即同步到实例。
Vpc string: 实例所属的私有网络 ID。

instanceId String: 已绑定当前白名单的实例 ID。
instanceName String: 已绑定当前白名单的实例名称。
instanceStatus String: 实例状态。
isLatest Boolean: 是否已同步最新的白名单。取值：true：是。false：否。说明在修改白名单时，如实例状态未处于运行中，白名单的修改不会立即同步到实例。
vpc String: 实例所属的私有网络 ID。

instanceId string: 已绑定当前白名单的实例 ID。
instanceName string: 已绑定当前白名单的实例名称。
instanceStatus string: 实例状态。
isLatest boolean: 是否已同步最新的白名单。取值：true：是。false：否。说明在修改白名单时，如实例状态未处于运行中，白名单的修改不会立即同步到实例。
vpc string: 实例所属的私有网络 ID。

instance_id str: 已绑定当前白名单的实例 ID。
instance_name str: 已绑定当前白名单的实例名称。
instance_status str: 实例状态。
is_latest bool: 是否已同步最新的白名单。取值：true：是。false：否。说明在修改白名单时，如实例状态未处于运行中，白名单的修改不会立即同步到实例。
vpc str: 实例所属的私有网络 ID。

instanceId String: 已绑定当前白名单的实例 ID。
instanceName String: 已绑定当前白名单的实例名称。
instanceStatus String: 实例状态。
isLatest Boolean: 是否已同步最新的白名单。取值：true：是。false：否。说明在修改白名单时，如实例状态未处于运行中，白名单的修改不会立即同步到实例。
vpc String: 实例所属的私有网络 ID。

GetAllowListSecurityGroupBindInfo

BindMode string: 关联安全组的模式。取值：IngressDirectionIp：入方向 IP。AssociateEcsIp：关联 ECSIP。说明在 CreateAllowList 接口中，SecurityGroupBindInfoObject 的 BindMode 和 SecurityGroupId 字段为必填项。
IpLists List<string>: 安全组的 IP 地址列表。
SecurityGroupId string: 安全组 ID。
SecurityGroupName string: 安全组名称。

BindMode string: 关联安全组的模式。取值：IngressDirectionIp：入方向 IP。AssociateEcsIp：关联 ECSIP。说明在 CreateAllowList 接口中，SecurityGroupBindInfoObject 的 BindMode 和 SecurityGroupId 字段为必填项。
IpLists []string: 安全组的 IP 地址列表。
SecurityGroupId string: 安全组 ID。
SecurityGroupName string: 安全组名称。

bindMode String: 关联安全组的模式。取值：IngressDirectionIp：入方向 IP。AssociateEcsIp：关联 ECSIP。说明在 CreateAllowList 接口中，SecurityGroupBindInfoObject 的 BindMode 和 SecurityGroupId 字段为必填项。
ipLists List<String>: 安全组的 IP 地址列表。
securityGroupId String: 安全组 ID。
securityGroupName String: 安全组名称。

bindMode string: 关联安全组的模式。取值：IngressDirectionIp：入方向 IP。AssociateEcsIp：关联 ECSIP。说明在 CreateAllowList 接口中，SecurityGroupBindInfoObject 的 BindMode 和 SecurityGroupId 字段为必填项。
ipLists string[]: 安全组的 IP 地址列表。
securityGroupId string: 安全组 ID。
securityGroupName string: 安全组名称。

bind_mode str: 关联安全组的模式。取值：IngressDirectionIp：入方向 IP。AssociateEcsIp：关联 ECSIP。说明在 CreateAllowList 接口中，SecurityGroupBindInfoObject 的 BindMode 和 SecurityGroupId 字段为必填项。
ip_lists Sequence[str]: 安全组的 IP 地址列表。
security_group_id str: 安全组 ID。
security_group_name str: 安全组名称。

bindMode String: 关联安全组的模式。取值：IngressDirectionIp：入方向 IP。AssociateEcsIp：关联 ECSIP。说明在 CreateAllowList 接口中，SecurityGroupBindInfoObject 的 BindMode 和 SecurityGroupId 字段为必填项。
ipLists List<String>: 安全组的 IP 地址列表。
securityGroupId String: 安全组 ID。
securityGroupName String: 安全组名称。