有奖:语音产品征文挑战赛火热进行中> HOT
文档中心 > API 中心

1. 接口描述

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

角色修改

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyRole。
Version String 公共参数,本接口取值:2020-02-17。
Region String 公共参数,详见产品支持的 地域列表
RoleName String 角色名称,不支持中字以及除了短线和下划线外的特殊字符且长度必须大于0且小等于32。
示例值:test_role
ClusterId String 必填字段,集群Id
示例值:pulsar-xxxx
Remark String 备注说明,长度必须大等于0且小等于128。
示例值:更新角色
EnvironmentRoleSets.N Array of EnvironmentRoleSet 批量绑定名字空间信息
UnbindAllEnvironment Boolean 全部解绑名字空间,设置为 true

3. 输出参数

参数名称 类型 描述
RoleName String 角色名称
示例值:test_role
Remark String 备注说明
示例值:Remark1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 更新角色

更新角色

输入示例

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

{
    "RoleName": "abc",
    "Remark": "abc",
    "ClusterId": "abc",
    "EnvironmentRoleSets": [
        {
            "EnvironmentId": "abc",
            "Permissions": [
                "abc"
            ]
        }
    ],
    "UnbindAllEnvironment": true
}

输出示例

{
    "Response": {
        "RoleName": "abc",
        "Remark": "abc",
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure.UnauthorizedOperation CAM鉴权不通过。
FailedOperation.UpdateRole 角色更新失败。
InvalidParameterValue.InvalidParams 参数值不在允许范围内。
MissingParameter.NeedMoreParams 必要参数没有传递。
ResourceNotFound.BrokerCluster 服务的集群不存在。
ResourceNotFound.Cluster 集群不存在。
ResourceNotFound.Role 角色不存在。
ResourceUnavailable.FundRequired 需要充值才可继续操作。
http://www.vxiaotou.com