帮你快速理解、总结文档立即下载

获取RayJob的YAML内容

最近更新时间:2026-08-04 01:50:09

我的收藏

1. 接口描述

接口请求域名: dlc.tencentcloudapi.com 。

获取RayJob的YAML内容

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetRayJobYaml。
Version String 公共参数,本接口取值:2021-01-25。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。
Id String 任务ID
示例值:rayjob-5k01-1772774904

3. 输出参数

参数名称 类型 描述
Yaml String RayJob YAML
示例值:Error getting RayJob yaml:
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取RayJob的YAML内容

输入示例

POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetRayJobYaml
<公共请求参数>

{
    "Id": "rayjob-5k01-1772774904"
}

输出示例

{
    "Response": {
        "Yaml": "Error getting RayJob yaml: Failure executing: GET at: https://169.254.128.105:60002/apis/ray.io/v1/namespaces/kuberay-system/rayjobs/rayjob-5k01-1772774904. Message: rayjobs.ray.io \"rayjob-5k01-1772774904\" is forbidden: User \"system:serviceaccount:ns-prj64sxb-4423535-dev-test:default\" cannot get resource \"rayjobs\" in API group \"ray.io\" in the namespace \"kuberay-system\". Received status: Status(apiVersion=v1, code=403, details=StatusDetails(causes=[], group=ray.io, kind=rayjobs, name=rayjob-5k01-1772774904, retryAfterSeconds=null, uid=null, additionalProperties={}), kind=Status, message=rayjobs.ray.io \"rayjob-5k01-1772774904\" is forbidden: User \"system:serviceaccount:ns-prj64sxb-4423535-dev-test:default\" cannot get resource \"rayjobs\" in API group \"ray.io\" in the namespace \"kuberay-system\", metadata=ListMeta(_continue=null, remainingItemCount=null, resourceVersion=null, selfLink=null, additionalProperties={}), reason=Forbidden, status=Failure, additionalProperties={}).",
        "RequestId": "07be2b2e-1e50-4eb7-9ca8-46ca6a08273d"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.ExternalService 外部服务异常