创建共享单元

最近更新时间:2024-07-12 01:22:14

我的收藏

1. 接口描述

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

创建共享单元。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:AddShareUnit。
Version String 公共参数,本接口取值:2021-03-31。
Region String 公共参数,本接口不需要传递此参数。
Name String 共享单元名称。仅支持大小写字母、数字、-、以及_的组合,3-128个字符。
示例值:myShareUnit
Area String 共享单元地域。可通过接口DescribeShareAreas获取支持共享的地域。
示例值:ap-guangzhou
Description String 共享单元描述。最大128个字符。
示例值:share unit
ShareScope Integer 共享范围。取值:1-仅允许集团组织内共享 2-允许共享给任意账号,默认值:1
示例值:1

3. 输出参数

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

4. 示例

示例1 新建共享单元

输入示例

https://organization.tencentcloudapi.com/?Action=AddShareUnit
&Name=myShareUnit
&Area=ap-guangzhou
&Description=share unit
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "5ef007aa-2dc5-4729-a880-b7ac69d94714",
        "UnitId": "shareUnit-xhre**ra2p"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.AuthInfoEmpty 用户未实名。
FailedOperation.AuthNotEnterprise 用户非企业实名。
FailedOperation.ResourceOverLimit 资源超过最大上限。
InternalError 内部错误。
InvalidParameter 参数错误。
OperationDenied 操作被拒绝。
ResourceNotFound.OrganizationNotExist 企业组织不存在。
ResourceUnavailable 资源不可用。
UnsupportedOperation 操作不支持。