文档

GetProxyAccess - 获取安全访问代理授权信息

更新时间:

获取安全访问代理的授权。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dms:GetProxyAccessRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ProxyAccessIdlong

安全访问授权 ID,当安全访问代理授权目标用户后,系统会自动生成一个安全访问授权 ID,该 ID 全局唯一。您可以调用 ListProxyAccesses 接口获取该参数。

1
Tidlong

租户 ID,可通过调用接口 GetUserActiveTenantListUserTenants 获取该参数的值。

3***

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求的 ID。用于定位日志,排查问题。

3CDB8601-AD74-4A47-8114-08E08CD6****
Successboolean

请求是否成功,返回值如下:

  • true:请求成功
  • false:请求失败
true
ErrorMessagestring

调用失败时,返回的错误信息。

The specified user not exists.
ErrorCodestring

错误码。

UserNotExist
ProxyAccessobject

安全访问代理授权信息。

ProxyAccessIdlong

安全访问授权 ID,当安全访问代理授权目标用户后,系统会自动生成一个安全访问授权 ID,该 ID 全局唯一。您可以调用 ListProxyAccesses 接口获取该参数。

2002
GmtCreatestring

安全访问代理权限的授权时间。

1643034647
AccessIdstring

安全访问代理授权账号。

hObpgEXoca42q***
OriginInfostring

开通安全访问代理权限的来源信息,返回值如下:

  • 责任人授权():括号中为责任人的 UID。
  • 工单授权():括号中为用户申请权限的工单号。
责任人授权(29490401597700****)
IndepAccountstring

独立账号。

***
UserIdlong

用户 ID。

12***
UserUidstring

用户 UID。

25936669186260****
UserNamestring

用户昵称。

user
ProxyIdlong

安全访问代理 ID。

说明 您可以通过调用 ListProxies 接口获取该参数。
1905
InstanceIdlong

实例 ID。

1922545

示例

正常返回示例

JSON格式

{
  "RequestId": "3CDB8601-AD74-4A47-8114-08E08CD6****",
  "Success": true,
  "ErrorMessage": "The specified user not exists.",
  "ErrorCode": "UserNotExist",
  "ProxyAccess": {
    "ProxyAccessId": 2002,
    "GmtCreate": "1643034647",
    "AccessId": "hObpgEXoca42q***",
    "OriginInfo": "责任人授权(29490401597700****)",
    "IndepAccount": "***",
    "UserId": 0,
    "UserUid": "25936669186260****",
    "UserName": "user",
    "ProxyId": 1905,
    "InstanceId": 1922545
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈