云服务器内容精选

  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 表2 请求Body参数 参数 是否必选 参数类型 描述 service_principal 是 String 服务主体名称。 account_id 是 String 账号的唯一标识符(ID)。
  • 响应示例 状态码: 200 Successful { "agency_list" : [ { "account_id" : "5146d03d8aaaaaaaaaaaabbae60620a5", "agency_name" : "example-agency-name", "permission_set_name" : "example-permission-set-name", "agency_urn" : "example-agency-urn", "description" : "example agency" } ], "page_info" : { "next_marker" : null, "current_count" : 1 }}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 agency_list Array of objects 满足查询条件的委托或信任委托对象列表。 page_info Object 包含分页信息的对象。 表4 agency_list 参数 参数类型 描述 account_id String 分配给用户的账号的全局唯一标识符(ID)。 agency_name String 分配给用户的委托或信任委托的名称。 permission_set_name String 权限集名称。 agency_urn String 委托或信任委托的统一资源名称(URN)。 description String 描述信息。 表5 page_info 参数 参数类型 描述 next_marker String 如果存在,则表示可用的输出比当前响应中包含的输出多。在对操作的后续调用中,在标签请求参数中使用此值,以获取输出的下一部分。您应该重复此操作,直到next_marker响应元素返回为null。 current_count Integer 本页返回条目数量。
  • 响应示例 状态码: 400 { "error_code" : "EG.00014000", "error_msg" : "Bad request"} 状态码: 401 { "error_code" : "EG.00014010", "error_msg" : "Incorrect token or token resolution failed"} 状态码: 403 { "error_code" : "EG.00014030", "error_msg" : "No permissions to request this method"} 状态码: 404 { "error_code" : "EG.00014040", "error_msg" : "Not request resource found"} 状态码: 500 { "error_code" : "EG.00015000", "error_msg" : "Internal Server Error"}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 agencies Array of strings 服务委托授权记录。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:128 error_msg String 错误消息 最小长度:1 最大长度:512 error_details String 具体错误消息 最小长度:1 最大长度:1024 request_id String 请求处理ID 最小长度:1 最大长度:128 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:128 error_msg String 错误消息 最小长度:1 最大长度:512 error_details String 具体错误消息 最小长度:1 最大长度:1024 request_id String 请求处理ID 最小长度:1 最大长度:128 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:128 error_msg String 错误消息 最小长度:1 最大长度:512 error_details String 具体错误消息 最小长度:1 最大长度:1024 request_id String 请求处理ID 最小长度:1 最大长度:128 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:128 error_msg String 错误消息 最小长度:1 最大长度:512 error_details String 具体错误消息 最小长度:1 最大长度:1024 request_id String 请求处理ID 最小长度:1 最大长度:128 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:128 error_msg String 错误消息 最小长度:1 最大长度:512 error_details String 具体错误消息 最小长度:1 最大长度:1024 request_id String 请求处理ID 最小长度:1 最大长度:128
  • URI GET /v1/{project_id}/service-agencies 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID 表2 Query参数 参数 是否必选 参数类型 描述 type 是 String 服务委托授权场景类型 枚举值: TARGET_CONNECTION CUSTOM_SOURCE_RABBITMQ EG_RESTORE_AGENCY
  • URI GET https://localhost.com/v1/agency 表1 Query参数 参数 是否必选 参数类型 描述 policy_type 否 String 参数解释:策略类型。 约束限制:支持模糊匹配。 取值范围: FABRIC_COMMON_POLICY:基础通用服务相关权限策略,是委托必需的权限策略; FABRIC_SELF_POLICY:访问自身服务所需要的权限策略; FABRIC_ SMN _POLICY: 消息通知 功能相关权限策略,用来将系统通知消息转发到SMN; FABRIC_LAKEFORMATION_POLICY:LakeFormation功能相关权限策略; FABRIC_ AOM _POLICY:AOM功能相关权限策略。 FABRIC_SWR_POLICY:镜像包注册功能相关权限策略。 默认取值:不涉及。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 agency_name String 参数解释:委托名称。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 authorized Boolean 授权与否。如果用户的服务委托权限包含系统所需要的委托权限返回true,否则返回false。 agency_policies Array of AgencyPolicy objects 委托策略列表。 表4 AgencyPolicy 参数 参数类型 描述 policy_type String 参数解释:权限类型列表;使用Fabric的功能,可能需要授权一些权限策略,可以在policy_types中加入策略类型来授权权限。 约束限制:不涉及。 取值范围: FABRIC_COMMON_POLICY:基础通用服务相关权限策略,是委托必需的权限策略; FABRIC_SELF_POLICY:访问自身服务所需要的权限策略; FABRIC_SMN_POLICY:消息通知功能相关权限策略,用来将系统通知消息转发到SMN; FABRIC_LAKEFORMATION_POLICY:LakeFormation功能相关权限策略; FABRIC_AOM_POLICY:AOM功能相关权限策略。 FABRIC_SWR_POLICY:镜像包注册功能相关权限策略。 默认取值:不涉及。 is_required Boolean 是否是必需的。 is_enable Boolean 是否已开启。 actions Array of strings 权限列表。 description String 参数解释:策略描述。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。 状态码: 404 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。 状态码: 408 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。
  • 响应示例 状态码: 200 Successful. { "delegated_administrators" : [ { "delegation_enabled_at" : "autoservice0922102321263V58H", "account_id" : "0a6d25d23900d45c0faac010e0fb4de0", "account_urn" : "urnstring", "join_method" : "invited", "joined_at" : "2022-08-24T06:41:15Z", "account_name" : "paas_iam_573331" } ], "page_info" : { "next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw", "current_count" : 100 } }
  • 响应示例 状态码为 200 时: 请求成功。 { "agencies": [ { "create_time": "2020-01-04T03:37:16.000000", "description": "", "domain_id": "d78cbac186b744899480f25b...8", "duration": "FOREVER", "expire_time": null, "id": "0760a9e2a60026664f1fc0031f9f2...", "name": " IAM Agency", "agency_urn": "iam::d78cbac186b744899480f25b...8:agency:IAMAgency", "trust_domain_id": "a2cd82a33fb043dc9304bf72...", "trust_domain_name": "IAMDomainB" } ] }
  • 响应参数 表3 响应Body参数 参数 参数类型 描述 agencies Array of objects 委托信息列表。 表4 agencies 参数 参数类型 描述 create_time String 委托创建时间。 说明: UTC时间,格式为YYYY-MM-DDTHH:mm:ss.ssssss,日期和时间戳格式如:2023-06-28T08:56:33.710000。 description String 委托描述信息。 domain_id String 委托方账号ID。 duration String 委托的期限。取值为"FOREVER"或“null”表示委托的期限为永久,取值为"ONEDAY"表示委托的期限为一天。 expire_time String 委托过期时间。“null”表示不过期。 说明: UTC时间,格式为YYYY-MM-DDTHH:mm:ss.ssssss,日期和时间戳格式如:2023-06-28T08:56:33.710000。 id String 委托ID。 name String 委托名。 agency_urn String 委托URN。 trust_domain_id String 被委托方账号ID。 trust_domain_name String 被委托方账号名。
  • URI GET /v3.0/OS-AGENCY/agencies 表1 Query参数 参数 是否必选 参数类型 描述 domain_id 是 String 委托方账号ID,获取方式请参见:获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 说明: X-Auth-Token字段填写拥有策略权限的token时,domain_id非必选。 name 否 String 委托名,获取方式请参见:获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 trust_domain_id 否 String 被委托方账号ID,获取方式请参见:获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 page 否 Integer 分页查询时数据的页数,查询值最小为1。需要与per_page同时存在。 per_page 否 Integer 分页查询时每页的数据个数,取值范围为[1,500]。需要与page同时存在。
  • URI GET /v3.0/OS-AGENCY/projects/{project_id}/agencies/{agency_id}/roles 表1 路径参数 参数 是否必选 参数类型 描述 agency_id 是 String 委托ID,获取方式请参见:获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 project_id 是 String 委托方的项目ID,获取方式请参见:获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。
  • 响应示例 状态码为 200 时: 请求成功。 { "roles": [ { "domain_id": null, "flag": "fine_grained", "description_cn": " 应用运维管理 服务只读权限", "catalog": "AOM", "name": "system_all_30", "description": "AOM read only", "id": "75cfe22af2b3498d82b655fbb39de498", "display_name": "AOM Viewer", "type": "XA", "policy": { "Version": "1.1", "Statement": [ { "Action": [ "aom:*:list", "aom:*:get", "apm:*:list", "apm:*:get" ], "Effect": "Allow" } ] } } ] }
  • 操作步骤 委托方登录华为云。 访问网址: API Explorer -为委托授予所有项目服务权限,进入API Explorer接口运行调试平台。 获取并编辑接口调试参数。 Region 调用API的区域。选择任一区域。 Headers X-Auth-Token:委托方Token。登录华为云后已自动获取,无需编辑。 Params agency_id 在控制台右上角的用户名下拉菜单中选择“ 统一身份认证 ”,进入IAM控制台,选择“委托”页签,将鼠标移动到需要查询ID的委托上,黑色框中出现的第二行为委托ID,单击委托ID右侧的直接复制 图1 agency_id domain_id 在控制台右上角的用户名下拉菜单中选择“我的凭证”,在“我的凭证”界面,“API凭证”页签中查看并复制账号ID。 图2 domain_id role_id 权限ID。 权限名称 权限ID Tenant Administrator e2d75429549044d2b313fbdd11520f7d Tenant Guest c40fc1b70fb14140a61ac60c7c292874 role_id只能输入一个权限ID。如需修改多个委托权限,请分别调用该接口。 如需获取其它权限ID,请参见:查看权限列表。 单击“调试”,发送接口请求。 调试成功,为委托授予所有项目服务权限。