1. 接口描述
接口请求域名: oceanus.tencentcloudapi.com 。
描述资源接口
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeResources。 |
Version | 是 | String | 公共参数,本接口取值:2019-04-22。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ResourceIds.N | 否 | Array of String | 需要查询的资源ID数组,数量不超过100个。如果填写了该参数则忽略Filters参数。 示例值:["resource-8udfak5k","resource-8udfak5j"] |
Offset | 否 | Integer | 偏移量,仅当设置 Limit 参数时有效 示例值:0 |
Limit | 否 | Integer | 条数限制。如果不填,默认返回 20 条 示例值:20 |
Filters.N | 否 | Array of Filter | 按照资源名字过滤,支持模糊过滤。传入的过滤名字不超过5个 类型: String 必选: 否 示例值:[] |
WorkSpaceId | 否 | String | 工作空间 SerialId 示例值:space-xxx |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ResourceSet | Array of ResourceItem | 资源详细信息集合 |
TotalCount | Integer | 总数量 示例值:[] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询资源
输入示例
POST / HTTP/1.1
Host: oceanus.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeResources
<公共请求参数>
{
"ResourceIds": [
"resource-qreuon9y"
],
"Offset": 0,
"Limit": 0,
"WorkSpaceId": "space-53rqk422"
}
输出示例
{
"Response": {
"RequestId": "2f1a8e8b-a5e7-41a1-a96c-f40091d6ffff",
"ResourceSet": [
{
"AppId": 1257058945,
"CreateTime": "2023-08-16 20:29:58",
"CreatorUin": "100032489861",
"FileName": "flink-hello-world-1.0.0.jar",
"LatestResourceConfigVersion": 1,
"Name": "flink-hello-world-1.0.0.jar",
"OwnerUin": "100006386216",
"RefJobCount": 2,
"IsJobRun": 0,
"RefJobStatusCountSet": [
{
"Count": 1,
"JobStatus": 5
},
{
"Count": 3,
"JobStatus": 4
}
],
"Region": "ap-guangzhou",
"Remark": "test",
"ResourceId": "resource-qreuon9y",
"ResourceLoc": {
"Param": {
"Bucket": "oceanus-online-resource01-gz-1257058918",
"Path": "1257058945/100006386216/upload/20230816202945/flink-hello-world-1.0.0.jar",
"Region": "ap-guangzhou"
},
"StorageType": 1
},
"ResourceType": 1,
"UpdateTime": "2023-08-16 20:29:58",
"VersionCount": 1,
"WorkSpaceId": 2892
}
],
"TotalCount": 1
}
}
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 | 数据库异常。 |
InternalError.LogicError | 内部错误。 |
InvalidParameterValue | 参数取值错误。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.ResourceConfig | 程序包版本不存在。 |
UnsupportedOperation.NoPermissionAccess | 权限拦截,没有进入权限。 |