文档

ModifyVpcAccessAndUpdateApis - 修改VPC授权信息,并且更新关联的API的元信息

更新时间:
重要

本文中含有需要您注意的重要提示信息,忽略该信息可能对您的业务造成影响,请务必仔细阅读。

修改VPC授权信息并更新关联的API元信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apigateway:ModifyVpcAccessAndUpdateApisupdate
  • 全部资源
    *

请求参数

名称类型必填描述示例值
VpcIdstring

需要修改的新 vpcId

vpc-m5e7jqfppv5wbvmdw5pg2
InstanceIdstring

需要修改的新的实例 id

i-uf6bzcg1pr4oh5jjmxxx
Portinteger

需要修改的端口号

80
Namestring

VPC 授权的名称。

说明
  • VPC 授权名称不可修改,该参数不可用于修改;
  • 需要填写您当前 VPC 授权的名称。
  • VpcName
    Tokenstring

    口令

    c20d86c4-1eb3-4d0b-afe9-c586df1e2136
    NeedBatchWorkboolean

    ~~是否需要刷新关联的 API,

    警告 如果您的 VPC 授权需要更新,并且该授权被 API 关联并已经发布上线,需要配置为 true,否则您的 API 的后端服务不会刷新
    ~~ 该参数作废,更新 VPC 授权信息后如果有关联 API 存在,会自动更新 API 的元定义

    true
    Refreshboolean

    刷新 VPC 授权

    说明
  • 若您的 VPC 资源实例 ID 发生变化,但 IP 地址未变,勾选后可进行刷新授权
  • false
    VpcTargetHostNamestring

    后端授权的 host

    iot.hu***ng.com

    返回参数

    名称类型描述示例值
    object
    OperationIdstring

    异步任务 ID

    说明
  • 如果关联 API 被刷新,可使用任务 ID,调用 DescribeUpdateVpcInfoTask 接口,查询更新结果。
  • 7b6d0cb72b2e4215b0129f675c889746
    RequestIdstring

    请求 id

    C2CEC6EA-EEBA-5FD6-8BD9-2CF01980FE39

    示例

    正常返回示例

    JSON格式

    {
      "OperationId": "7b6d0cb72b2e4215b0129f675c889746",
      "RequestId": "C2CEC6EA-EEBA-5FD6-8BD9-2CF01980FE39"
    }

    错误码

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    暂无变更历史