1. Packages
  2. Bytepluscc Provider
  3. API Docs
  4. kafka
  5. getAllowList
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.kafka.getAllowList

bytepluscc logo
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    Data Source schema for Byteplus::Kafka::AllowList

    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:kafka/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:

    AllowList string
    白名单规则列表。支持指定为 IP 地址或者 IP 网段。多个 IP 地址或网段之间使用英文逗号（,）分隔。每个白名单最多可配置 300 个 IP 地址或网段。
    AllowListDesc string
    白名单描述。长度不超过200个字符。
    AllowListId string
    白名单 ID。
    AllowListIpNum int
    白名单指定的规则个数。
    AllowListName string
    白名单规则名称。长度为 1～128 个字符。只能包含中文、字母、数字、下划线和连字符（-）。不能以数字或连字符（-）开头。白名单名称在当前地域下唯一。
    ApplyInstanceNum int
    此白名单已绑定的实例数量。若指定 AllowList 参数，则此字段必填，用于指定规则修改后预期将会影响到的实例个数。若预期影响个数与实际影响个数不符，则请求失败。
    AssociatedInstanceNum int
    白名单绑定的实例个数。
    AssociatedInstances List<Byteplus.GetAllowListAssociatedInstance>
    白名单绑定的实例信息。
    Id string
    Uniquely identifies the resource.
    AllowList string
    白名单规则列表。支持指定为 IP 地址或者 IP 网段。多个 IP 地址或网段之间使用英文逗号（,）分隔。每个白名单最多可配置 300 个 IP 地址或网段。
    AllowListDesc string
    白名单描述。长度不超过200个字符。
    AllowListId string
    白名单 ID。
    AllowListIpNum int
    白名单指定的规则个数。
    AllowListName string
    白名单规则名称。长度为 1～128 个字符。只能包含中文、字母、数字、下划线和连字符（-）。不能以数字或连字符（-）开头。白名单名称在当前地域下唯一。
    ApplyInstanceNum int
    此白名单已绑定的实例数量。若指定 AllowList 参数，则此字段必填，用于指定规则修改后预期将会影响到的实例个数。若预期影响个数与实际影响个数不符，则请求失败。
    AssociatedInstanceNum int
    白名单绑定的实例个数。
    AssociatedInstances []GetAllowListAssociatedInstance
    白名单绑定的实例信息。
    Id string
    Uniquely identifies the resource.
    allowList String
    白名单规则列表。支持指定为 IP 地址或者 IP 网段。多个 IP 地址或网段之间使用英文逗号（,）分隔。每个白名单最多可配置 300 个 IP 地址或网段。
    allowListDesc String
    白名单描述。长度不超过200个字符。
    allowListId String
    白名单 ID。
    allowListIpNum Integer
    白名单指定的规则个数。
    allowListName String
    白名单规则名称。长度为 1～128 个字符。只能包含中文、字母、数字、下划线和连字符（-）。不能以数字或连字符（-）开头。白名单名称在当前地域下唯一。
    applyInstanceNum Integer
    此白名单已绑定的实例数量。若指定 AllowList 参数，则此字段必填，用于指定规则修改后预期将会影响到的实例个数。若预期影响个数与实际影响个数不符，则请求失败。
    associatedInstanceNum Integer
    白名单绑定的实例个数。
    associatedInstances List<GetAllowListAssociatedInstance>
    白名单绑定的实例信息。
    id String
    Uniquely identifies the resource.
    allowList string
    白名单规则列表。支持指定为 IP 地址或者 IP 网段。多个 IP 地址或网段之间使用英文逗号（,）分隔。每个白名单最多可配置 300 个 IP 地址或网段。
    allowListDesc string
    白名单描述。长度不超过200个字符。
    allowListId string
    白名单 ID。
    allowListIpNum number
    白名单指定的规则个数。
    allowListName string
    白名单规则名称。长度为 1～128 个字符。只能包含中文、字母、数字、下划线和连字符（-）。不能以数字或连字符（-）开头。白名单名称在当前地域下唯一。
    applyInstanceNum number
    此白名单已绑定的实例数量。若指定 AllowList 参数，则此字段必填，用于指定规则修改后预期将会影响到的实例个数。若预期影响个数与实际影响个数不符，则请求失败。
    associatedInstanceNum number
    白名单绑定的实例个数。
    associatedInstances GetAllowListAssociatedInstance[]
    白名单绑定的实例信息。
    id string
    Uniquely identifies the resource.
    allow_list str
    白名单规则列表。支持指定为 IP 地址或者 IP 网段。多个 IP 地址或网段之间使用英文逗号（,）分隔。每个白名单最多可配置 300 个 IP 地址或网段。
    allow_list_desc str
    白名单描述。长度不超过200个字符。
    allow_list_id str
    白名单 ID。
    allow_list_ip_num int
    白名单指定的规则个数。
    allow_list_name str
    白名单规则名称。长度为 1～128 个字符。只能包含中文、字母、数字、下划线和连字符（-）。不能以数字或连字符（-）开头。白名单名称在当前地域下唯一。
    apply_instance_num int
    此白名单已绑定的实例数量。若指定 AllowList 参数，则此字段必填，用于指定规则修改后预期将会影响到的实例个数。若预期影响个数与实际影响个数不符，则请求失败。
    associated_instance_num int
    白名单绑定的实例个数。
    associated_instances Sequence[GetAllowListAssociatedInstance]
    白名单绑定的实例信息。
    id str
    Uniquely identifies the resource.
    allowList String
    白名单规则列表。支持指定为 IP 地址或者 IP 网段。多个 IP 地址或网段之间使用英文逗号（,）分隔。每个白名单最多可配置 300 个 IP 地址或网段。
    allowListDesc String
    白名单描述。长度不超过200个字符。
    allowListId String
    白名单 ID。
    allowListIpNum Number
    白名单指定的规则个数。
    allowListName String
    白名单规则名称。长度为 1～128 个字符。只能包含中文、字母、数字、下划线和连字符（-）。不能以数字或连字符（-）开头。白名单名称在当前地域下唯一。
    applyInstanceNum Number
    此白名单已绑定的实例数量。若指定 AllowList 参数，则此字段必填，用于指定规则修改后预期将会影响到的实例个数。若预期影响个数与实际影响个数不符，则请求失败。
    associatedInstanceNum Number
    白名单绑定的实例个数。
    associatedInstances List<Property Map>
    白名单绑定的实例信息。
    id String
    Uniquely identifies the resource.

    Supporting Types

    GetAllowListAssociatedInstance

    InstanceId string
    白名单绑定的实例ID。
    InstanceName string
    白名单绑定的实例名称。
    InstanceId string
    白名单绑定的实例ID。
    InstanceName string
    白名单绑定的实例名称。
    instanceId String
    白名单绑定的实例ID。
    instanceName String
    白名单绑定的实例名称。
    instanceId string
    白名单绑定的实例ID。
    instanceName string
    白名单绑定的实例名称。
    instance_id str
    白名单绑定的实例ID。
    instance_name str
    白名单绑定的实例名称。
    instanceId String
    白名单绑定的实例ID。
    instanceName String
    白名单绑定的实例名称。

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.16
    published on Monday, Mar 9, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc
      Try Pulumi Cloud free. Your team will thank you.