云服务器内容精选

  • 响应示例 状态码: 200 请求成功。 { "control_summaries" : [ { "manage_account_id" : "string", "control_identifier" : "string", "state" : "string", "version" : "string", "name" : "string", "description" : "string", "control_objective" : "string", "behavior" : "string", "owner" : "string", "regional_preference" : "string", "guidance" : "string", "service" : "string" } ], "state" : "string", "page_info" : { "next_marker" : "string", "description" : "本页返回条目数量。", "current_count" : 0 } }
  • URI GET /v1/governance/managed-organizational-units/{managed_organizational_unit_id}/controls 表1 路径参数 参数 是否必选 参数类型 描述 managed_organizational_unit_id 是 String 注册OU ID。 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 分页页面的最大值。 最小值:1 最大值:2000 缺省值:200 marker 否 String 页面标记。 最小长度:1 最大长度:64
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 control_summaries Array of TargetControl objects 治理策略概要。 page_info PageInfoDto object 本页返回条目数量。 表4 TargetControl 参数 参数类型 描述 manage_account_id String 管理纳管账号ID。 最小长度:1 最大长度:64 control_identifier String 控制策略标识。 最小长度:1 最大长度:128 state String 控制策略启用状态。 最小长度:1 最大长度:64 version String 控制策略当前版本号。 最小长度:1 最大长度:64 name String 控制策略名称。 最小长度:1 最大长度:64 description String 控制策略描述信息。 最小长度:1 最大长度:64 control_objective String 控制策略目标。 最小长度:1 最大长度:128 behavior String 控制策略类型。包括主动性控制策略Proactive、检测性控制策略Detective、预防性控制策略Preventive。 最小长度:1 最大长度:64 owner String 纳管账号的创建来源,包括CUSTOM和RGC。 最小长度:1 最大长度:128 regional_preference String 区域选项,取值有两种分别是:区域的regional和全局的global。 最小长度:1 最大长度:128 guidance String 控制策略必须性。 最小长度:1 最大长度:64 service String 控制策略所属服务。 最小长度:1 最大长度:64 implementation String 服务控制策略(SCP),配置规则。 最小长度:1 最大长度:64 表5 PageInfoDto 参数 参数类型 描述 next_marker String 在标签请求参数中使用以获取输出的下一部分。重复此操作,直到响应元素返回null。如果存在,则表示可用的输出比当前响应中包含的输出多。 current_count Integer 本页返回条目数量。
  • 获取账号、IAM用户、项目的名称和ID 从控制台获取账号名、账号ID、用户名、用户ID、项目名称、项目ID 在华为云首页右上角,单击“控制台”。 在右上角的用户名中选择“我的凭证”。 图1 进入我的凭证 在“我的凭证”界面,API凭证页签中,查看账号名、账号ID、用户名、用户ID、项目名称、项目ID。 每个区域的项目ID有所不同,需要根据业务所在的区域获取对应的项目ID。 图2 查看账号名、账号ID、用户名、用户ID、项目名称、项目ID 调用API获取用户ID、项目ID 获取用户ID请参考:管理员查询IAM用户列表。 获取项目ID请参考:查询指定条件下的项目列表。
  • 概述 欢迎使用资源治理中心(Resource Governance Center,简称RGC)。RGC是照规范性最佳实践提供一种简单的方案发设置和管理多账户环境,用户可以通过RGC服务创建一个Landing Zone,包含一个管理账号和多个成员账号,同时对这些账号进行各种自动化的护栏配置,帮助客户方便快速安全上云。 您可以使用本文档提供API对RGC进行相关操作,如创建、删除、更新、查询等。支持的全部操作请参见API概览。 在调用RGC的API之前,请确保已经充分了解RGC相关概念,详细信息请参见资源治理中心产品介绍。 父主题: 使用前必读
  • AK/SK认证 AK/SK签名认证方式仅支持消息体大小12M以内,12M以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名,在请求时将签名信息添加到消息头,从而通过身份认证。 AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。 SK(Secret Access Key):与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改。 使用AK/SK认证时,您可以基于签名算法使用AK/SK对请求进行签名,也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见:API签名指南。 签名SDK只提供签名功能,与服务提供的SDK不同,使用时请注意。
  • 状态码 表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协议的版本,无法完成处理。 父主题: 附录
  • 操作(Action) 操作(Action)即为策略中支持的操作项。 “访问级别”列描述如何对操作进行分类(list、read和write等)。此分类可帮助您了解在策略中相应操作对应的访问级别。 “资源类型”列指每个操作是否支持资源级权限。 资源类型支持通配符号*表示所有。如果此列没有值(-),则必须在策略语句的Resource元素中指定所有资源类型(“*”)。 如果该列包含资源类型,则必须在具有该操作的语句中指定该资源的URN。 资源类型列中必需资源在表中用星号(*)标识,表示使用此操作必须指定该资源类型。 “条件键”列包括了可以在策略语句的Condition元素中支持指定的键值。 如果该操作项资源类型列存在值,则表示条件键仅对列举的资源类型生效。 如果该操作项资源类型列没有值(-),则表示条件键对整个操作项生效。 如果此列没有值(-),表示此操作不支持指定条件键。 您可以在自定义策略语句的Action元素中指定以下RGC的相关操作。
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 control_operation ControlOperation object 控制策略实施的情况。 表3 ControlOperation 参数 参数类型 描述 operation_control_status_id String 本次操作控制策略的ID。 最小长度:1 最大长度:64 operation_type String 操作类型,启用控制策略或禁用控制策略。 最小长度:1 最大长度:64 status String 控制策略实施的状态 SUCCEEDED | FAILED | IN_PROGRESS。 最小长度:1 最大长度:64 message String 控制策略实施失败的错误信息。 最小长度:1 最大长度:2048 start_time String 操作开始的时间。 end_time String 操作结束的时间。
  • 响应示例 状态码: 200 请求成功。 { "control_operation" : { "operation_control_status_id" : "string", "operation_type" : "string", "status" : "string", "message" : "string", "start_time" : "string", "end_time" : "string" } }
  • 响应消息体 响应消息体通常以结构化格式返回,与响应消息头中Content-type对应,传递除响应消息头之外的内容。 对于查询控制策略操作状态接口,返回如下消息体。 { "control_operation": { "operation_control_status_id": "c0jquihv-x3ve-1lb9-qmix-dankod8dg86z", "operation_type": "ENABLE_CONTROL", "status": "SUCCEEDED", "message": "", "start_time": "2024-04-19T16:26:30.518", "end_time": "2024-04-19T16:26:30.618" } } 当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示。 { "error_msg": "error msg", "error_code": "APIGW.0301", "request_id": "string" } 其中,error_code表示错误码,error_msg表示错误描述信息。
  • 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 详细的公共响应消息头字段请参见表1。 表1 公共响应消息头 消息头名称 描述 Content-Type 资源内容的类型。 类型:String 默认值:无 Connection 指明与服务器的连接是长连接还是短连接。 类型:String 有效值:keep-alive | close。 默认值:无。 Date RGC服务响应的时间。 类型:String 默认值:无 X-Request-Id 由RGC创建来唯一确定本次请求的值,可以通过该值来定位问题。 类型:String 默认值:无
  • 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。 GET:请求服务器返回指定资源。 PUT:请求服务器更新指定资源。 POST:请求服务器新增资源或执行特殊操作。 DELETE:请求服务器删除指定资源,如删除对象等。 HEAD:请求服务器资源头部。 PATCH:请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。 在查询控制策略操作状态的URI部分,您可以看到其请求方法为“GET”,则其请求为: GET https://rgc.cn-north-4.myhuaweicloud.com/v1/governance/operation-control-status/{operation_control_status_id}
  • 请求消息体 请求消息体通常以结构化格式发出,与请求消息头中Content-type对应,传递除请求消息头之外的内容。若请求消息体中参数支持中文,则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 发起请求 您可以使用curl、Postman或直接编写代码等方式发送请求调用API。
  • 请求消息头 附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。 如下公共消息头需要添加到请求中。 表2 消息头名称 描述 是否必选 Content-Type 消息体的类型(格式),必选,默认取值为“application/json”,有其他取值时会在具体接口中专门说明。 是 Authorization 请求消息中可带的签名信息,必选,AK/SK认证的详细说明请参见:AK/SK认证。 是 Host 表明主机地址,必选,例如:rgc.cn-north-4.myhuaweicloud.com。 是 X-Sdk-Date 请求发起端的日期和时间,必选,例如:20221107T020014Z。 是 API支持使用AK/SK认证,AK/SK认证是使用SDK对请求进行签名,签名过程会自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求头。AK/SK认证的详细说明请参见:AK/SK认证。 对于查询控制策略操作状态接口,请求如下所示。 GET https://rgc.cn-north-4.myhuaweicloud.com/v1/governance/operation-control-status/c0jquihv-x3ve-1lb9-qmix-dankod8dg86z Content-Type: application/json; charset=UTF-8 X-Sdk-Date: 20240527T021902Z Host: rgc.cn-north-4.myhuaweicloud.com Authorization: SDK-HMAC-SHA256 Access=xxxxxxxxxxxxxxxxxxx, SignedHeaders=content-type;host;x-sdk-date, Signature=xxxxxxxxxxxxxxxxxxxx