1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. clb
  6. getRule
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.clb.getRule

volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Data Source schema for Volcengine::CLB::Rule

    Using getRule

    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 getRule(args: GetRuleArgs, opts?: InvokeOptions): Promise<GetRuleResult>
function getRuleOutput(args: GetRuleOutputArgs, opts?: InvokeOptions): Output<GetRuleResult>
    def get_rule(id: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetRuleResult
def get_rule_output(id: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetRuleResult]
    func LookupRule(ctx *Context, args *LookupRuleArgs, opts ...InvokeOption) (*LookupRuleResult, error)
func LookupRuleOutput(ctx *Context, args *LookupRuleOutputArgs, opts ...InvokeOption) LookupRuleResultOutput

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

    public static class GetRule 
{
    public static Task<GetRuleResult> InvokeAsync(GetRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetRuleResult> Invoke(GetRuleInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRuleResult> getRule(GetRuleArgs args, InvokeOptions options)
public static Output<GetRuleResult> getRule(GetRuleArgs args, InvokeOptions options)

    fn::invoke:
  function: volcenginecc:clb/getRule:getRule
  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.

    getRule Result

    The following output properties are available:

    ActionType string
    Forwarding rule action. Options: Forward: Forward to. Redirect: Redirect to.
    Description string
    Description of the forwarding rule. Default value is an empty string. Specifications: Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length must be between 0 and 255 characters.
    Domain string
    Domain name of the forwarding rule.
    Id string
    Uniquely identifies the resource.
    ListenerId string
    Listener ID.
    RedirectConfig Volcengine.GetRuleRedirectConfig
    Redirection-related configuration information.
    RuleId string
    Forwarding rule ID.
    ServerGroupId string
    ID of the backend server group associated with the forwarding rule.
    Tags List<Volcengine.GetRuleTag>
    Tag list.
    Url string
    URL of the forwarding rule.
    ActionType string
    Forwarding rule action. Options: Forward: Forward to. Redirect: Redirect to.
    Description string
    Description of the forwarding rule. Default value is an empty string. Specifications: Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length must be between 0 and 255 characters.
    Domain string
    Domain name of the forwarding rule.
    Id string
    Uniquely identifies the resource.
    ListenerId string
    Listener ID.
    RedirectConfig GetRuleRedirectConfig
    Redirection-related configuration information.
    RuleId string
    Forwarding rule ID.
    ServerGroupId string
    ID of the backend server group associated with the forwarding rule.
    Tags []GetRuleTag
    Tag list.
    Url string
    URL of the forwarding rule.
    actionType String
    Forwarding rule action. Options: Forward: Forward to. Redirect: Redirect to.
    description String
    Description of the forwarding rule. Default value is an empty string. Specifications: Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length must be between 0 and 255 characters.
    domain String
    Domain name of the forwarding rule.
    id String
    Uniquely identifies the resource.
    listenerId String
    Listener ID.
    redirectConfig GetRuleRedirectConfig
    Redirection-related configuration information.
    ruleId String
    Forwarding rule ID.
    serverGroupId String
    ID of the backend server group associated with the forwarding rule.
    tags List<GetRuleTag>
    Tag list.
    url String
    URL of the forwarding rule.
    actionType string
    Forwarding rule action. Options: Forward: Forward to. Redirect: Redirect to.
    description string
    Description of the forwarding rule. Default value is an empty string. Specifications: Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length must be between 0 and 255 characters.
    domain string
    Domain name of the forwarding rule.
    id string
    Uniquely identifies the resource.
    listenerId string
    Listener ID.
    redirectConfig GetRuleRedirectConfig
    Redirection-related configuration information.
    ruleId string
    Forwarding rule ID.
    serverGroupId string
    ID of the backend server group associated with the forwarding rule.
    tags GetRuleTag[]
    Tag list.
    url string
    URL of the forwarding rule.
    action_type str
    Forwarding rule action. Options: Forward: Forward to. Redirect: Redirect to.
    description str
    Description of the forwarding rule. Default value is an empty string. Specifications: Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length must be between 0 and 255 characters.
    domain str
    Domain name of the forwarding rule.
    id str
    Uniquely identifies the resource.
    listener_id str
    Listener ID.
    redirect_config GetRuleRedirectConfig
    Redirection-related configuration information.
    rule_id str
    Forwarding rule ID.
    server_group_id str
    ID of the backend server group associated with the forwarding rule.
    tags Sequence[GetRuleTag]
    Tag list.
    url str
    URL of the forwarding rule.
    actionType String
    Forwarding rule action. Options: Forward: Forward to. Redirect: Redirect to.
    description String
    Description of the forwarding rule. Default value is an empty string. Specifications: Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length must be between 0 and 255 characters.
    domain String
    Domain name of the forwarding rule.
    id String
    Uniquely identifies the resource.
    listenerId String
    Listener ID.
    redirectConfig Property Map
    Redirection-related configuration information.
    ruleId String
    Forwarding rule ID.
    serverGroupId String
    ID of the backend server group associated with the forwarding rule.
    tags List<Property Map>
    Tag list.
    url String
    URL of the forwarding rule.

    Supporting Types

    GetRuleRedirectConfig

    Host string
    The domain name for forwarding rule redirection currently supports only exact domain names. Specifications: Must contain at least one '.', and cannot start or end with '.'. Only letters, numbers, '.', and '-' are allowed. Length must be between 1 and 128 characters. Example of a valid exact domain name: www.test.com.
    Path string
    Path for forwarding rule redirection. Specifications: Must start with a forward slash '/'. Consecutive '/' characters are not allowed. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=', and other specified characters are allowed. Length must be between 1 and 128 characters.
    Port string
    Port for forwarding rule redirection. Value range: 1~65535.
    Protocol string
    Protocol for forwarding rule redirection. Options: HTTP. HTTPS (default).
    StatusCode string
    Status code for forwarding rule redirection. Options: 301 (default): Indicates the requested resource has been permanently moved to a new URL. The client should use the new URL for subsequent requests. 302: Indicates the requested resource has been temporarily moved to a new URL and may change again in the future. The client should use the new URL for subsequent requests. 307: Similar to 302, but requires the client to keep the request method unchanged during redirection. For example, if the original request is GET, the redirected request remains GET. 308: Similar to 301, but requires the client to keep the request method unchanged during redirection.
    Host string
    The domain name for forwarding rule redirection currently supports only exact domain names. Specifications: Must contain at least one '.', and cannot start or end with '.'. Only letters, numbers, '.', and '-' are allowed. Length must be between 1 and 128 characters. Example of a valid exact domain name: www.test.com.
    Path string
    Path for forwarding rule redirection. Specifications: Must start with a forward slash '/'. Consecutive '/' characters are not allowed. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=', and other specified characters are allowed. Length must be between 1 and 128 characters.
    Port string
    Port for forwarding rule redirection. Value range: 1~65535.
    Protocol string
    Protocol for forwarding rule redirection. Options: HTTP. HTTPS (default).
    StatusCode string
    Status code for forwarding rule redirection. Options: 301 (default): Indicates the requested resource has been permanently moved to a new URL. The client should use the new URL for subsequent requests. 302: Indicates the requested resource has been temporarily moved to a new URL and may change again in the future. The client should use the new URL for subsequent requests. 307: Similar to 302, but requires the client to keep the request method unchanged during redirection. For example, if the original request is GET, the redirected request remains GET. 308: Similar to 301, but requires the client to keep the request method unchanged during redirection.
    host String
    The domain name for forwarding rule redirection currently supports only exact domain names. Specifications: Must contain at least one '.', and cannot start or end with '.'. Only letters, numbers, '.', and '-' are allowed. Length must be between 1 and 128 characters. Example of a valid exact domain name: www.test.com.
    path String
    Path for forwarding rule redirection. Specifications: Must start with a forward slash '/'. Consecutive '/' characters are not allowed. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=', and other specified characters are allowed. Length must be between 1 and 128 characters.
    port String
    Port for forwarding rule redirection. Value range: 1~65535.
    protocol String
    Protocol for forwarding rule redirection. Options: HTTP. HTTPS (default).
    statusCode String
    Status code for forwarding rule redirection. Options: 301 (default): Indicates the requested resource has been permanently moved to a new URL. The client should use the new URL for subsequent requests. 302: Indicates the requested resource has been temporarily moved to a new URL and may change again in the future. The client should use the new URL for subsequent requests. 307: Similar to 302, but requires the client to keep the request method unchanged during redirection. For example, if the original request is GET, the redirected request remains GET. 308: Similar to 301, but requires the client to keep the request method unchanged during redirection.
    host string
    The domain name for forwarding rule redirection currently supports only exact domain names. Specifications: Must contain at least one '.', and cannot start or end with '.'. Only letters, numbers, '.', and '-' are allowed. Length must be between 1 and 128 characters. Example of a valid exact domain name: www.test.com.
    path string
    Path for forwarding rule redirection. Specifications: Must start with a forward slash '/'. Consecutive '/' characters are not allowed. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=', and other specified characters are allowed. Length must be between 1 and 128 characters.
    port string
    Port for forwarding rule redirection. Value range: 1~65535.
    protocol string
    Protocol for forwarding rule redirection. Options: HTTP. HTTPS (default).
    statusCode string
    Status code for forwarding rule redirection. Options: 301 (default): Indicates the requested resource has been permanently moved to a new URL. The client should use the new URL for subsequent requests. 302: Indicates the requested resource has been temporarily moved to a new URL and may change again in the future. The client should use the new URL for subsequent requests. 307: Similar to 302, but requires the client to keep the request method unchanged during redirection. For example, if the original request is GET, the redirected request remains GET. 308: Similar to 301, but requires the client to keep the request method unchanged during redirection.
    host str
    The domain name for forwarding rule redirection currently supports only exact domain names. Specifications: Must contain at least one '.', and cannot start or end with '.'. Only letters, numbers, '.', and '-' are allowed. Length must be between 1 and 128 characters. Example of a valid exact domain name: www.test.com.
    path str
    Path for forwarding rule redirection. Specifications: Must start with a forward slash '/'. Consecutive '/' characters are not allowed. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=', and other specified characters are allowed. Length must be between 1 and 128 characters.
    port str
    Port for forwarding rule redirection. Value range: 1~65535.
    protocol str
    Protocol for forwarding rule redirection. Options: HTTP. HTTPS (default).
    status_code str
    Status code for forwarding rule redirection. Options: 301 (default): Indicates the requested resource has been permanently moved to a new URL. The client should use the new URL for subsequent requests. 302: Indicates the requested resource has been temporarily moved to a new URL and may change again in the future. The client should use the new URL for subsequent requests. 307: Similar to 302, but requires the client to keep the request method unchanged during redirection. For example, if the original request is GET, the redirected request remains GET. 308: Similar to 301, but requires the client to keep the request method unchanged during redirection.
    host String
    The domain name for forwarding rule redirection currently supports only exact domain names. Specifications: Must contain at least one '.', and cannot start or end with '.'. Only letters, numbers, '.', and '-' are allowed. Length must be between 1 and 128 characters. Example of a valid exact domain name: www.test.com.
    path String
    Path for forwarding rule redirection. Specifications: Must start with a forward slash '/'. Consecutive '/' characters are not allowed. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=', and other specified characters are allowed. Length must be between 1 and 128 characters.
    port String
    Port for forwarding rule redirection. Value range: 1~65535.
    protocol String
    Protocol for forwarding rule redirection. Options: HTTP. HTTPS (default).
    statusCode String
    Status code for forwarding rule redirection. Options: 301 (default): Indicates the requested resource has been permanently moved to a new URL. The client should use the new URL for subsequent requests. 302: Indicates the requested resource has been temporarily moved to a new URL and may change again in the future. The client should use the new URL for subsequent requests. 307: Similar to 302, but requires the client to keep the request method unchanged during redirection. For example, if the original request is GET, the redirected request remains GET. 308: Similar to 301, but requires the client to keep the request method unchanged during redirection.

    GetRuleTag

    Key string
    Tag key.
    Value string
    Tag value.
    Key string
    Tag key.
    Value string
    Tag value.
    key String
    Tag key.
    value String
    Tag value.
    key string
    Tag key.
    value string
    Tag value.
    key str
    Tag key.
    value str
    Tag value.
    key String
    Tag key.
    value String
    Tag value.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.