Skip to main content

Parameters

See plugin common configurations for configuration options available to all plugins.

  • proto_id

    string or integer


    required


    ID of the APISIX proto resource, which contains the protocol buffer definitions.

  • service

    string


    required


    Name of the gRPC service.

  • method

    string


    required


    Method name of the gRPC service.

  • deadline

    number


    default: 0


    Deadline for the gRPC service in ms. This is the time APISIX will wait for a gRPC call to complete.

  • pb_option

    array[string]


    Encoder and decoder options. The option can be configured as an array of one or more of the below values:

    For enum as result: enum_as_name, enum_as_value

    For int64 as result: int64_as_number, int64_as_string, int64_as_hexstring

    For default values: auto_default_values, no_default_values, use_default_values, use_default_metatable

    For hooks: enable_hooks, disable_hooks

  • show_status_in_body

    boolean


    default: false


    If true, display the parsed grpc-status-details-bin in the response body.

  • status_detail_type

    string


    The message type corresponding to the details part of grpc-status-details-bin. If not specified, the error message will not be decoded.


API7.ai Logo

API Management for Modern Architectures with Edge, API Gateway, Kubernetes, and Service Mesh.

Product

API7 Cloud

SOC2 Type IIISO 27001HIPAAGDPRRed Herring

Copyright © APISEVEN PTE. LTD 2019 – 2024. Apache, Apache APISIX, APISIX, and associated open source project names are trademarks of the

Apache Software Foundation