云服务器内容精选

  • API概览 表1 IAM身份中心接口列表 类型 说明 实例管理 包括列举实例列表的接口。 实例访问控制属性配置管理 包括启用指定实例的访问控制功能接口,以及获取、更新、解除指定实例的访问控制属性配置接口。 权限集管理 包括权限集的增删改查、为权限集添加/分离/列举系统身份策略或策略、获取/添加/删除权限集的自定义身份策略或策略、将权限集中的策略同步到账号、查询权限集同步状态、列举权限集关联的账号、列举分配给账号的权限集等接口。 账号分配管理 包括账号分配的增删查、账号分配创建/删除状态查询等接口。 标签管理 包括权限集标签的查询、添加和删除接口。 用户管理 包括用户的增删改查、查询用户ID等接口。 用户组管理 包括用户组的增删改查、查询用户组ID等接口。 用户/用户组绑定关系管理 包括绑定关系的增删查、查询绑定关系ID、列举组中的用户、列举用户加入的组、查询用户是否为组的成员等接口。 SCIM用户管理 包括SCIM协议的用户增删改查等接口。 SCIM用户组管理 包括SCIM协议的用户组增删改查等接口。 服务提供商管理 包括SCIM协议的服务提供商配置查询接口。 客户端管理 包括注册客户端的接口。 令牌管理 包括创建令牌的接口。 设备授权管理 包括请求设备授权的接口。 授权管理 包括登出用户的接口。 账号管理 包括列举账号信息的接口。 委托管理 包括列举账号委托或信任委托信息的接口。 凭证管理 包括获取委托或信任委托凭证的接口。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 agency_credentials Object 分配给用户在指定委托或信任委托下的凭证。 表4 agency_credentials 参数 参数类型 描述 access_key_id String 用于临时安全凭证的标识符。 expiration Long 临时安全凭证到期的日期。 secret_access_key String 用于对请求进行签名的密钥。 session_token String 用于临时凭证的令牌。
  • 响应示例 状态码: 200 Successful { "agency_credentials" : { "access_key_id" : "example-access-key-id", "expiration" : 1684955360, "secret_access_key" : "example-secret-access-key", "session_token" : "string" } }
  • 响应参数 状态码: 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 本页返回条目数量。
  • 响应示例 状态码: 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 Successful { "account_list" : [ { "account_id" : "5146d03d8aaaaaaaaaaaabbae60620a5", "account_name" : "example-account-name", "email_address" : "email@example.com" } ], "page_info" : { "next_marker" : null, "current_count" : 1 } }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 account_list Array of objects 满足查询条件的账号对象列表。 page_info Object 包含分页信息的对象。 表4 account_list 参数 参数类型 描述 account_id String 分配给用户的账号的全局唯一标识符(ID)。 account_name String 分配给用户的账号的名称。 email_address String 分配给用户的账号的电子邮箱地址。 最小长度:1 最大长度:254 表5 page_info 参数 参数类型 描述 next_marker String 如果存在,则表示可用的输出比当前响应中包含的输出多。在对操作的后续调用中,在标签请求参数中使用此值,以获取输出的下一部分。您应该重复此操作,直到next_marker响应元素返回为null。 current_count Integer 本页返回条目数量。
  • URI POST /v1/instances/{resource_type}/{resource_id}/tags/delete 表1 路径参数 参数 是否必选 参数类型 描述 resource_type 是 String 资源类型。 枚举值: identitycenter:permissionset(权限集) resource_id 是 String 权限集的唯一标识符(ID)。 最大长度:130
  • 响应参数 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 request_id String 请求唯一标识 状态码: 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 request_id String 请求唯一标识
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 最大长度:2048 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 是 Array of objects 用于管理资源的一组键值对。 数组长度:1 - 20 表4 tags 参数 是否必选 参数类型 描述 key 是 String 标签的键。 最小长度:1 最大长度:128 value 否 String 标签的值,可以为空字符串,但不能为null。 最小长度:0 最大长度:255
  • 响应示例 状态码: 200 Successful { "instances" : [ { "identity_store_id" : "d-a00aaaa33f", "alias" : "new-store-id-123", "instance_id" : "ins-bd8baaaaaaaade60" } ], "page_info" : { "next_marker" : null, "current_count" : 1 } }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 instances Array of objects IAM身份中心实例信息列表。 page_info Object 包含分页信息的对象。 表4 instances 参数 参数类型 描述 identity_store_id String 关联到IAM身份中心实例的身份源的全局唯一标识符(ID)。 最小长度:1 最大长度:64 instance_id String IAM身份中心实例的全局唯一标识符(ID)。 最小长度:20 最大长度:20 alias String 用户为身份源标识符定义的别名。 instance_urn String 实例的统一资源名称(URN)。 表5 page_info 参数 参数类型 描述 next_marker String 如果存在,则表示可用的输出比当前响应中包含的输出多。在对操作的后续调用中,在标签请求参数中使用此值,以获取输出的下一部分。您应该重复此操作,直到next_marker响应元素返回为null。 current_count Integer 本页返回条目数量。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。
  • 请求示例 根据用户组ID,更新对应IAM身份中心用户组的属性。 PUT https://{hostname}/v1/identity-stores/{identity_store_id}/groups/{group_id} { "operations" : [ { "attribute_path" : "description", "attribute_value" : "更新用户组描述" } ] }
  • URI PUT /v1/identity-stores/{identity_store_id}/groups/{group_id} 表1 路径参数 参数 是否必选 参数类型 描述 identity_store_id 是 String 身份源的全局唯一标识符(ID)。 最小长度:12 最大长度:12 group_id 是 String 身份源中IAM身份中心用户组的全局唯一标识符(ID)。 最小长度:1 最大长度:64
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 最大长度:2048 表3 请求Body参数 参数 是否必选 参数类型 描述 operations 是 Array of objects 更新的用户组属性列表。 数组长度:1-100 表4 operations 参数 是否必选 参数类型 描述 attribute_path 是 String 要更新的属性的字符串表示。 最小长度:1 最大长度:255 attribute_value 否 String 要更新的属性值。当属性为对象类型时,此处填写对象的JSON字符串。为null时表示删除对应属性。