getService

volcenginecc v0.0.42, Jun 11 26

Viewing docs for volcenginecc v0.0.42
published on Thursday, Jun 11, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.42
published on Thursday, Jun 11, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Using getService

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 getService(args: GetServiceArgs, opts?: InvokeOptions): Promise<GetServiceResult>
function getServiceOutput(args: GetServiceOutputArgs, opts?: InvokeOptions): Output<GetServiceResult>

def get_service(id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetServiceResult
def get_service_output(id: pulumi.Input[Optional[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetServiceResult]

func LookupService(ctx *Context, args *LookupServiceArgs, opts ...InvokeOption) (*LookupServiceResult, error)
func LookupServiceOutput(ctx *Context, args *LookupServiceOutputArgs, opts ...InvokeOption) LookupServiceResultOutput

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

public static class GetService 
{
    public static Task<GetServiceResult> InvokeAsync(GetServiceArgs args, InvokeOptions? opts = null)
    public static Output<GetServiceResult> Invoke(GetServiceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetServiceResult> getService(GetServiceArgs args, InvokeOptions options)
public static Output<GetServiceResult> getService(GetServiceArgs args, InvokeOptions options)

fn::invoke:
  function: volcenginecc:id/getService:getService
  arguments:
    # arguments dictionary

data "volcenginecc_id_getservice" "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.

getService Result

The following output properties are available:

Backend Volcengine.GetServiceBackend: Backend service configuration
BackendType string: Backend service type, for example custom, viking, agentkit-mcp
CreatedAt int: Creation time, Unix timestamp in milliseconds
Description string: Service description, up to 256 characters
HijackDomainPrivate string: Private domain name
HijackDomainPublic string: Public domain name
Id string: Uniquely identifies the resource.
PermissionSpaceId string: Permission space ID, for example ps_123456
PermissionSpaceName string: Permission space name
ProjectName string: Project name. Optional at creation, default value is "default"
RouteCount int: Number of routes
Routes List<Volcengine.GetServiceRoute>: List of routes created simultaneously. This field is only written at creation, not returned by read interface
ServiceId string: Service ID. Generated after system creation, for example svc-1234567890
ServiceName string: Service name, 1–64 characters, unique within the account
Status string: Service status. inactive: not enabled. active: enabled (configuration synced to APIGateway). draft: draft status (changes not synced to APIGateway)
Tags List<Volcengine.GetServiceTag>: Service tag list
TemplateId string: Template ID associated with built-in service
Trn string: Resource TRN
UpdatedAt int: Update time, Unix timestamp in milliseconds

Backend GetServiceBackend: Backend service configuration
BackendType string: Backend service type, for example custom, viking, agentkit-mcp
CreatedAt int: Creation time, Unix timestamp in milliseconds
Description string: Service description, up to 256 characters
HijackDomainPrivate string: Private domain name
HijackDomainPublic string: Public domain name
Id string: Uniquely identifies the resource.
PermissionSpaceId string: Permission space ID, for example ps_123456
PermissionSpaceName string: Permission space name
ProjectName string: Project name. Optional at creation, default value is "default"
RouteCount int: Number of routes
Routes []GetServiceRoute: List of routes created simultaneously. This field is only written at creation, not returned by read interface
ServiceId string: Service ID. Generated after system creation, for example svc-1234567890
ServiceName string: Service name, 1–64 characters, unique within the account
Status string: Service status. inactive: not enabled. active: enabled (configuration synced to APIGateway). draft: draft status (changes not synced to APIGateway)
Tags []GetServiceTag: Service tag list
TemplateId string: Template ID associated with built-in service
Trn string: Resource TRN
UpdatedAt int: Update time, Unix timestamp in milliseconds

backend object: Backend service configuration
backend_type string: Backend service type, for example custom, viking, agentkit-mcp
created_at number: Creation time, Unix timestamp in milliseconds
description string: Service description, up to 256 characters
hijack_domain_private string: Private domain name
hijack_domain_public string: Public domain name
id string: Uniquely identifies the resource.
permission_space_id string: Permission space ID, for example ps_123456
permission_space_name string: Permission space name
project_name string: Project name. Optional at creation, default value is "default"
route_count number: Number of routes
routes list(object): List of routes created simultaneously. This field is only written at creation, not returned by read interface
service_id string: Service ID. Generated after system creation, for example svc-1234567890
service_name string: Service name, 1–64 characters, unique within the account
status string: Service status. inactive: not enabled. active: enabled (configuration synced to APIGateway). draft: draft status (changes not synced to APIGateway)
tags list(object): Service tag list
template_id string: Template ID associated with built-in service
trn string: Resource TRN
updated_at number: Update time, Unix timestamp in milliseconds

backend GetServiceBackend: Backend service configuration
backendType String: Backend service type, for example custom, viking, agentkit-mcp
createdAt Integer: Creation time, Unix timestamp in milliseconds
description String: Service description, up to 256 characters
hijackDomainPrivate String: Private domain name
hijackDomainPublic String: Public domain name
id String: Uniquely identifies the resource.
permissionSpaceId String: Permission space ID, for example ps_123456
permissionSpaceName String: Permission space name
projectName String: Project name. Optional at creation, default value is "default"
routeCount Integer: Number of routes
routes List<GetServiceRoute>: List of routes created simultaneously. This field is only written at creation, not returned by read interface
serviceId String: Service ID. Generated after system creation, for example svc-1234567890
serviceName String: Service name, 1–64 characters, unique within the account
status String: Service status. inactive: not enabled. active: enabled (configuration synced to APIGateway). draft: draft status (changes not synced to APIGateway)
tags List<GetServiceTag>: Service tag list
templateId String: Template ID associated with built-in service
trn String: Resource TRN
updatedAt Integer: Update time, Unix timestamp in milliseconds

backend GetServiceBackend: Backend service configuration
backendType string: Backend service type, for example custom, viking, agentkit-mcp
createdAt number: Creation time, Unix timestamp in milliseconds
description string: Service description, up to 256 characters
hijackDomainPrivate string: Private domain name
hijackDomainPublic string: Public domain name
id string: Uniquely identifies the resource.
permissionSpaceId string: Permission space ID, for example ps_123456
permissionSpaceName string: Permission space name
projectName string: Project name. Optional at creation, default value is "default"
routeCount number: Number of routes
routes GetServiceRoute[]: List of routes created simultaneously. This field is only written at creation, not returned by read interface
serviceId string: Service ID. Generated after system creation, for example svc-1234567890
serviceName string: Service name, 1–64 characters, unique within the account
status string: Service status. inactive: not enabled. active: enabled (configuration synced to APIGateway). draft: draft status (changes not synced to APIGateway)
tags GetServiceTag[]: Service tag list
templateId string: Template ID associated with built-in service
trn string: Resource TRN
updatedAt number: Update time, Unix timestamp in milliseconds

backend GetServiceBackend: Backend service configuration
backend_type str: Backend service type, for example custom, viking, agentkit-mcp
created_at int: Creation time, Unix timestamp in milliseconds
description str: Service description, up to 256 characters
hijack_domain_private str: Private domain name
hijack_domain_public str: Public domain name
id str: Uniquely identifies the resource.
permission_space_id str: Permission space ID, for example ps_123456
permission_space_name str: Permission space name
project_name str: Project name. Optional at creation, default value is "default"
route_count int: Number of routes
routes Sequence[GetServiceRoute]: List of routes created simultaneously. This field is only written at creation, not returned by read interface
service_id str: Service ID. Generated after system creation, for example svc-1234567890
service_name str: Service name, 1–64 characters, unique within the account
status str: Service status. inactive: not enabled. active: enabled (configuration synced to APIGateway). draft: draft status (changes not synced to APIGateway)
tags Sequence[GetServiceTag]: Service tag list
template_id str: Template ID associated with built-in service
trn str: Resource TRN
updated_at int: Update time, Unix timestamp in milliseconds

backend Property Map: Backend service configuration
backendType String: Backend service type, for example custom, viking, agentkit-mcp
createdAt Number: Creation time, Unix timestamp in milliseconds
description String: Service description, up to 256 characters
hijackDomainPrivate String: Private domain name
hijackDomainPublic String: Public domain name
id String: Uniquely identifies the resource.
permissionSpaceId String: Permission space ID, for example ps_123456
permissionSpaceName String: Permission space name
projectName String: Project name. Optional at creation, default value is "default"
routeCount Number: Number of routes
routes List<Property Map>: List of routes created simultaneously. This field is only written at creation, not returned by read interface
serviceId String: Service ID. Generated after system creation, for example svc-1234567890
serviceName String: Service name, 1–64 characters, unique within the account
status String: Service status. inactive: not enabled. active: enabled (configuration synced to APIGateway). draft: draft status (changes not synced to APIGateway)
tags List<Property Map>: Service tag list
templateId String: Template ID associated with built-in service
trn String: Resource TRN
updatedAt Number: Update time, Unix timestamp in milliseconds

Supporting Types

GetServiceBackend

BackendDomain string: Backend service domain name, for example api.example.com
BackendPort int: Backend service port, default is 443
EnableTls bool: Whether to enable TLS
Protocol string: Communication protocol, for example HTTP or HTTPS
TimeoutSeconds int: Request timeout in seconds, default is 30 seconds

BackendDomain string: Backend service domain name, for example api.example.com
BackendPort int: Backend service port, default is 443
EnableTls bool: Whether to enable TLS
Protocol string: Communication protocol, for example HTTP or HTTPS
TimeoutSeconds int: Request timeout in seconds, default is 30 seconds

backend_domain string: Backend service domain name, for example api.example.com
backend_port number: Backend service port, default is 443
enable_tls bool: Whether to enable TLS
protocol string: Communication protocol, for example HTTP or HTTPS
timeout_seconds number: Request timeout in seconds, default is 30 seconds

backendDomain String: Backend service domain name, for example api.example.com
backendPort Integer: Backend service port, default is 443
enableTls Boolean: Whether to enable TLS
protocol String: Communication protocol, for example HTTP or HTTPS
timeoutSeconds Integer: Request timeout in seconds, default is 30 seconds

backendDomain string: Backend service domain name, for example api.example.com
backendPort number: Backend service port, default is 443
enableTls boolean: Whether to enable TLS
protocol string: Communication protocol, for example HTTP or HTTPS
timeoutSeconds number: Request timeout in seconds, default is 30 seconds

backend_domain str: Backend service domain name, for example api.example.com
backend_port int: Backend service port, default is 443
enable_tls bool: Whether to enable TLS
protocol str: Communication protocol, for example HTTP or HTTPS
timeout_seconds int: Request timeout in seconds, default is 30 seconds

backendDomain String: Backend service domain name, for example api.example.com
backendPort Number: Backend service port, default is 443
enableTls Boolean: Whether to enable TLS
protocol String: Communication protocol, for example HTTP or HTTPS
timeoutSeconds Number: Request timeout in seconds, default is 30 seconds

GetServiceRoute

ApiSpec Volcengine.GetServiceRouteApiSpec: API specification configuration
AuthResourceType string: Authentication resource type
Description string: Route description
Method string: HTTP methods, separated by commas
Path string: Request path, 1–256 characters
PathMatchType string: Path match type, for example Exact, Prefix
PermissionPool string: Permission pool name
Priority int: Route priority, lower values indicate higher priority
ResourceType string: Resource type, for example Collection
RouteName string: Route name, 1–64 characters

ApiSpec GetServiceRouteApiSpec: API specification configuration
AuthResourceType string: Authentication resource type
Description string: Route description
Method string: HTTP methods, separated by commas
Path string: Request path, 1–256 characters
PathMatchType string: Path match type, for example Exact, Prefix
PermissionPool string: Permission pool name
Priority int: Route priority, lower values indicate higher priority
ResourceType string: Resource type, for example Collection
RouteName string: Route name, 1–64 characters

api_spec object: API specification configuration
auth_resource_type string: Authentication resource type
description string: Route description
method string: HTTP methods, separated by commas
path string: Request path, 1–256 characters
path_match_type string: Path match type, for example Exact, Prefix
permission_pool string: Permission pool name
priority number: Route priority, lower values indicate higher priority
resource_type string: Resource type, for example Collection
route_name string: Route name, 1–64 characters

apiSpec GetServiceRouteApiSpec: API specification configuration
authResourceType String: Authentication resource type
description String: Route description
method String: HTTP methods, separated by commas
path String: Request path, 1–256 characters
pathMatchType String: Path match type, for example Exact, Prefix
permissionPool String: Permission pool name
priority Integer: Route priority, lower values indicate higher priority
resourceType String: Resource type, for example Collection
routeName String: Route name, 1–64 characters

apiSpec GetServiceRouteApiSpec: API specification configuration
authResourceType string: Authentication resource type
description string: Route description
method string: HTTP methods, separated by commas
path string: Request path, 1–256 characters
pathMatchType string: Path match type, for example Exact, Prefix
permissionPool string: Permission pool name
priority number: Route priority, lower values indicate higher priority
resourceType string: Resource type, for example Collection
routeName string: Route name, 1–64 characters

api_spec GetServiceRouteApiSpec: API specification configuration
auth_resource_type str: Authentication resource type
description str: Route description
method str: HTTP methods, separated by commas
path str: Request path, 1–256 characters
path_match_type str: Path match type, for example Exact, Prefix
permission_pool str: Permission pool name
priority int: Route priority, lower values indicate higher priority
resource_type str: Resource type, for example Collection
route_name str: Route name, 1–64 characters

apiSpec Property Map: API specification configuration
authResourceType String: Authentication resource type
description String: Route description
method String: HTTP methods, separated by commas
path String: Request path, 1–256 characters
pathMatchType String: Path match type, for example Exact, Prefix
permissionPool String: Permission pool name
priority Number: Route priority, lower values indicate higher priority
resourceType String: Resource type, for example Collection
routeName String: Route name, 1–64 characters

GetServiceRouteApiSpec

ActionType string: Operation type, for example READ
ActionValue string: Operation value, for example search
Extractors List<Volcengine.GetServiceRouteApiSpecExtractor>: Attribute extractor list
IdentifierType int: Resource identifier type
IdentifierValue string: Resource identifier value, for example JSON Pointer
ResponseFilters List<Volcengine.GetServiceRouteApiSpecResponseFilter>: Response filter list

ActionType string: Operation type, for example READ
ActionValue string: Operation value, for example search
Extractors []GetServiceRouteApiSpecExtractor: Attribute extractor list
IdentifierType int: Resource identifier type
IdentifierValue string: Resource identifier value, for example JSON Pointer
ResponseFilters []GetServiceRouteApiSpecResponseFilter: Response filter list

action_type string: Operation type, for example READ
action_value string: Operation value, for example search
extractors list(object): Attribute extractor list
identifier_type number: Resource identifier type
identifier_value string: Resource identifier value, for example JSON Pointer
response_filters list(object): Response filter list

actionType String: Operation type, for example READ
actionValue String: Operation value, for example search
extractors List<GetServiceRouteApiSpecExtractor>: Attribute extractor list
identifierType Integer: Resource identifier type
identifierValue String: Resource identifier value, for example JSON Pointer
responseFilters List<GetServiceRouteApiSpecResponseFilter>: Response filter list

actionType string: Operation type, for example READ
actionValue string: Operation value, for example search
extractors GetServiceRouteApiSpecExtractor[]: Attribute extractor list
identifierType number: Resource identifier type
identifierValue string: Resource identifier value, for example JSON Pointer
responseFilters GetServiceRouteApiSpecResponseFilter[]: Response filter list

action_type str: Operation type, for example READ
action_value str: Operation value, for example search
extractors Sequence[GetServiceRouteApiSpecExtractor]: Attribute extractor list
identifier_type int: Resource identifier type
identifier_value str: Resource identifier value, for example JSON Pointer
response_filters Sequence[GetServiceRouteApiSpecResponseFilter]: Response filter list

actionType String: Operation type, for example READ
actionValue String: Operation value, for example search
extractors List<Property Map>: Attribute extractor list
identifierType Number: Resource identifier type
identifierValue String: Resource identifier value, for example JSON Pointer
responseFilters List<Property Map>: Response filter list

GetServiceRouteApiSpecExtractor

IsAuth bool: Whether used for authentication
Path string: JSON Pointer expression
ResourceType string: Extracted resource type
Source int: Extraction source enumeration value

IsAuth bool: Whether used for authentication
Path string: JSON Pointer expression
ResourceType string: Extracted resource type
Source int: Extraction source enumeration value

is_auth bool: Whether used for authentication
path string: JSON Pointer expression
resource_type string: Extracted resource type
source number: Extraction source enumeration value

isAuth Boolean: Whether used for authentication
path String: JSON Pointer expression
resourceType String: Extracted resource type
source Integer: Extraction source enumeration value

isAuth boolean: Whether used for authentication
path string: JSON Pointer expression
resourceType string: Extracted resource type
source number: Extraction source enumeration value

is_auth bool: Whether used for authentication
path str: JSON Pointer expression
resource_type str: Extracted resource type
source int: Extraction source enumeration value

isAuth Boolean: Whether used for authentication
path String: JSON Pointer expression
resourceType String: Extracted resource type
source Number: Extraction source enumeration value

GetServiceRouteApiSpecResponseFilter

Attributes List<Volcengine.GetServiceRouteApiSpecResponseFilterAttribute>: Attribute mapping list
FilterPath string: Array path JSON Pointer
IdField string: ID field name
IsAuth bool: Whether used for authentication
Mode int: Filter mode enumeration value
ResourcePath string: Resource path JSON Pointer
ResourceType string: Filtered resource type

Attributes []GetServiceRouteApiSpecResponseFilterAttribute: Attribute mapping list
FilterPath string: Array path JSON Pointer
IdField string: ID field name
IsAuth bool: Whether used for authentication
Mode int: Filter mode enumeration value
ResourcePath string: Resource path JSON Pointer
ResourceType string: Filtered resource type

attributes list(object): Attribute mapping list
filter_path string: Array path JSON Pointer
id_field string: ID field name
is_auth bool: Whether used for authentication
mode number: Filter mode enumeration value
resource_path string: Resource path JSON Pointer
resource_type string: Filtered resource type

attributes List<GetServiceRouteApiSpecResponseFilterAttribute>: Attribute mapping list
filterPath String: Array path JSON Pointer
idField String: ID field name
isAuth Boolean: Whether used for authentication
mode Integer: Filter mode enumeration value
resourcePath String: Resource path JSON Pointer
resourceType String: Filtered resource type

attributes GetServiceRouteApiSpecResponseFilterAttribute[]: Attribute mapping list
filterPath string: Array path JSON Pointer
idField string: ID field name
isAuth boolean: Whether used for authentication
mode number: Filter mode enumeration value
resourcePath string: Resource path JSON Pointer
resourceType string: Filtered resource type

attributes Sequence[GetServiceRouteApiSpecResponseFilterAttribute]: Attribute mapping list
filter_path str: Array path JSON Pointer
id_field str: ID field name
is_auth bool: Whether used for authentication
mode int: Filter mode enumeration value
resource_path str: Resource path JSON Pointer
resource_type str: Filtered resource type

attributes List<Property Map>: Attribute mapping list
filterPath String: Array path JSON Pointer
idField String: ID field name
isAuth Boolean: Whether used for authentication
mode Number: Filter mode enumeration value
resourcePath String: Resource path JSON Pointer
resourceType String: Filtered resource type

GetServiceRouteApiSpecResponseFilterAttribute

Field string: Source field path JSON Pointer
Target string: Target attribute name

Field string: Source field path JSON Pointer
Target string: Target attribute name

field string: Source field path JSON Pointer
target string: Target attribute name

field String: Source field path JSON Pointer
target String: Target attribute name

field string: Source field path JSON Pointer
target string: Target attribute name

field str: Source field path JSON Pointer
target str: Target attribute name

field String: Source field path JSON Pointer
target String: Target attribute name

GetServiceTag

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 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.

Viewing docs for volcenginecc v0.0.42
published on Thursday, Jun 11, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

volcenginecc.id.getService

On this page

On this page

Using getService

getService Result

Supporting Types

GetServiceBackend

GetServiceRoute

GetServiceRouteApiSpec

GetServiceRouteApiSpecExtractor

GetServiceRouteApiSpecResponseFilter

GetServiceRouteApiSpecResponseFilterAttribute

GetServiceTag

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

volcenginecc.id.getService

On this page

On this page

Using getService

getService Result

Supporting Types

GetServiceBackend

GetServiceRoute

GetServiceRouteApiSpec

GetServiceRouteApiSpecExtractor

GetServiceRouteApiSpecResponseFilter

GetServiceRouteApiSpecResponseFilterAttribute

GetServiceTag

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.