1. 接口描述
接口请求域名： oceanus.tencentcloudapi.com 。
描述资源配置接口
默认接口请求频率限制：35次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeResourceConfigs。 |
| Version | 是 | String | 公共参数，本接口取值：2019-04-22。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ResourceId | 否 | String | 资源ID 示例值：resource-xxx |
| Offset | 否 | Integer | 偏移量，仅当设置 Limit 时该参数有效 示例值：0 |
| Limit | 否 | Integer | 返回值大小，不填则返回全量数据 示例值：20 |
| ResourceConfigVersions.N | 否 | Array of Integer | 资源配置Versions集合 示例值：1 |
| JobConfigVersion | 否 | Integer | 作业配置版本 |
| JobId | 否 | String | 作业ID |
| WorkSpaceId | 否 | String | 工作空间 SerialId 示例值：space-xxx |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ResourceConfigSet | Array of ResourceConfigItem | 资源配置描述数组 示例值：[] |
| TotalCount | Integer | 资源配置数量 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询资源版本
查询资源版本
输入示例
POST / HTTP/1.1
Host: oceanus.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeResourceConfigs
<公共请求参数>
{
"ResourceId": "resource-qreuon9y",
"Limit": 1,
"WorkSpaceId": "space-53rqk422"
}输出示例
{
"Response": {
"RequestId": "d20bc7a4-8382-42d1-8f8b-91ec83eac1d5",
"ResourceConfigSet": [
{
"AppId": 1257058945,
"CreateTime": "2023-11-20 15:05:56",
"CreatorUin": "100032489861",
"OwnerUin": "100006386216",
"RefJobCount": 0,
"RefJobStatusCountSet": [],
"Region": "ap-guangzhou",
"Remark": "test",
"ResourceId": "resource-qreuon9y",
"ResourceLoc": {
"Param": {
"Bucket": "oceanus-online-resource01-gz-1257058918",
"Path": "1257058945/100006386216/upload/20231120150319/flink-hello-world-1.0.0.jar",
"Region": "ap-guangzhou"
},
"StorageType": 1
},
"ResourceType": 1,
"Status": 1,
"Version": 3
}
],
"TotalCount": 3
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.UnauthorizedOperation | 未授权操作。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InternalError.DB | 数据库异常。 |
| InvalidParameter.AppIdResourceNotMatch | AppId资源不匹配。 |
| InvalidParameter.UinResourceNotMatch | Uin资源不匹配。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.JobIdValueError | 作业id的参数无效。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.Job | 作业不存在。 |
| ResourceNotFound.ResourceConfig | 程序包版本不存在。 |
| UnsupportedOperation.NoPermissionAccess | 权限拦截,没有进入权限。 |
