Documentation Index

Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

PolicyDetailResponse

Prev Next

Available in VPC

These are policy details.

Syntax

The syntax is as follows.

public class PolicyRequest { 
    private Long sid;
    private String name;
    private Long geoMapId;
    private LoadBalancerType lbType;
    private Long geoMapId;
    private List<ResourceGroup> resourceGroups;
    private Monitor monitor;
    private Long createdDate;
    private List<String> domainNames;
    private Boolean monitoringYn;
}


public class ResourceGroup { 
    private Long sid;
    private Long geoMapDetailId;
    private String geoMapDetailName;
    private Long weighted;
    private List<Resource> active;
    private List<Resource> standby;
}

public class Resource { 
    private String content;
    private Long healthCheckRegionId;
    private RegionCode healthCheckRegionCode;
    private ResourceType type;
    private Status status;
}

public class Monitor { 
    private String hostHeader; 
    private String path;
    private Long period;
    private Long port;
    private String protocol;
    private Long thresholdFail;
    private Long thresholdNormal;
    private Boolean advancedYn;
}

Field

The following describes the fields.

PolicyRequest

Parameter name Type Required Description
sid Long - Policy ID
name String - Policy Name
geoMapId Long - Geo/CIDR Map ID
lbType Enum - Load balancer type
  • ROUND_ROBIN | WEIGHTED_ROUND_ROBIN | GEOLOCATION | CIDR
resourceGroups List<ResourceGroups> - Resource group information
monitor Monitor - Health check monitoring information
createdDate Long - Creation date and time (UTC 0)
domainNames List<String> - Connected domain (profile)
monitoringYn Boolean - Health check usage status
  • true | false

ResourceGroup

Parameter name Type Required Description
sid Long - Resource group ID
geoMapDetailId Long - Geo/CIDR map details ID
geoMapDetailName String - Geo/CIDR map details name
weighted Long - Weights used when LBType is WEIGHTED_ROUND_ROBIN
active List<Resource> - Active resource information
standby List<Resource> - Backup resource information
monitor Monitor - Health check monitoring information

Resource

Parameter name Type Required Description
content String - Resource value
type Enum - Resource type
  • PUBLIC_IP | EXTERNAL_DOMAIN
healthCheckRegionId Long - Health check Region ID
healthCheckRegionCode Enum - Region code
  • KR | JP | SG | DE | USW
status Enum - Health check status
  • UP | DOWN | UNKNOWN

Monitor

Parameter name Type Required Description
hostHeader String - Host header
path String - Path
period Long - Health check interval
port Long - Port
  • 0 - 65535
protocol String - Protocol
  • HTTP | HTTPS | TCP
thresholdFail Long - Failure threshold
  • 1 (default)
thresholdNormal Long - Normal threshold
  • 1 (default)
advancedYn Boolean - Whether to set advanced health checks
  • true | false