更新时间:2025-07-08 GMT+08:00
分享

获取业务委托

功能介绍

获取业务委托。

URI

GET /v1/{project_id}/system/agencies

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,您可以从获取项目ID中获取。

约束限制

不涉及

取值范围

仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。

默认取值

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。

Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。

约束限制

不涉及

取值范围

长度为[1-32768]个字符。

默认取值

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

existing_agencies

Array of AgencyDto objects

参数解释:

当前存在的委托权限列表。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

wanted_agencies

Array of AgencyDto objects

参数解释:

仍需要的委托权限列表。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

redundant_agencies

Array of AgencyDto objects

参数解释:

冗余的委托权限列表。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表4 AgencyDto

参数

参数类型

描述

id

String

参数解释:

委托ID,用于唯一标识一个委托。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

name

String

参数解释:

委托名,用于标识委托。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

trust_domain_name

String

参数解释:

被委托方账号名,用于标识被委托方。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

description

String

参数解释:

委托描述,用于描述委托的用途或含义。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

roles

Array of IamRoleDto objects

参数解释:

委托权限列表,包含多个权限信息。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表5 IamRoleDto

参数

参数类型

描述

id

String

参数解释:

权限ID,用于唯一标识一个权限。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

display_name

String

参数解释:

权限显示名称,用于展示权限的名称。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

type

String

参数解释:

权限类型,用于标识权限的级别。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

description

String

参数解释:

权限描述,用于描述权限的用途或含义。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

actions

Array of strings

参数解释:

授权项,指对资源的具体操作权限。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求示例

获取业务委托。

/v1/{project_id}/system/agencies

响应示例

状态码:200

OK

{
  "existing_agencies" : [ {
    "id" : "id",
    "name" : "agency-name",
    "description" : "description",
    "trust_domain_name" : "op_svc_eihealth",
    "roles" : [ {
      "id" : "id",
      "display_name" : "role-name",
      "description" : "description",
      "type" : "XA",
      "actions" : [ [ "css:cluster:get", "css:cluster:list" ] ]
    } ]
  } ],
  "wanted_agencies" : [ ],
  "redundant_agencies" : [ ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档