1. Registry
  2. Packages
  3. Bytepluscc Provider
  4. API Docs
  5. securitycenter
  6. getAgent
Viewing docs for bytepluscc v0.0.56
published on Monday, Oct 26, 2026 by Byteplus
bytepluscc logo bytepluscc
Viewing docs for bytepluscc v0.0.56
published on Monday, Oct 26, 2026 by Byteplus

    Data Source schema for Byteplus::SecurityCenter::Agent

    Using getAgent

    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 getAgent(args: GetAgentArgs, opts?: InvokeOptions): Promise<GetAgentResult>
    function getAgentOutput(args: GetAgentOutputArgs, opts?: InvokeOutputOptions): Output<GetAgentResult>
    def get_agent(id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetAgentResult
    def get_agent_output(id: pulumi.Input[Optional[str]] = None,
                  opts: Optional[InvokeOutputOptions] = None) -> Output[GetAgentResult]
    func LookupAgent(ctx *Context, args *LookupAgentArgs, opts ...InvokeOption) (*LookupAgentResult, error)
    func LookupAgentOutput(ctx *Context, args *LookupAgentOutputArgs, opts ...InvokeOption) LookupAgentResultOutput

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

    public static class GetAgent 
    {
        public static Task<GetAgentResult> InvokeAsync(GetAgentArgs args, InvokeOptions? opts = null)
        public static Output<GetAgentResult> Invoke(GetAgentInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetAgentResult> Invoke(GetAgentInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetAgentResult> getAgent(GetAgentArgs args, InvokeOptions options)
    public static Output<GetAgentResult> getAgent(GetAgentArgs args, InvokeOptions options)
    public static Output<GetAgentResult> getAgent(GetAgentArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: bytepluscc:securitycenter/getAgent:getAgent
      arguments:
        # arguments dictionary
    data "bytepluscc_securitycenter_get_agent" "name" {
        # arguments
    }

    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 string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getAgent Result

    The following output properties are available:

    AbnormalPluginsList string
    Abnormal plugin list
    AgentId string
    Agent unique ID, which is also the security Agent identifier for the host. Installation, uninstallation, and queries are based on this ID.
    AgentStatus string
    Agent status
    AutoProtectConfig Byteplus.GetAgentAutoProtectConfig
    Host auto protection configuration (returned by GetAutoProtectConfig API)
    CloudProvider string
    Cloud vendor information
    EcsInstance Byteplus.GetAgentEcsInstance
    Basic information of the cloud host (ECS) corresponding to the host where the Agent resides
    Group string
    Host group
    GroupPath string
    Host group path
    Id string
    Uniquely identifies the resource.
    LastHeartbeatTime int
    Last heartbeat time
    OldValidCode int
    Old valid status code
    Online bool
    Agent online status
    Platform string
    Platform
    PluginsStatus string
    Plugin status
    Reason string
    Status reason description
    SecurityEnhancement bool
    Enable security hardening
    Status string
    Host/Agent overall status
    Tags List<string>
    Tag list
    UserStatus string
    User-side status
    UserStatusReason string
    User-side status reason
    UserStatusReasonCode int
    User-side status reason code
    AbnormalPluginsList string
    Abnormal plugin list
    AgentId string
    Agent unique ID, which is also the security Agent identifier for the host. Installation, uninstallation, and queries are based on this ID.
    AgentStatus string
    Agent status
    AutoProtectConfig GetAgentAutoProtectConfig
    Host auto protection configuration (returned by GetAutoProtectConfig API)
    CloudProvider string
    Cloud vendor information
    EcsInstance GetAgentEcsInstance
    Basic information of the cloud host (ECS) corresponding to the host where the Agent resides
    Group string
    Host group
    GroupPath string
    Host group path
    Id string
    Uniquely identifies the resource.
    LastHeartbeatTime int
    Last heartbeat time
    OldValidCode int
    Old valid status code
    Online bool
    Agent online status
    Platform string
    Platform
    PluginsStatus string
    Plugin status
    Reason string
    Status reason description
    SecurityEnhancement bool
    Enable security hardening
    Status string
    Host/Agent overall status
    Tags []string
    Tag list
    UserStatus string
    User-side status
    UserStatusReason string
    User-side status reason
    UserStatusReasonCode int
    User-side status reason code
    abnormal_plugins_list string
    Abnormal plugin list
    agent_id string
    Agent unique ID, which is also the security Agent identifier for the host. Installation, uninstallation, and queries are based on this ID.
    agent_status string
    Agent status
    auto_protect_config object
    Host auto protection configuration (returned by GetAutoProtectConfig API)
    cloud_provider string
    Cloud vendor information
    ecs_instance object
    Basic information of the cloud host (ECS) corresponding to the host where the Agent resides
    group string
    Host group
    group_path string
    Host group path
    id string
    Uniquely identifies the resource.
    last_heartbeat_time number
    Last heartbeat time
    old_valid_code number
    Old valid status code
    online bool
    Agent online status
    platform string
    Platform
    plugins_status string
    Plugin status
    reason string
    Status reason description
    security_enhancement bool
    Enable security hardening
    status string
    Host/Agent overall status
    tags list(string)
    Tag list
    user_status string
    User-side status
    user_status_reason string
    User-side status reason
    user_status_reason_code number
    User-side status reason code
    abnormalPluginsList String
    Abnormal plugin list
    agentId String
    Agent unique ID, which is also the security Agent identifier for the host. Installation, uninstallation, and queries are based on this ID.
    agentStatus String
    Agent status
    autoProtectConfig GetAgentAutoProtectConfig
    Host auto protection configuration (returned by GetAutoProtectConfig API)
    cloudProvider String
    Cloud vendor information
    ecsInstance GetAgentEcsInstance
    Basic information of the cloud host (ECS) corresponding to the host where the Agent resides
    group String
    Host group
    groupPath String
    Host group path
    id String
    Uniquely identifies the resource.
    lastHeartbeatTime Integer
    Last heartbeat time
    oldValidCode Integer
    Old valid status code
    online Boolean
    Agent online status
    platform String
    Platform
    pluginsStatus String
    Plugin status
    reason String
    Status reason description
    securityEnhancement Boolean
    Enable security hardening
    status String
    Host/Agent overall status
    tags List<String>
    Tag list
    userStatus String
    User-side status
    userStatusReason String
    User-side status reason
    userStatusReasonCode Integer
    User-side status reason code
    abnormalPluginsList string
    Abnormal plugin list
    agentId string
    Agent unique ID, which is also the security Agent identifier for the host. Installation, uninstallation, and queries are based on this ID.
    agentStatus string
    Agent status
    autoProtectConfig GetAgentAutoProtectConfig
    Host auto protection configuration (returned by GetAutoProtectConfig API)
    cloudProvider string
    Cloud vendor information
    ecsInstance GetAgentEcsInstance
    Basic information of the cloud host (ECS) corresponding to the host where the Agent resides
    group string
    Host group
    groupPath string
    Host group path
    id string
    Uniquely identifies the resource.
    lastHeartbeatTime number
    Last heartbeat time
    oldValidCode number
    Old valid status code
    online boolean
    Agent online status
    platform string
    Platform
    pluginsStatus string
    Plugin status
    reason string
    Status reason description
    securityEnhancement boolean
    Enable security hardening
    status string
    Host/Agent overall status
    tags string[]
    Tag list
    userStatus string
    User-side status
    userStatusReason string
    User-side status reason
    userStatusReasonCode number
    User-side status reason code
    abnormal_plugins_list str
    Abnormal plugin list
    agent_id str
    Agent unique ID, which is also the security Agent identifier for the host. Installation, uninstallation, and queries are based on this ID.
    agent_status str
    Agent status
    auto_protect_config GetAgentAutoProtectConfig
    Host auto protection configuration (returned by GetAutoProtectConfig API)
    cloud_provider str
    Cloud vendor information
    ecs_instance GetAgentEcsInstance
    Basic information of the cloud host (ECS) corresponding to the host where the Agent resides
    group str
    Host group
    group_path str
    Host group path
    id str
    Uniquely identifies the resource.
    last_heartbeat_time int
    Last heartbeat time
    old_valid_code int
    Old valid status code
    online bool
    Agent online status
    platform str
    Platform
    plugins_status str
    Plugin status
    reason str
    Status reason description
    security_enhancement bool
    Enable security hardening
    status str
    Host/Agent overall status
    tags Sequence[str]
    Tag list
    user_status str
    User-side status
    user_status_reason str
    User-side status reason
    user_status_reason_code int
    User-side status reason code
    abnormalPluginsList String
    Abnormal plugin list
    agentId String
    Agent unique ID, which is also the security Agent identifier for the host. Installation, uninstallation, and queries are based on this ID.
    agentStatus String
    Agent status
    autoProtectConfig Property Map
    Host auto protection configuration (returned by GetAutoProtectConfig API)
    cloudProvider String
    Cloud vendor information
    ecsInstance Property Map
    Basic information of the cloud host (ECS) corresponding to the host where the Agent resides
    group String
    Host group
    groupPath String
    Host group path
    id String
    Uniquely identifies the resource.
    lastHeartbeatTime Number
    Last heartbeat time
    oldValidCode Number
    Old valid status code
    online Boolean
    Agent online status
    platform String
    Platform
    pluginsStatus String
    Plugin status
    reason String
    Status reason description
    securityEnhancement Boolean
    Enable security hardening
    status String
    Host/Agent overall status
    tags List<String>
    Tag list
    userStatus String
    User-side status
    userStatusReason String
    User-side status reason
    userStatusReasonCode Number
    User-side status reason code

    Supporting Types

    GetAgentAutoProtectConfig

    Enable bool
    Enable auto protection
    UpdateTime int
    Auto protection configuration update time (timestamp)
    Enable bool
    Enable auto protection
    UpdateTime int
    Auto protection configuration update time (timestamp)
    enable bool
    Enable auto protection
    update_time number
    Auto protection configuration update time (timestamp)
    enable Boolean
    Enable auto protection
    updateTime Integer
    Auto protection configuration update time (timestamp)
    enable boolean
    Enable auto protection
    updateTime number
    Auto protection configuration update time (timestamp)
    enable bool
    Enable auto protection
    update_time int
    Auto protection configuration update time (timestamp)
    enable Boolean
    Enable auto protection
    updateTime Number
    Auto protection configuration update time (timestamp)

    GetAgentEcsInstance

    AccessKey string
    Host AccessKey information
    AccountId string
    Host account ID
    Cpu int
    CPU core count
    CreatedAt string
    Host creation time
    EcsUpdateAt string
    ECS information update time
    EipAddress string
    Public IP address
    HostName string
    Host name
    InstanceName string
    Instance name
    IpLists List<string>
    Host IP list
    Mem int
    Memory size
    OsName string
    Operating system name
    OsType string
    Operating system type
    Platform string
    Platform
    PlatformVersion string
    Platform version
    PrimaryIpAddress string
    Main private IP address
    Region string
    Region
    SecurityEnhancementStrategy string
    Security hardening policy
    Status string
    Host status
    Visibility string
    Visibility
    VpcId string
    Private network VPC ID
    VpcName string
    Private network VPC name
    ZoneId string
    Zone ID
    AccessKey string
    Host AccessKey information
    AccountId string
    Host account ID
    Cpu int
    CPU core count
    CreatedAt string
    Host creation time
    EcsUpdateAt string
    ECS information update time
    EipAddress string
    Public IP address
    HostName string
    Host name
    InstanceName string
    Instance name
    IpLists []string
    Host IP list
    Mem int
    Memory size
    OsName string
    Operating system name
    OsType string
    Operating system type
    Platform string
    Platform
    PlatformVersion string
    Platform version
    PrimaryIpAddress string
    Main private IP address
    Region string
    Region
    SecurityEnhancementStrategy string
    Security hardening policy
    Status string
    Host status
    Visibility string
    Visibility
    VpcId string
    Private network VPC ID
    VpcName string
    Private network VPC name
    ZoneId string
    Zone ID
    access_key string
    Host AccessKey information
    account_id string
    Host account ID
    cpu number
    CPU core count
    created_at string
    Host creation time
    ecs_update_at string
    ECS information update time
    eip_address string
    Public IP address
    host_name string
    Host name
    instance_name string
    Instance name
    ip_lists list(string)
    Host IP list
    mem number
    Memory size
    os_name string
    Operating system name
    os_type string
    Operating system type
    platform string
    Platform
    platform_version string
    Platform version
    primary_ip_address string
    Main private IP address
    region string
    Region
    security_enhancement_strategy string
    Security hardening policy
    status string
    Host status
    visibility string
    Visibility
    vpc_id string
    Private network VPC ID
    vpc_name string
    Private network VPC name
    zone_id string
    Zone ID
    accessKey String
    Host AccessKey information
    accountId String
    Host account ID
    cpu Integer
    CPU core count
    createdAt String
    Host creation time
    ecsUpdateAt String
    ECS information update time
    eipAddress String
    Public IP address
    hostName String
    Host name
    instanceName String
    Instance name
    ipLists List<String>
    Host IP list
    mem Integer
    Memory size
    osName String
    Operating system name
    osType String
    Operating system type
    platform String
    Platform
    platformVersion String
    Platform version
    primaryIpAddress String
    Main private IP address
    region String
    Region
    securityEnhancementStrategy String
    Security hardening policy
    status String
    Host status
    visibility String
    Visibility
    vpcId String
    Private network VPC ID
    vpcName String
    Private network VPC name
    zoneId String
    Zone ID
    accessKey string
    Host AccessKey information
    accountId string
    Host account ID
    cpu number
    CPU core count
    createdAt string
    Host creation time
    ecsUpdateAt string
    ECS information update time
    eipAddress string
    Public IP address
    hostName string
    Host name
    instanceName string
    Instance name
    ipLists string[]
    Host IP list
    mem number
    Memory size
    osName string
    Operating system name
    osType string
    Operating system type
    platform string
    Platform
    platformVersion string
    Platform version
    primaryIpAddress string
    Main private IP address
    region string
    Region
    securityEnhancementStrategy string
    Security hardening policy
    status string
    Host status
    visibility string
    Visibility
    vpcId string
    Private network VPC ID
    vpcName string
    Private network VPC name
    zoneId string
    Zone ID
    access_key str
    Host AccessKey information
    account_id str
    Host account ID
    cpu int
    CPU core count
    created_at str
    Host creation time
    ecs_update_at str
    ECS information update time
    eip_address str
    Public IP address
    host_name str
    Host name
    instance_name str
    Instance name
    ip_lists Sequence[str]
    Host IP list
    mem int
    Memory size
    os_name str
    Operating system name
    os_type str
    Operating system type
    platform str
    Platform
    platform_version str
    Platform version
    primary_ip_address str
    Main private IP address
    region str
    Region
    security_enhancement_strategy str
    Security hardening policy
    status str
    Host status
    visibility str
    Visibility
    vpc_id str
    Private network VPC ID
    vpc_name str
    Private network VPC name
    zone_id str
    Zone ID
    accessKey String
    Host AccessKey information
    accountId String
    Host account ID
    cpu Number
    CPU core count
    createdAt String
    Host creation time
    ecsUpdateAt String
    ECS information update time
    eipAddress String
    Public IP address
    hostName String
    Host name
    instanceName String
    Instance name
    ipLists List<String>
    Host IP list
    mem Number
    Memory size
    osName String
    Operating system name
    osType String
    Operating system type
    platform String
    Platform
    platformVersion String
    Platform version
    primaryIpAddress String
    Main private IP address
    region String
    Region
    securityEnhancementStrategy String
    Security hardening policy
    status String
    Host status
    visibility String
    Visibility
    vpcId String
    Private network VPC ID
    vpcName String
    Private network VPC name
    zoneId String
    Zone ID

    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 bytepluscc
    Viewing docs for bytepluscc v0.0.56
    published on Monday, Oct 26, 2026 by Byteplus

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial