云服务器内容精选

  • 获取账号、 IAM 用户、项目的名称和ID 从控制台获取账号名、账号ID、用户名、用户ID、项目名称、项目ID 在华为云首页右上角,单击“控制台”。 在右上角的用户名中选择“我的凭证”。 图1 进入我的凭证 在“我的凭证”界面,API凭证页签中,查看账号名、账号ID、用户名、用户ID、项目名称、项目ID。 每个区域的项目ID有所不同,需要根据业务所在的区域获取对应的项目ID。 图2 查看账号名、账号ID、用户名、用户ID、项目名称、项目ID 调用API获取用户ID、项目ID 获取用户ID请参考:管理员查询IAM用户列表。 获取项目ID请参考:查询指定条件下的项目列表。
  • 状态码 表1 状态码 状态码 编码 说明 100 Continue 继续请求。 这个临时响应用来通知客户端,它的部分请求已经被服务器接收,且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如,切换到HTTP的新版本协议。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求,但未处理完成。 203 Non-Authoritative Information 非授权信息,请求成功。 204 NoContent 请求完全成功,同时HTTP响应不包含响应体。 在响应OPTIONS方法的HTTP请求时返回此状态码。 205 Reset Content 重置内容,服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置,相应可返回一个资源特征与地址的列表用于用户终端(例如:浏览器)选择。 301 Moved Permanently 永久移动,请求的资源已被永久的移动到新的URI,返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。 使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改,服务器返回此状态码时,不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTP状态码。 400 BadRequest 非法请求。 建议直接修改该请求,不要重试该请求。 401 Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法,请确认用户名和密码是否正确。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。 返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 404 NotFound 所请求的资源不存在。 建议直接修改该请求,不要重试该请求。 405 MethodNotAllowed 请求中带有该资源不支持的方法。 建议直接修改该请求,不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证,与401类似,但请求者应当使用代理进行授权。 408 Request Time-out 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。 返回该状态码,表明请求的资源已被永久删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大,服务器无法处理,因此拒绝请求。为防止客户端的连续请求,服务器可能会关闭连接。如果只是服务器暂时无法处理,则会包含一个Retry-After的响应信息。 414 Request-URI Too Large 请求的URI过长(URI通常为网址),服务器无法处理。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 416 Requested range not satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 UnprocessableEntity 请求格式正确,但是由于含有语义错误,无法响应。 429 TooManyRequests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部,然后等待该首部指出的时间后再重试。 500 InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能,无法完成请求。 502 Bad Gateway 充当网关或代理的服务器,从远端服务器接收到了一个无效的请求。 503 ServiceUnavailable 被请求的服务无效。 建议直接修改该请求,不要重试该请求。 504 ServerTimeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时(Timeout)参数时会得到该响应。 505 HTTP Version not supported 服务器不支持请求的HTTP协议的版本,无法完成处理。 父主题: 附录
  • 响应消息体 响应消息体通常以结构化格式返回,与响应消息头中Content-type对应,传递除响应消息头之外的内容。 对于列出实例接口,返回如下消息体。 { "instances": [ { "identity_store_id": "d-66f****b80", "instance_id": "ins-2c1e********f3c6", "alias": null, "instance_urn": "IdentityCenter::system:instance:ins-2c1e********f3c6" } ], "page_info": { "next_marker": null, "current_count": 1 } } 当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示。 { "error_code": "IIC.1215", "error_msg": "only organizations administrator account can operate,please log in to the administrator account!", "request_id": "e311530********************51311" } 其中,error_code表示错误码,error_msg表示错误描述信息,request_id表示由服务创建来唯一确定本次请求的值,可以通过该值来定位问题。
  • 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 详细的公共响应消息头字段请参见下表。 表1 公共响应消息头 消息头名称 描述 Content-Type 资源内容的类型。 类型:String 默认值:无。 Connection 指明与服务器的连接是长连接还是短连接。 类型:String 有效值:keep-alive | close。 默认值:无。 Date 服务器响应的时间。 类型:String 默认值:无。 X-Request-Id 由服务创建来唯一确定本次请求的值,可以通过该值来定位问题。 类型:String 默认值:无。
  • AK/SK认证 AK/SK签名认证方式仅支持消息体大小12M以内。 AK/SK认证就是使用AK/SK对请求进行签名,在请求时将签名信息添加到消息头,从而通过身份认证。 AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。 SK(Secret Access Key):与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改。 使用AK/SK认证时,您可以基于签名算法使用AK/SK对请求进行签名,也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见:API签名指南。 签名SDK只提供签名功能,与服务提供的SDK不同,使用时请注意。
  • 请求消息头 添加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type:消息体的类型(格式),必选,默认取值为“application/json”。 Authorization:请求消息中可带的签名信息,必选,AK/SK认证的详细说明请参见:AK/SK认证。 X-Sdk-Date:请求发送的时间,必选,例如:20221107T020014Z。 Host:表明主机地址,必选,如identitycenter.myhuaweicloud.com。 API支持使用AK/SK认证,AK/SK认证是使用SDK对请求进行签名,签名过程会自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求头。AK/SK认证的详细说明请参见:AK/SK认证。 对于列出实例接口,请求如下所示。 GET https://identitycenter.myhuaweicloud.com/v1/instances content-type: application/json X-Sdk-Date: 20230330T021902Z host: identitycenter.myhuaweicloud.com Authorization: SDK-HMAC-SHA256 Access=xxxxxxxxxxxxxxxxxxx, SignedHeaders=content-type;host;x-sdk-date, Signature=xxxxxxxxxxxxxxxxxxxx
  • 请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 表1 请求URL 参数 说明 URI-scheme 传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint 承载REST服务端点的服务器 域名 或IP,不同服务在不同区域,Endpoint不同,可以从地区和终端节点处获取。例如IAM身份中心服务的Endpoint为identitycenter.myhuaweicloud.com。 resource-path 资源路径,即API访问路径。从具体API的URI模块获取,例如“列出实例”API的resource-path为“/v1/instances”。 query-string 查询参数,可选,查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“limit=10”,表示查询不超过10条数据。 例如您需要获取IAM身份中心的实例信息,则需使用IAM身份中心的Endpoint(identitycenter.myhuaweicloud.com),并在列出实例的URI部分找到resource-path(/v1/instances),拼接起来如下所示。 1 https://identitycenter.myhuaweicloud.com/v1/instances 为查看方便,每个具体API的URI,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
  • 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。 GET:请求服务器返回指定资源。 PUT:请求服务器更新指定资源。 POST:请求服务器新增资源或执行特殊操作。 DELETE:请求服务器删除指定资源,如删除对象等。 HEAD:请求服务器资源头部。 PATCH:请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。 在列出实例的URI部分,您可以看到其请求方法为“GET”,则其请求为: GET https://identitycenter.myhuaweicloud.com/v1/instances
  • API概览 表1 IAM身份中心接口列表 类型 说明 实例管理 包括列举实例列表的接口。 实例访问控制属性配置管理 包括启用指定实例的访问控制功能接口,以及获取、更新、解除指定实例的访问控制属性配置接口。 权限集管理 包括权限集的增删改查、为权限集添加/分离/列举系统身份策略或策略、获取/添加/删除权限集的自定义身份策略或策略、将权限集中的策略同步到账号、查询权限集同步状态、列举权限集关联的账号、列举分配给账号的权限集等接口。 账号分配管理 包括账号分配的增删查、账号分配创建/删除状态查询等接口。 标签管理 包括权限集标签的查询、添加和删除接口。 用户管理 包括用户的增删改查、查询用户ID等接口。 用户组管理 包括用户组的增删改查、查询用户组ID等接口。 用户/用户组绑定关系管理 包括绑定关系的增删查、查询绑定关系ID、列举组中的用户、列举用户加入的组、查询用户是否为组的成员等接口。 SCIM用户管理 包括SCIM协议的用户增删改查等接口。 SCIM用户组管理 包括SCIM协议的用户组增删改查等接口。 服务提供商管理 包括SCIM协议的服务提供商配置查询接口。 客户端管理 包括注册客户端的接口。 令牌管理 包括创建令牌的接口。 设备授权管理 包括请求设备授权的接口。 授权管理 包括登出用户的接口。 账号管理 包括列举账号信息的接口。 委托管理 包括列举账号委托或信任委托信息的接口。 凭证管理 包括获取委托或信任委托凭证的接口。
  • 基本概念 账号 用户注册时的账号,账号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于账号是付费主体,为了确保账号安全,建议您不要直接使用账号进行日常管理工作,而是创建用户并使用他们进行日常管理工作。 用户 由账号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。 在我的凭证下,您可以查看账号ID和IAM用户ID。通常在调用API的鉴权过程中,您需要用到账号、用户和密码等信息。 区域(Region) 从地理位置和网络时延维度划分,同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region,通用Region指面向公共租户提供通用云服务的Region;专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区(AZ,Availability Zone) AZ是一个或多个物理数据中心的集合,有独立的风火水电,AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连,以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源(计算资源、存储资源和网络资源),以默认项目为单位进行授权,用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制,可以在区域默认的项目中创建子项目,并在子项目中购买资源,然后以子项目为单位进行授权,使得用户仅能访问特定子项目中资源,使得资源的权限控制更加精确。 图1 项目隔离模型 父主题: 使用前必读
  • 概述 IAM身份中心为用户提供基于华为云组织的多账号统一身份管理与访问控制。可以统一管理企业中使用华为云的用户,一次性配置企业的身份管理系统与华为云的单点登录,以及所有用户对组织下账号的访问权限。管理员集中创建用户,分配登录密码,并对其进行分组管理。允许用户使用特定用户名和密码登录统一的用户门户网站,访问为其分配的多个账号下的资源,无需多次登录。且通过一个应用中的安全验证后,再访问其他应用中的受保护资源时,不再需要重新登录验证。 在调用IAM身份中心的API前,请确保已经充分了解了IAM身份中心的相关概念,详细信息请参阅产品介绍。 父主题: 使用前必读
  • 请求示例 根据用户ID,更新对应IAM身份中心用户的属性。 PUT https://{hostname}/v1/identity-stores/{identity_store_id}/users/{user_id} { "operations" : [ { "attribute_path" : "emails", "attribute_value" : "[{\"primary\":true,\"type\":\"Work\",\"value\":\"new-email@example.com\"}]" }, { "attribute_path" : "name", "attribute_value" : "{\"family_name\":\"姓氏\",\"given_name\":\"名字-new\"}" }, { "attribute_path" : "display_name", "attribute_value" : "用户显示名-new" } ] }
  • 响应参数 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求ID。 encoded_authorization_message String 鉴权信息。 状态码: 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求ID。 encoded_authorization_message String 鉴权信息。 状态码: 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求ID。 encoded_authorization_message String 鉴权信息。
  • 请求参数 表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时表示删除对应属性。
  • URI PUT /v1/identity-stores/{identity_store_id}/users/{user_id} 表1 路径参数 参数 是否必选 参数类型 描述 identity_store_id 是 String 身份源的全局唯一标识符(ID)。 最小长度:12 最大长度:12 user_id 是 String 身份源中IAM身份中心用户的全局唯一标识符(ID)。 最小长度:1 最大长度:64