1. 接口描述
接口请求域名: organization.tencentcloudapi.com 。
获取共享单元资源列表。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeShareUnitResources。 |
Version | 是 | String | 公共参数,本接口取值:2021-03-31。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
UnitId | 是 | String | 共享单元ID。 示例值:shareUnit-xhre**ra2p |
Area | 是 | String | 共享单元地域。 示例值:ap-guangzhou |
Offset | 是 | Integer | 偏移量。取值是limit的整数倍,默认值 : 0 示例值:0 |
Limit | 是 | Integer | 限制数目。取值范围:1~50。 示例值:10 |
SearchKey | 否 | String | 搜索关键字。支持产品资源ID搜索。 示例值:"" |
Type | 否 | String | 共享资源类型。支持共享的资源类型,请参见资源共享概述 示例值:secret |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Total | Integer | 总数目。 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
Items | Array of ShareUnitResource | 共享单元资源列表。 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取共享单元资源列表
输入示例
POST / HTTP/1.1
Host: organization.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeShareUnitResources
<公共请求参数>
{
"Offset": 0,
"Area": "ap-guangzhou",
"Limit": 10,
"UnitId": "shareUnit-xhre**ra2p"
}
输出示例
{
"Response": {
"Items": [
{
"CreateTime": "2021-03-06 17:11:30",
"ResourceId": "shareUnit-12**erte",
"ProductResourceId": "sec***002",
"Type": "secret",
"SharedMemberNum": 2,
"SharedMemberUseNum": 0,
"ShareManagerUin": 111111111111
}
],
"RequestId": "538e6bb8-704d-4594-b297-95bd2535ecc0",
"Total": 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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
OperationDenied | 操作被拒绝。 |
ResourceNotFound | 资源不存在。 |
UnsupportedOperation | 操作不支持。 |