volcenginecc.id.Service

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

name string

The unique name of the resource.

args ServiceArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

resource_name str

The unique name of the resource.

args ServiceArgs

The arguments to resource properties.

opts ResourceOptions

Bag of options to control resource's behavior.

ctx Context

Context object for the current deployment.

name string

The unique name of the resource.

args ServiceArgs

The arguments to resource properties.

opts ResourceOption

Bag of options to control resource's behavior.

name string

The unique name of the resource.

args ServiceArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

name String

The unique name of the resource.

args ServiceArgs

The arguments to resource properties.

options CustomResourceOptions

Bag of options to control resource's behavior.

Backend Volcengine.ServiceBackend

Backend service configuration

PermissionSpaceId string

Permission space ID, for example ps_123456

ServiceName string

Service name, 1–64 characters, unique within the account

Description string

Service description, up to 256 characters

PermissionSpaceName string

Permission space name

ProjectName string

Project name. Optional at creation, default value is "default"

Routes List<Volcengine.ServiceRoute>

Status string

Service status. inactive: not enabled. active: enabled (configuration synced to APIGateway). draft: draft status (changes not synced to APIGateway)

Tags List<Volcengine.ServiceTag>

Backend ServiceBackendArgs

Backend service configuration

PermissionSpaceId string

Permission space ID, for example ps_123456

ServiceName string

Service name, 1–64 characters, unique within the account

Description string

Service description, up to 256 characters

PermissionSpaceName string

Permission space name

ProjectName string

Project name. Optional at creation, default value is "default"

Routes []ServiceRouteArgs

Status string

Service status. inactive: not enabled. active: enabled (configuration synced to APIGateway). draft: draft status (changes not synced to APIGateway)

Tags []ServiceTagArgs

backend object

Backend service configuration

permission_space_id string

Permission space ID, for example ps_123456

service_name string

Service name, 1–64 characters, unique within the account

description string

Service description, up to 256 characters

permission_space_name string

Permission space name

project_name string

Project name. Optional at creation, default value is "default"

routes list(object)

status string

Service status. inactive: not enabled. active: enabled (configuration synced to APIGateway). draft: draft status (changes not synced to APIGateway)

tags list(object)

backend ServiceBackend

Backend service configuration

permissionSpaceId String

Permission space ID, for example ps_123456

serviceName String

Service name, 1–64 characters, unique within the account

description String

Service description, up to 256 characters

permissionSpaceName String

Permission space name

projectName String

Project name. Optional at creation, default value is "default"

routes List<ServiceRoute>

status String

Service status. inactive: not enabled. active: enabled (configuration synced to APIGateway). draft: draft status (changes not synced to APIGateway)

tags List<ServiceTag>

backend ServiceBackend

Backend service configuration

permissionSpaceId string

Permission space ID, for example ps_123456

serviceName string

Service name, 1–64 characters, unique within the account

description string

Service description, up to 256 characters

permissionSpaceName string

Permission space name

projectName string

Project name. Optional at creation, default value is "default"

routes ServiceRoute[]

status string

Service status. inactive: not enabled. active: enabled (configuration synced to APIGateway). draft: draft status (changes not synced to APIGateway)

tags ServiceTag[]

backend ServiceBackendArgs

Backend service configuration

permission_space_id str

Permission space ID, for example ps_123456

service_name str

Service name, 1–64 characters, unique within the account

description str

Service description, up to 256 characters

permission_space_name str

Permission space name

project_name str

Project name. Optional at creation, default value is "default"

routes Sequence[ServiceRouteArgs]

status str

Service status. inactive: not enabled. active: enabled (configuration synced to APIGateway). draft: draft status (changes not synced to APIGateway)

tags Sequence[ServiceTagArgs]

backend Property Map

Backend service configuration

permissionSpaceId String

Permission space ID, for example ps_123456

serviceName String

Service name, 1–64 characters, unique within the account

description String

Service description, up to 256 characters

permissionSpaceName String

Permission space name

projectName String

Project name. Optional at creation, default value is "default"

routes List<Property Map>

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>

BackendType string

Backend service type, for example custom, viking, agentkit-mcp

CreatedAt int

Creation time, Unix timestamp in milliseconds

HijackDomainPrivate string

Private domain name

HijackDomainPublic string

Public domain name

Id string

The provider-assigned unique ID for this managed resource.

RouteCount int

Number of routes

ServiceId string

Service ID. Generated after system creation, for example svc-1234567890

TemplateId string

Template ID associated with built-in service

Trn string

Resource TRN

UpdatedAt int

Update time, Unix timestamp in milliseconds

BackendType string

Backend service type, for example custom, viking, agentkit-mcp

CreatedAt int

Creation time, Unix timestamp in milliseconds

HijackDomainPrivate string

Private domain name

HijackDomainPublic string

Public domain name

Id string

The provider-assigned unique ID for this managed resource.

RouteCount int

Number of routes

ServiceId string

Service ID. Generated after system creation, for example svc-1234567890

TemplateId string

Template ID associated with built-in service

Trn string

Resource TRN

UpdatedAt int

Update time, Unix timestamp in milliseconds

backend_type string

Backend service type, for example custom, viking, agentkit-mcp

created_at number

Creation time, Unix timestamp in milliseconds

hijack_domain_private string

Private domain name

hijack_domain_public string

Public domain name

id string

The provider-assigned unique ID for this managed resource.

route_count number

Number of routes

service_id string

Service ID. Generated after system creation, for example svc-1234567890

template_id string

Template ID associated with built-in service

trn string

Resource TRN

updated_at number

Update time, Unix timestamp in milliseconds

backendType String

Backend service type, for example custom, viking, agentkit-mcp

createdAt Integer

Creation time, Unix timestamp in milliseconds

hijackDomainPrivate String

Private domain name

hijackDomainPublic String

Public domain name

id String

The provider-assigned unique ID for this managed resource.

routeCount Integer

Number of routes

serviceId String

Service ID. Generated after system creation, for example svc-1234567890

templateId String

Template ID associated with built-in service

trn String

Resource TRN

updatedAt Integer

Update time, Unix timestamp in milliseconds

backendType string

Backend service type, for example custom, viking, agentkit-mcp

createdAt number

Creation time, Unix timestamp in milliseconds

hijackDomainPrivate string

Private domain name

hijackDomainPublic string

Public domain name

id string

The provider-assigned unique ID for this managed resource.

routeCount number

Number of routes

serviceId string

Service ID. Generated after system creation, for example svc-1234567890

templateId string

Template ID associated with built-in service

trn string

Resource TRN

updatedAt number

Update time, Unix timestamp in milliseconds

backend_type str

Backend service type, for example custom, viking, agentkit-mcp

created_at int

Creation time, Unix timestamp in milliseconds

hijack_domain_private str

Private domain name

hijack_domain_public str

Public domain name

id str

The provider-assigned unique ID for this managed resource.

route_count int

Number of routes

service_id str

Service ID. Generated after system creation, for example svc-1234567890

template_id str

Template ID associated with built-in service

trn str

Resource TRN

updated_at int

Update time, Unix timestamp in milliseconds

backendType String

Backend service type, for example custom, viking, agentkit-mcp

createdAt Number

Creation time, Unix timestamp in milliseconds

hijackDomainPrivate String

Private domain name

hijackDomainPublic String

Public domain name

id String

The provider-assigned unique ID for this managed resource.

routeCount Number

Number of routes

serviceId String

Service ID. Generated after system creation, for example svc-1234567890

templateId String

Template ID associated with built-in service

trn String

Resource TRN

updatedAt Number

Update time, Unix timestamp in milliseconds

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

resource_name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

BackendDomain string

Backend service domain name, for example api.example.com

EnableTls bool

Whether to enable TLS

BackendPort int

Backend service port, default is 443

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

EnableTls bool

Whether to enable TLS

BackendPort int

Backend service port, default is 443

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

enable_tls bool

Whether to enable TLS

backend_port number

Backend service port, default is 443

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

enableTls Boolean

Whether to enable TLS

backendPort Integer

Backend service port, default is 443

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

enableTls boolean

Whether to enable TLS

backendPort number

Backend service port, default is 443

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

enable_tls bool

Whether to enable TLS

backend_port int

Backend service port, default is 443

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

enableTls Boolean

Whether to enable TLS

backendPort Number

Backend service port, default is 443

protocol String

Communication protocol, for example HTTP or HTTPS

timeoutSeconds Number

Request timeout in seconds, default is 30 seconds

ApiSpec Volcengine.ServiceRouteApiSpec

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 ServiceRouteApiSpec

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 ServiceRouteApiSpec

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 ServiceRouteApiSpec

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 ServiceRouteApiSpec

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

ActionType string

Operation type, for example READ

ActionValue string

Operation value, for example search

Extractors List<Volcengine.ServiceRouteApiSpecExtractor>

IdentifierType int

Resource identifier type

IdentifierValue string

Resource identifier value, for example JSON Pointer

ResponseFilters List<Volcengine.ServiceRouteApiSpecResponseFilter>

ActionType string

Operation type, for example READ

ActionValue string

Operation value, for example search

Extractors []ServiceRouteApiSpecExtractor

IdentifierType int

Resource identifier type

IdentifierValue string

Resource identifier value, for example JSON Pointer

ResponseFilters []ServiceRouteApiSpecResponseFilter

action_type string

Operation type, for example READ

action_value string

Operation value, for example search

extractors list(object)

identifier_type number

Resource identifier type

identifier_value string

Resource identifier value, for example JSON Pointer

response_filters list(object)

actionType String

Operation type, for example READ

actionValue String

Operation value, for example search

extractors List<ServiceRouteApiSpecExtractor>

identifierType Integer

Resource identifier type

identifierValue String

Resource identifier value, for example JSON Pointer

responseFilters List<ServiceRouteApiSpecResponseFilter>

actionType string

Operation type, for example READ

actionValue string

Operation value, for example search

extractors ServiceRouteApiSpecExtractor[]

identifierType number

Resource identifier type

identifierValue string

Resource identifier value, for example JSON Pointer

responseFilters ServiceRouteApiSpecResponseFilter[]

action_type str

Operation type, for example READ

action_value str

Operation value, for example search

extractors Sequence[ServiceRouteApiSpecExtractor]

identifier_type int

Resource identifier type

identifier_value str

Resource identifier value, for example JSON Pointer

response_filters Sequence[ServiceRouteApiSpecResponseFilter]

actionType String

Operation type, for example READ

actionValue String

Operation value, for example search

extractors List<Property Map>

identifierType Number

Resource identifier type

identifierValue String

Resource identifier value, for example JSON Pointer

responseFilters List<Property Map>

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

Attributes List<Volcengine.ServiceRouteApiSpecResponseFilterAttribute>

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 []ServiceRouteApiSpecResponseFilterAttribute

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)

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

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 ServiceRouteApiSpecResponseFilterAttribute[]

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[ServiceRouteApiSpecResponseFilterAttribute]

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>

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

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

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