volcenginecc v0.0.2, Oct 11 25

volcenginecc v0.0.2 published on Saturday, Oct 11, 2025 by Volcengine

volcenginecc.ark.getEndpoint

volcenginecc v0.0.2 published on Saturday, Oct 11, 2025 by Volcengine

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: Optional[pulumi.Input[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

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.

getEndpoint Result

The following output properties are available:

BatchOnly bool: 是否只支持 BatchChat。如果为true，只能访问 Batch 推理接口，否则只能访问在线推理接口。
Certificate Volcengine.GetEndpointCertificate: 证书信息。
CreateTime string: 接入点创建时间，RFC3339格式。
Description string: 接入点描述。
EndpointId string: 推理接入点的ID。
EndpointModelType string: 接入点模型类型。取值:FoundationModel为基础模型;CustomModel为定制模型。
Id string: Uniquely identifies the resource.
ModelReference Volcengine.GetEndpointModelReference: 接入点接入模型。
ModelUnitId string: 模型单元，为空表示后付费；否则预付费。
Moderation Volcengine.GetEndpointModeration: 内容护栏方案。
Name string: 接入点名称。
ProjectName string: 资源所属的项目名称，默认值为default。
RateLimit Volcengine.GetEndpointRateLimit: 接入点限流。
RollingId string: 接入点切换的Id。
ScaleTierId string: 如果存在 TPM 保障包，则为 TPM 保障包 ID。
Status string: 接入点状态。
StatusReason string: 状态附加说明信息。
SupportRolling bool: 是否支持接入点切换模型版本。
SupportScaleTier bool: 是否支持TPM保障包。
Tags List<Volcengine.GetEndpointTag>: 接入点绑定的标签。
UpdateTime string: 接入点更新时间，RFC3339格式。

BatchOnly bool: 是否只支持 BatchChat。如果为true，只能访问 Batch 推理接口，否则只能访问在线推理接口。
Certificate GetEndpointCertificate: 证书信息。
CreateTime string: 接入点创建时间，RFC3339格式。
Description string: 接入点描述。
EndpointId string: 推理接入点的ID。
EndpointModelType string: 接入点模型类型。取值:FoundationModel为基础模型;CustomModel为定制模型。
Id string: Uniquely identifies the resource.
ModelReference GetEndpointModelReference: 接入点接入模型。
ModelUnitId string: 模型单元，为空表示后付费；否则预付费。
Moderation GetEndpointModeration: 内容护栏方案。
Name string: 接入点名称。
ProjectName string: 资源所属的项目名称，默认值为default。
RateLimit GetEndpointRateLimit: 接入点限流。
RollingId string: 接入点切换的Id。
ScaleTierId string: 如果存在 TPM 保障包，则为 TPM 保障包 ID。
Status string: 接入点状态。
StatusReason string: 状态附加说明信息。
SupportRolling bool: 是否支持接入点切换模型版本。
SupportScaleTier bool: 是否支持TPM保障包。
Tags []GetEndpointTag: 接入点绑定的标签。
UpdateTime string: 接入点更新时间，RFC3339格式。

batchOnly Boolean: 是否只支持 BatchChat。如果为true，只能访问 Batch 推理接口，否则只能访问在线推理接口。
certificate GetEndpointCertificate: 证书信息。
createTime String: 接入点创建时间，RFC3339格式。
description String: 接入点描述。
endpointId String: 推理接入点的ID。
endpointModelType String: 接入点模型类型。取值:FoundationModel为基础模型;CustomModel为定制模型。
id String: Uniquely identifies the resource.
modelReference GetEndpointModelReference: 接入点接入模型。
modelUnitId String: 模型单元，为空表示后付费；否则预付费。
moderation GetEndpointModeration: 内容护栏方案。
name String: 接入点名称。
projectName String: 资源所属的项目名称，默认值为default。
rateLimit GetEndpointRateLimit: 接入点限流。
rollingId String: 接入点切换的Id。
scaleTierId String: 如果存在 TPM 保障包，则为 TPM 保障包 ID。
status String: 接入点状态。
statusReason String: 状态附加说明信息。
supportRolling Boolean: 是否支持接入点切换模型版本。
supportScaleTier Boolean: 是否支持TPM保障包。
tags List<GetEndpointTag>: 接入点绑定的标签。
updateTime String: 接入点更新时间，RFC3339格式。

batchOnly boolean: 是否只支持 BatchChat。如果为true，只能访问 Batch 推理接口，否则只能访问在线推理接口。
certificate GetEndpointCertificate: 证书信息。
createTime string: 接入点创建时间，RFC3339格式。
description string: 接入点描述。
endpointId string: 推理接入点的ID。
endpointModelType string: 接入点模型类型。取值:FoundationModel为基础模型;CustomModel为定制模型。
id string: Uniquely identifies the resource.
modelReference GetEndpointModelReference: 接入点接入模型。
modelUnitId string: 模型单元，为空表示后付费；否则预付费。
moderation GetEndpointModeration: 内容护栏方案。
name string: 接入点名称。
projectName string: 资源所属的项目名称，默认值为default。
rateLimit GetEndpointRateLimit: 接入点限流。
rollingId string: 接入点切换的Id。
scaleTierId string: 如果存在 TPM 保障包，则为 TPM 保障包 ID。
status string: 接入点状态。
statusReason string: 状态附加说明信息。
supportRolling boolean: 是否支持接入点切换模型版本。
supportScaleTier boolean: 是否支持TPM保障包。
tags GetEndpointTag[]: 接入点绑定的标签。
updateTime string: 接入点更新时间，RFC3339格式。

batch_only bool: 是否只支持 BatchChat。如果为true，只能访问 Batch 推理接口，否则只能访问在线推理接口。
certificate GetEndpointCertificate: 证书信息。
create_time str: 接入点创建时间，RFC3339格式。
description str: 接入点描述。
endpoint_id str: 推理接入点的ID。
endpoint_model_type str: 接入点模型类型。取值:FoundationModel为基础模型;CustomModel为定制模型。
id str: Uniquely identifies the resource.
model_reference GetEndpointModelReference: 接入点接入模型。
model_unit_id str: 模型单元，为空表示后付费；否则预付费。
moderation GetEndpointModeration: 内容护栏方案。
name str: 接入点名称。
project_name str: 资源所属的项目名称，默认值为default。
rate_limit GetEndpointRateLimit: 接入点限流。
rolling_id str: 接入点切换的Id。
scale_tier_id str: 如果存在 TPM 保障包，则为 TPM 保障包 ID。
status str: 接入点状态。
status_reason str: 状态附加说明信息。
support_rolling bool: 是否支持接入点切换模型版本。
support_scale_tier bool: 是否支持TPM保障包。
tags Sequence[GetEndpointTag]: 接入点绑定的标签。
update_time str: 接入点更新时间，RFC3339格式。

batchOnly Boolean: 是否只支持 BatchChat。如果为true，只能访问 Batch 推理接口，否则只能访问在线推理接口。
certificate Property Map: 证书信息。
createTime String: 接入点创建时间，RFC3339格式。
description String: 接入点描述。
endpointId String: 推理接入点的ID。
endpointModelType String: 接入点模型类型。取值:FoundationModel为基础模型;CustomModel为定制模型。
id String: Uniquely identifies the resource.
modelReference Property Map: 接入点接入模型。
modelUnitId String: 模型单元，为空表示后付费；否则预付费。
moderation Property Map: 内容护栏方案。
name String: 接入点名称。
projectName String: 资源所属的项目名称，默认值为default。
rateLimit Property Map: 接入点限流。
rollingId String: 接入点切换的Id。
scaleTierId String: 如果存在 TPM 保障包，则为 TPM 保障包 ID。
status String: 接入点状态。
statusReason String: 状态附加说明信息。
supportRolling Boolean: 是否支持接入点切换模型版本。
supportScaleTier Boolean: 是否支持TPM保障包。
tags List<Property Map>: 接入点绑定的标签。
updateTime String: 接入点更新时间，RFC3339格式。

Supporting Types

GetEndpointCertificate

NotAfter int: X509私有证书过期的时间。使用秒级时间戳表示。
NotBefore int: X509私有证书开始生效的时间。使用秒级时间戳表示。
PcaHost string: 证书方。
PcaInstanceCertificate string: PEM 格式的叶子证书。
PcaName string: 证书名称。
PcaRootCaCertificate string: PEM 格式的根证书。
PcaSubCaCertificate string: PEM 格式的中间根证书和根证书。

NotAfter int: X509私有证书过期的时间。使用秒级时间戳表示。
NotBefore int: X509私有证书开始生效的时间。使用秒级时间戳表示。
PcaHost string: 证书方。
PcaInstanceCertificate string: PEM 格式的叶子证书。
PcaName string: 证书名称。
PcaRootCaCertificate string: PEM 格式的根证书。
PcaSubCaCertificate string: PEM 格式的中间根证书和根证书。

notAfter Integer: X509私有证书过期的时间。使用秒级时间戳表示。
notBefore Integer: X509私有证书开始生效的时间。使用秒级时间戳表示。
pcaHost String: 证书方。
pcaInstanceCertificate String: PEM 格式的叶子证书。
pcaName String: 证书名称。
pcaRootCaCertificate String: PEM 格式的根证书。
pcaSubCaCertificate String: PEM 格式的中间根证书和根证书。

notAfter number: X509私有证书过期的时间。使用秒级时间戳表示。
notBefore number: X509私有证书开始生效的时间。使用秒级时间戳表示。
pcaHost string: 证书方。
pcaInstanceCertificate string: PEM 格式的叶子证书。
pcaName string: 证书名称。
pcaRootCaCertificate string: PEM 格式的根证书。
pcaSubCaCertificate string: PEM 格式的中间根证书和根证书。

not_after int: X509私有证书过期的时间。使用秒级时间戳表示。
not_before int: X509私有证书开始生效的时间。使用秒级时间戳表示。
pca_host str: 证书方。
pca_instance_certificate str: PEM 格式的叶子证书。
pca_name str: 证书名称。
pca_root_ca_certificate str: PEM 格式的根证书。
pca_sub_ca_certificate str: PEM 格式的中间根证书和根证书。

notAfter Number: X509私有证书过期的时间。使用秒级时间戳表示。
notBefore Number: X509私有证书开始生效的时间。使用秒级时间戳表示。
pcaHost String: 证书方。
pcaInstanceCertificate String: PEM 格式的叶子证书。
pcaName String: 证书名称。
pcaRootCaCertificate String: PEM 格式的根证书。
pcaSubCaCertificate String: PEM 格式的中间根证书和根证书。

GetEndpointModelReference

CustomModelId string: 定制模型的ID。
FoundationModel Volcengine.GetEndpointModelReferenceFoundationModel: 基础模型。

CustomModelId string: 定制模型的ID。
FoundationModel GetEndpointModelReferenceFoundationModel: 基础模型。

customModelId String: 定制模型的ID。
foundationModel GetEndpointModelReferenceFoundationModel: 基础模型。

customModelId string: 定制模型的ID。
foundationModel GetEndpointModelReferenceFoundationModel: 基础模型。

custom_model_id str: 定制模型的ID。
foundation_model GetEndpointModelReferenceFoundationModel: 基础模型。

customModelId String: 定制模型的ID。
foundationModel Property Map: 基础模型。

GetEndpointModelReferenceFoundationModel

ModelVersion string: 基础模型版本。
Name string: 基础模型名称。请注意模型名称为小写。doubao 1.5 代模型的模型名称格式为"doubao-1-5-**"。

ModelVersion string: 基础模型版本。
Name string: 基础模型名称。请注意模型名称为小写。doubao 1.5 代模型的模型名称格式为"doubao-1-5-**"。

modelVersion String: 基础模型版本。
name String: 基础模型名称。请注意模型名称为小写。doubao 1.5 代模型的模型名称格式为"doubao-1-5-**"。

modelVersion string: 基础模型版本。
name string: 基础模型名称。请注意模型名称为小写。doubao 1.5 代模型的模型名称格式为"doubao-1-5-**"。

model_version str: 基础模型版本。
name str: 基础模型名称。请注意模型名称为小写。doubao 1.5 代模型的模型名称格式为"doubao-1-5-**"。

modelVersion String: 基础模型版本。
name String: 基础模型名称。请注意模型名称为小写。doubao 1.5 代模型的模型名称格式为"doubao-1-5-**"。

GetEndpointModeration

Strategy string: 内容安全护栏方案。取值:Default: 默认方案。更低延迟，广泛覆盖内容安全通用需求;Basic：基本方案（公测中）。支持在接口响应中提供命中的风险分类，暂时只包含严重违规和激进行为两类风险。注意：如果是流式接口调用，不建议此方案，会导致吐出的每个分片的长度变长，延时变高。

Strategy string: 内容安全护栏方案。取值:Default: 默认方案。更低延迟，广泛覆盖内容安全通用需求;Basic：基本方案（公测中）。支持在接口响应中提供命中的风险分类，暂时只包含严重违规和激进行为两类风险。注意：如果是流式接口调用，不建议此方案，会导致吐出的每个分片的长度变长，延时变高。

strategy String: 内容安全护栏方案。取值:Default: 默认方案。更低延迟，广泛覆盖内容安全通用需求;Basic：基本方案（公测中）。支持在接口响应中提供命中的风险分类，暂时只包含严重违规和激进行为两类风险。注意：如果是流式接口调用，不建议此方案，会导致吐出的每个分片的长度变长，延时变高。

strategy string: 内容安全护栏方案。取值:Default: 默认方案。更低延迟，广泛覆盖内容安全通用需求;Basic：基本方案（公测中）。支持在接口响应中提供命中的风险分类，暂时只包含严重违规和激进行为两类风险。注意：如果是流式接口调用，不建议此方案，会导致吐出的每个分片的长度变长，延时变高。

strategy str: 内容安全护栏方案。取值:Default: 默认方案。更低延迟，广泛覆盖内容安全通用需求;Basic：基本方案（公测中）。支持在接口响应中提供命中的风险分类，暂时只包含严重违规和激进行为两类风险。注意：如果是流式接口调用，不建议此方案，会导致吐出的每个分片的长度变长，延时变高。

strategy String: 内容安全护栏方案。取值:Default: 默认方案。更低延迟，广泛覆盖内容安全通用需求;Basic：基本方案（公测中）。支持在接口响应中提供命中的风险分类，暂时只包含严重违规和激进行为两类风险。注意：如果是流式接口调用，不建议此方案，会导致吐出的每个分片的长度变长，延时变高。

GetEndpointRateLimit

Rpm int: Requests Per Minute，每分钟请求数。
Tpm int: Tokens Per Minute，每分钟请求 token 数。

Rpm int: Requests Per Minute，每分钟请求数。
Tpm int: Tokens Per Minute，每分钟请求 token 数。

rpm Integer: Requests Per Minute，每分钟请求数。
tpm Integer: Tokens Per Minute，每分钟请求 token 数。

rpm number: Requests Per Minute，每分钟请求数。
tpm number: Tokens Per Minute，每分钟请求 token 数。

rpm int: Requests Per Minute，每分钟请求数。
tpm int: Tokens Per Minute，每分钟请求 token 数。

rpm Number: Requests Per Minute，每分钟请求数。
tpm Number: Tokens Per Minute，每分钟请求 token 数。

GetEndpointTag

Key string: 标签键。
Value string: 标签值。

Key string: 标签键。
Value string: 标签值。

key String: 标签键。
value String: 标签值。

key string: 标签键。
value string: 标签值。

key str: 标签键。
value str: 标签值。

key String: 标签键。
value String: 标签值。

Package Details

Repository: volcenginecc volcengine/pulumi-volcenginecc
License: MPL-2.0
Notes: This Pulumi package is based on the volcenginecc Terraform Provider.

volcenginecc v0.0.2 published on Saturday, Oct 11, 2025 by Volcengine

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