全部产品
Search

搜索本产品

    全球加速：DescribeIpSet - 查询加速地域

    文档中心

    全球加速：DescribeIpSet - 查询加速地域

    更新时间：Jul 31, 2024

    调用DescribeIpSet接口查询指定加速地域的信息。

    调试

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

    授权信息

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

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    ga:DescribeIpSetget
    • IpSet
      acs:ga:{#regionId}:{#accountId}:ipset/{#ipSetId}
      无
    		无

    请求参数

    名称类型必填描述示例值
    RegionIdstring是

    全球加速所在的地域 ID，仅取值cn-hangzhou。

    		cn-hangzhou
    IpSetIdstring是

    加速地域实例 ID。

    您可以通过调用 ListIpSets 查询指定全球加速实例下包含的加速地域实例 ID。

    		ips-bp11ilwqjdkjeg9r7****

    返回参数

    名称类型描述示例值
    object

    返回信息列表。

    IpSetIdstring

    加速地域实例 ID。

    		ips-bp11ilwqjdkjeg9r7****
    RequestIdstring

    请求 ID。

    		6D2BFF54-6AF2-4679-88C4-2F2E187F16CB
    IpVersionstring

    IP 地址协议版本。取值：

    • IPv4
    • IPv6
    • DUAL_STACK
    		IPv4
    Statestring

    加速地域状态。取值：

    • init：初始化。

    • active：运行中。

    • updating：配置中。

    • deleting：删除中。

    		active
    Bandwidthinteger

    加速地域分配的带宽。单位：Mbps。

    		3
    IspTypestring

    加速地域公网线路类型。

    • BGP（默认值）：BGP（多线）线路。
    • BGP_PRO：BGP（多线）_精品线路。
    		BGP
    IpAddressListarray

    加速 IP 列表。

    string

    加速 IP 列表。

    		121.43.XX.XX
    AccelerateRegionIdstring

    加速地域 ID。

    		cn-hangzhou
    AcceleratorIdstring

    全球加速实例 ID。

    		ga-bp1yeeq8yfoyszmqy****
    ServiceIdstring

    托管实例所属的服务方 ID。

    说明 仅当 ServiceManaged 参数为 True 时有效。
    		ALB
    ServiceManagedboolean

    是否为托管实例。取值：

    • true：是托管实例。

    • false：不是托管实例。

    		true
    ServiceManagedInfosarray<object>

    用户在此托管实例下可执行的动作策略列表。

    说明
  • 仅当 ServiceManaged 参数为 True 时有效。
  • 当实例处于托管状态时，用户对实例的操作会受到限制，某些操作行为会被禁止。
    •
    object

    用户在此托管实例下可执行的动作策略列表。

    Actionstring

    托管策略动作名称，取值：

    • Create：创建实例。
    • Update：更新当前实例。
    • Delete：删除当前实例。
    • Associate：引用/被引用当前实例。
    • UserUnmanaged：用户解托管实例。
    • CreateChild：在当前实例下创建子资源。
    		Update
    ChildTypestring

    子资源类型，取值：

    • Listener：监听资源。
    • IpSet：加速地域资源。
    • EndpointGroup：终端节点组资源。
    • ForwardingRule：转发策略资源。
    • Endpoint：终端节点资源。
    • EndpointGroupDestination：自定义路由监听下的终端节点组协议映射资源。
    • EndpointPolicy：自定义路由监听下的终端节点通行策略资源。
    说明 仅当 Action 参数为 CreateChild 时有效。
    		Listener
    IsManagedboolean

    托管策略动作是否被托管，取值：

    • true：托管策略动作被托管，用户无权在托管实例下执行 Action 指定的操作。
    • false：托管策略动作未被托管，用户可在托管实例下执行 Action 指定的操作。
    		false

    示例

    正常返回示例

    JSON格式

    {
  "IpSetId": "ips-bp11ilwqjdkjeg9r7****",
  "RequestId": "6D2BFF54-6AF2-4679-88C4-2F2E187F16CB",
  "IpVersion": "IPv4",
  "State": "active",
  "Bandwidth": 3,
  "IspType": "BGP",
  "IpAddressList": [
    "121.43.XX.XX"
  ],
  "AccelerateRegionId": "cn-hangzhou",
  "AcceleratorId": "ga-bp1yeeq8yfoyszmqy****",
  "ServiceId": "ALB",
  "ServiceManaged": true,
  "ServiceManagedInfos": [
    {
      "Action": "Update",
      "ChildType": "Listener",
      "IsManaged": false
    }
  ]
}

    错误码

    HTTP status code错误码错误信息描述
    500UnknownErrorAn error occurred while processing your request. Please try again. If the error persists, please submit a ticket.处理请求时出现错误，请稍后重试。

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

    变更历史

    变更时间变更内容概要操作
    2023-08-15OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情