volcenginecc.ark.getEndpoint

volcenginecc v0.0.35, May 14 26

Viewing docs for volcenginecc v0.0.35
published on Thursday, May 14, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.35
published on Thursday, May 14, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Using getEndpoint

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 getEndpoint(args: GetEndpointArgs, opts?: InvokeOptions): Promise<GetEndpointResult>
function getEndpointOutput(args: GetEndpointOutputArgs, opts?: InvokeOptions): Output<GetEndpointResult>

def get_endpoint(id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetEndpointResult
def get_endpoint_output(id: pulumi.Input[Optional[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetEndpointResult]

func LookupEndpoint(ctx *Context, args *LookupEndpointArgs, opts ...InvokeOption) (*LookupEndpointResult, error)
func LookupEndpointOutput(ctx *Context, args *LookupEndpointOutputArgs, opts ...InvokeOption) LookupEndpointResultOutput

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

public static class GetEndpoint 
{
    public static Task<GetEndpointResult> InvokeAsync(GetEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetEndpointResult> Invoke(GetEndpointInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetEndpointResult> getEndpoint(GetEndpointArgs args, InvokeOptions options)
public static Output<GetEndpointResult> getEndpoint(GetEndpointArgs args, InvokeOptions options)

fn::invoke:
  function: volcenginecc:ark/getEndpoint:getEndpoint
  arguments:
    # arguments dictionary

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

getEndpoint Result

The following output properties are available:

BatchOnly bool: Whether only BatchChat is supported. If true, only batch inference interfaces can be accessed; otherwise, only online inference interfaces can be accessed
Certificate Volcengine.GetEndpointCertificate: Certificate information
CreateTime string: Endpoint creation time, RFC3339 format
Description string: Endpoint description
EndpointId string: Inference access point ID.
EndpointModelType string: Access point model type. Options: FoundationModel for base model; CustomModel for custom model.
Id string: Uniquely identifies the resource.
ModelReference Volcengine.GetEndpointModelReference: Endpoint access model
ModelUnitId string: Model unit. If empty, indicates postpaid; otherwise, prepaid.
Moderation Volcengine.GetEndpointModeration: Content guardrail scheme
Name string: Endpoint name
ProjectName string: Project name the resource belongs to; default value is "default"
RateLimit Volcengine.GetEndpointRateLimit: Endpoint rate limiting
RollingId string: Endpoint switch ID
ScaleTierId string: If a TPM protection package exists, this is the TPM protection package ID.
Status string: Endpoint status
StatusReason string: Additional status information
SupportRolling bool: Whether endpoint supports switching model versions
SupportScaleTier bool: Whether TPM protection package is supported
Tags List<Volcengine.GetEndpointTag>: Tags bound to the endpoint
UpdateTime string: Endpoint update time, RFC3339 format

BatchOnly bool: Whether only BatchChat is supported. If true, only batch inference interfaces can be accessed; otherwise, only online inference interfaces can be accessed
Certificate GetEndpointCertificate: Certificate information
CreateTime string: Endpoint creation time, RFC3339 format
Description string: Endpoint description
EndpointId string: Inference access point ID.
EndpointModelType string: Access point model type. Options: FoundationModel for base model; CustomModel for custom model.
Id string: Uniquely identifies the resource.
ModelReference GetEndpointModelReference: Endpoint access model
ModelUnitId string: Model unit. If empty, indicates postpaid; otherwise, prepaid.
Moderation GetEndpointModeration: Content guardrail scheme
Name string: Endpoint name
ProjectName string: Project name the resource belongs to; default value is "default"
RateLimit GetEndpointRateLimit: Endpoint rate limiting
RollingId string: Endpoint switch ID
ScaleTierId string: If a TPM protection package exists, this is the TPM protection package ID.
Status string: Endpoint status
StatusReason string: Additional status information
SupportRolling bool: Whether endpoint supports switching model versions
SupportScaleTier bool: Whether TPM protection package is supported
Tags []GetEndpointTag: Tags bound to the endpoint
UpdateTime string: Endpoint update time, RFC3339 format

batch_only bool: Whether only BatchChat is supported. If true, only batch inference interfaces can be accessed; otherwise, only online inference interfaces can be accessed
certificate object: Certificate information
create_time string: Endpoint creation time, RFC3339 format
description string: Endpoint description
endpoint_id string: Inference access point ID.
endpoint_model_type string: Access point model type. Options: FoundationModel for base model; CustomModel for custom model.
id string: Uniquely identifies the resource.
model_reference object: Endpoint access model
model_unit_id string: Model unit. If empty, indicates postpaid; otherwise, prepaid.
moderation object: Content guardrail scheme
name string: Endpoint name
project_name string: Project name the resource belongs to; default value is "default"
rate_limit object: Endpoint rate limiting
rolling_id string: Endpoint switch ID
scale_tier_id string: If a TPM protection package exists, this is the TPM protection package ID.
status string: Endpoint status
status_reason string: Additional status information
support_rolling bool: Whether endpoint supports switching model versions
support_scale_tier bool: Whether TPM protection package is supported
tags list(object): Tags bound to the endpoint
update_time string: Endpoint update time, RFC3339 format

batchOnly Boolean: Whether only BatchChat is supported. If true, only batch inference interfaces can be accessed; otherwise, only online inference interfaces can be accessed
certificate GetEndpointCertificate: Certificate information
createTime String: Endpoint creation time, RFC3339 format
description String: Endpoint description
endpointId String: Inference access point ID.
endpointModelType String: Access point model type. Options: FoundationModel for base model; CustomModel for custom model.
id String: Uniquely identifies the resource.
modelReference GetEndpointModelReference: Endpoint access model
modelUnitId String: Model unit. If empty, indicates postpaid; otherwise, prepaid.
moderation GetEndpointModeration: Content guardrail scheme
name String: Endpoint name
projectName String: Project name the resource belongs to; default value is "default"
rateLimit GetEndpointRateLimit: Endpoint rate limiting
rollingId String: Endpoint switch ID
scaleTierId String: If a TPM protection package exists, this is the TPM protection package ID.
status String: Endpoint status
statusReason String: Additional status information
supportRolling Boolean: Whether endpoint supports switching model versions
supportScaleTier Boolean: Whether TPM protection package is supported
tags List<GetEndpointTag>: Tags bound to the endpoint
updateTime String: Endpoint update time, RFC3339 format

batchOnly boolean: Whether only BatchChat is supported. If true, only batch inference interfaces can be accessed; otherwise, only online inference interfaces can be accessed
certificate GetEndpointCertificate: Certificate information
createTime string: Endpoint creation time, RFC3339 format
description string: Endpoint description
endpointId string: Inference access point ID.
endpointModelType string: Access point model type. Options: FoundationModel for base model; CustomModel for custom model.
id string: Uniquely identifies the resource.
modelReference GetEndpointModelReference: Endpoint access model
modelUnitId string: Model unit. If empty, indicates postpaid; otherwise, prepaid.
moderation GetEndpointModeration: Content guardrail scheme
name string: Endpoint name
projectName string: Project name the resource belongs to; default value is "default"
rateLimit GetEndpointRateLimit: Endpoint rate limiting
rollingId string: Endpoint switch ID
scaleTierId string: If a TPM protection package exists, this is the TPM protection package ID.
status string: Endpoint status
statusReason string: Additional status information
supportRolling boolean: Whether endpoint supports switching model versions
supportScaleTier boolean: Whether TPM protection package is supported
tags GetEndpointTag[]: Tags bound to the endpoint
updateTime string: Endpoint update time, RFC3339 format

batch_only bool: Whether only BatchChat is supported. If true, only batch inference interfaces can be accessed; otherwise, only online inference interfaces can be accessed
certificate GetEndpointCertificate: Certificate information
create_time str: Endpoint creation time, RFC3339 format
description str: Endpoint description
endpoint_id str: Inference access point ID.
endpoint_model_type str: Access point model type. Options: FoundationModel for base model; CustomModel for custom model.
id str: Uniquely identifies the resource.
model_reference GetEndpointModelReference: Endpoint access model
model_unit_id str: Model unit. If empty, indicates postpaid; otherwise, prepaid.
moderation GetEndpointModeration: Content guardrail scheme
name str: Endpoint name
project_name str: Project name the resource belongs to; default value is "default"
rate_limit GetEndpointRateLimit: Endpoint rate limiting
rolling_id str: Endpoint switch ID
scale_tier_id str: If a TPM protection package exists, this is the TPM protection package ID.
status str: Endpoint status
status_reason str: Additional status information
support_rolling bool: Whether endpoint supports switching model versions
support_scale_tier bool: Whether TPM protection package is supported
tags Sequence[GetEndpointTag]: Tags bound to the endpoint
update_time str: Endpoint update time, RFC3339 format

batchOnly Boolean: Whether only BatchChat is supported. If true, only batch inference interfaces can be accessed; otherwise, only online inference interfaces can be accessed
certificate Property Map: Certificate information
createTime String: Endpoint creation time, RFC3339 format
description String: Endpoint description
endpointId String: Inference access point ID.
endpointModelType String: Access point model type. Options: FoundationModel for base model; CustomModel for custom model.
id String: Uniquely identifies the resource.
modelReference Property Map: Endpoint access model
modelUnitId String: Model unit. If empty, indicates postpaid; otherwise, prepaid.
moderation Property Map: Content guardrail scheme
name String: Endpoint name
projectName String: Project name the resource belongs to; default value is "default"
rateLimit Property Map: Endpoint rate limiting
rollingId String: Endpoint switch ID
scaleTierId String: If a TPM protection package exists, this is the TPM protection package ID.
status String: Endpoint status
statusReason String: Additional status information
supportRolling Boolean: Whether endpoint supports switching model versions
supportScaleTier Boolean: Whether TPM protection package is supported
tags List<Property Map>: Tags bound to the endpoint
updateTime String: Endpoint update time, RFC3339 format

Supporting Types

GetEndpointCertificate

NotAfter int: X509 private certificate expiration time, represented as a timestamp in seconds
NotBefore int: X509 private certificate activation time, represented as a timestamp in seconds
PcaHost string: Certificate subject
PcaInstanceCertificate string: PEM format leaf certificate
PcaName string: Certificate name
PcaRootCaCertificate string: PEM format root certificate
PcaSubCaCertificate string: Intermediate certificate and root certificate in PEM format

NotAfter int: X509 private certificate expiration time, represented as a timestamp in seconds
NotBefore int: X509 private certificate activation time, represented as a timestamp in seconds
PcaHost string: Certificate subject
PcaInstanceCertificate string: PEM format leaf certificate
PcaName string: Certificate name
PcaRootCaCertificate string: PEM format root certificate
PcaSubCaCertificate string: Intermediate certificate and root certificate in PEM format

not_after number: X509 private certificate expiration time, represented as a timestamp in seconds
not_before number: X509 private certificate activation time, represented as a timestamp in seconds
pca_host string: Certificate subject
pca_instance_certificate string: PEM format leaf certificate
pca_name string: Certificate name
pca_root_ca_certificate string: PEM format root certificate
pca_sub_ca_certificate string: Intermediate certificate and root certificate in PEM format

notAfter Integer: X509 private certificate expiration time, represented as a timestamp in seconds
notBefore Integer: X509 private certificate activation time, represented as a timestamp in seconds
pcaHost String: Certificate subject
pcaInstanceCertificate String: PEM format leaf certificate
pcaName String: Certificate name
pcaRootCaCertificate String: PEM format root certificate
pcaSubCaCertificate String: Intermediate certificate and root certificate in PEM format

notAfter number: X509 private certificate expiration time, represented as a timestamp in seconds
notBefore number: X509 private certificate activation time, represented as a timestamp in seconds
pcaHost string: Certificate subject
pcaInstanceCertificate string: PEM format leaf certificate
pcaName string: Certificate name
pcaRootCaCertificate string: PEM format root certificate
pcaSubCaCertificate string: Intermediate certificate and root certificate in PEM format

not_after int: X509 private certificate expiration time, represented as a timestamp in seconds
not_before int: X509 private certificate activation time, represented as a timestamp in seconds
pca_host str: Certificate subject
pca_instance_certificate str: PEM format leaf certificate
pca_name str: Certificate name
pca_root_ca_certificate str: PEM format root certificate
pca_sub_ca_certificate str: Intermediate certificate and root certificate in PEM format

notAfter Number: X509 private certificate expiration time, represented as a timestamp in seconds
notBefore Number: X509 private certificate activation time, represented as a timestamp in seconds
pcaHost String: Certificate subject
pcaInstanceCertificate String: PEM format leaf certificate
pcaName String: Certificate name
pcaRootCaCertificate String: PEM format root certificate
pcaSubCaCertificate String: Intermediate certificate and root certificate in PEM format

GetEndpointModelReference

CustomModelId string: Custom model ID
FoundationModel Volcengine.GetEndpointModelReferenceFoundationModel: Base model

CustomModelId string: Custom model ID
FoundationModel GetEndpointModelReferenceFoundationModel: Base model

custom_model_id string: Custom model ID
foundation_model object: Base model

customModelId String: Custom model ID
foundationModel GetEndpointModelReferenceFoundationModel: Base model

customModelId string: Custom model ID
foundationModel GetEndpointModelReferenceFoundationModel: Base model

custom_model_id str: Custom model ID
foundation_model GetEndpointModelReferenceFoundationModel: Base model

customModelId String: Custom model ID
foundationModel Property Map: Base model

GetEndpointModelReferenceFoundationModel

ModelVersion string: Base model version
Name string: Base model name. Note: Model names are lowercase. The model name format for doubao 1.5 generation models is "doubao-1-5-**".

ModelVersion string: Base model version
Name string: Base model name. Note: Model names are lowercase. The model name format for doubao 1.5 generation models is "doubao-1-5-**".

model_version string: Base model version
name string: Base model name. Note: Model names are lowercase. The model name format for doubao 1.5 generation models is "doubao-1-5-**".

modelVersion String: Base model version
name String: Base model name. Note: Model names are lowercase. The model name format for doubao 1.5 generation models is "doubao-1-5-**".

modelVersion string: Base model version
name string: Base model name. Note: Model names are lowercase. The model name format for doubao 1.5 generation models is "doubao-1-5-**".

model_version str: Base model version
name str: Base model name. Note: Model names are lowercase. The model name format for doubao 1.5 generation models is "doubao-1-5-**".

modelVersion String: Base model version
name String: Base model name. Note: Model names are lowercase. The model name format for doubao 1.5 generation models is "doubao-1-5-**".

GetEndpointModeration

Strategy string: Content safety guardrail scheme. Values: Default: default scheme. Lower latency, broadly covers general content safety requirements; Basic: basic scheme (public beta). Supports providing triggered risk categories in interface responses, currently only includes two risk types: severe violations and aggressive behavior. Note: If using streaming interface calls, this scheme is not recommended, as it will increase the length of each output fragment and raise latency

Strategy string: Content safety guardrail scheme. Values: Default: default scheme. Lower latency, broadly covers general content safety requirements; Basic: basic scheme (public beta). Supports providing triggered risk categories in interface responses, currently only includes two risk types: severe violations and aggressive behavior. Note: If using streaming interface calls, this scheme is not recommended, as it will increase the length of each output fragment and raise latency

strategy string: Content safety guardrail scheme. Values: Default: default scheme. Lower latency, broadly covers general content safety requirements; Basic: basic scheme (public beta). Supports providing triggered risk categories in interface responses, currently only includes two risk types: severe violations and aggressive behavior. Note: If using streaming interface calls, this scheme is not recommended, as it will increase the length of each output fragment and raise latency

strategy String: Content safety guardrail scheme. Values: Default: default scheme. Lower latency, broadly covers general content safety requirements; Basic: basic scheme (public beta). Supports providing triggered risk categories in interface responses, currently only includes two risk types: severe violations and aggressive behavior. Note: If using streaming interface calls, this scheme is not recommended, as it will increase the length of each output fragment and raise latency

strategy string: Content safety guardrail scheme. Values: Default: default scheme. Lower latency, broadly covers general content safety requirements; Basic: basic scheme (public beta). Supports providing triggered risk categories in interface responses, currently only includes two risk types: severe violations and aggressive behavior. Note: If using streaming interface calls, this scheme is not recommended, as it will increase the length of each output fragment and raise latency

strategy str: Content safety guardrail scheme. Values: Default: default scheme. Lower latency, broadly covers general content safety requirements; Basic: basic scheme (public beta). Supports providing triggered risk categories in interface responses, currently only includes two risk types: severe violations and aggressive behavior. Note: If using streaming interface calls, this scheme is not recommended, as it will increase the length of each output fragment and raise latency

strategy String: Content safety guardrail scheme. Values: Default: default scheme. Lower latency, broadly covers general content safety requirements; Basic: basic scheme (public beta). Supports providing triggered risk categories in interface responses, currently only includes two risk types: severe violations and aggressive behavior. Note: If using streaming interface calls, this scheme is not recommended, as it will increase the length of each output fragment and raise latency

GetEndpointRateLimit

Rpm int: Requests Per Minute, number of requests per minute
Tpm int: Tokens Per Minute, number of tokens requested per minute

Rpm int: Requests Per Minute, number of requests per minute
Tpm int: Tokens Per Minute, number of tokens requested per minute

rpm number: Requests Per Minute, number of requests per minute
tpm number: Tokens Per Minute, number of tokens requested per minute

rpm Integer: Requests Per Minute, number of requests per minute
tpm Integer: Tokens Per Minute, number of tokens requested per minute

rpm number: Requests Per Minute, number of requests per minute
tpm number: Tokens Per Minute, number of tokens requested per minute

rpm int: Requests Per Minute, number of requests per minute
tpm int: Tokens Per Minute, number of tokens requested per minute

rpm Number: Requests Per Minute, number of requests per minute
tpm Number: Tokens Per Minute, number of tokens requested per minute

GetEndpointTag

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.35
published on Thursday, May 14, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

volcenginecc.ark.getEndpoint

On this page

On this page

Using getEndpoint

getEndpoint Result

Supporting Types

GetEndpointCertificate

GetEndpointModelReference

GetEndpointModelReferenceFoundationModel

GetEndpointModeration

GetEndpointRateLimit

GetEndpointTag

Package Details

On this page

On this page