文档

DescribeAccelerator - 查询指定的全球加速实例信息

更新时间:

调用DescribeAccelerator接口查询指定的全球加速实例信息。

调试

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

授权信息

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

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

请求参数

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

全球加速实例所属的地域,仅取值:cn-hangzhou

cn-hangzhou
AcceleratorIdstring

要查询的全球加速实例 ID。

ga-bp1odcab8tmno0hdq****

返回参数

名称类型描述示例值
object

返回信息列表。

DdosIdstring

与全球加速实例绑定的 DDoS 高防实例 ID。

ddoscoo-cn-zz11vq7j****
DnsNamestring

全球加速实例分配的 CNAME 地址。

ga-bp15u1i2hmtbk8c3i****.aliyunga0019.com
Descriptionstring

全球加速实例的描述信息。

Accelerator
RequestIdstring

请求 ID。

6FEA0CF3-D3B9-43E5-A304-D217037876A8
InstanceChargeTypestring

全球加速实例的计费方式。

PREPAY
CreateTimelong

全球加速实例创建时间的时间戳。

1650643200
CrossDomainBandwidthPackageobject

全球加速实例绑定的跨地域加速包的详情。

仅国际站支持返回该数组。

Bandwidthinteger

跨地域加速包的带宽值,单位:Mbps。

2
InstanceIdstring

跨地域加速包的实例 ID。

gbwp-bp1d8xk8bg139j0fw****
SecondDnsNamestring

全球加速联动 DDoS 高防实例的 CNAME。

ga-bp1f609c76zg6zuna****-1.aliyunga0047.com
Namestring

全球加速实例的名称。

Accelerator
BasicBandwidthPackageobject

全球加速实例绑定的基础带宽包的详情。

Bandwidthinteger

基础带宽包的带宽值。单位:Mbps。

2
BandwidthTypestring

基础带宽包的带宽类型。取值:

  • Basic:标准加速带宽。

  • Enhanced:增强加速带宽。

  • Advanced:精品加速带宽。

Basic
InstanceIdstring

基础带宽包的实例 ID。

gbwp-bp1d8xk8bg139j0fw****
Statestring

全球加速实例的状态。取值:

  • init:初始化。

  • active:可用。

  • configuring:配置中。

  • binding:绑定中。

  • unbinding:解绑中。

  • deleting:删除中。

  • finacialLocked:欠费锁定。

active
ExpiredTimelong

全球加速实例到期时间的时间戳。

1653235200
CenIdstring

全球加速实例绑定的云企业网实例 ID。

cen-hjkduu767hc****
RegionIdstring

全球加速实例所在的地域。

cn-hangzhou
Specstring

全球加速实例的规格,取值:

  • 1:小型Ⅰ。
  • 2:小型Ⅱ。
  • 3:小型Ⅲ。
  • 5:中型Ⅰ。
  • 8:中型Ⅱ。
  • 10:中型Ⅲ。
  • 20:大型Ⅰ。
  • 30:大型Ⅱ。
  • 40:大型Ⅲ。
  • 50:大型 IV。
  • 60:大型 V。
  • 70:大型 VI。
  • 80:大型 VII。
  • 90:大型 VIII。
  • 100:超大型Ⅰ。
  • 200:超大型Ⅱ。
说明 目前,大型Ⅲ及以上规格仅白名单开放。如需使用,请联系阿里云客户经理。

实例规格不同,定义也不同。更多信息,请参见实例规格

1
AcceleratorIdstring

全球加速实例 ID。

ga-bp1odcab8tmno0hdq****
BandwidthBillingTypestring

带宽计费方式。取值:

  • BandwidthPackage:按带宽包计费。

  • CDT:按流量计费。

CDT
IpSetConfigobject

加速区域配置。

AccessModestring

加速区域接入模式。取值:

  • UserDefine:自定义就近接入模式。您可以根据业务需要,定向选择加速区域和地域,全球加速为每个加速地域提供独立的 EIP。
  • Anycast:采用自动就近接入模式。您无需配置加速区域。全球加速在全球多地域提供一个 Anycast EIP,用户可通过 Anycast EIP 从就近接入点进入阿里云加速网络。
UserDefine
CrossPrivateStatestring

是否开启了跨地域带宽跨境。

  • true:是。

  • false:否。

false
ResourceGroupIdstring

资源组 ID。

rg-acfmw2vwdbujqbq
Tagsobject []

资源标签。

Keystring

标签键。

tag-key
Valuestring

标签值。

tag-value
CrossBorderModestring

用于带宽计费方式为按流量计费(CDT)的实例,显示其跨境加速类型,取值:

bpgPro:精品带宽跨境加速。

bpgPro
CrossBorderStatusboolean

全球加速实例是否开启跨境线路功能。取值:

  • true:开启跨境线路功能,可以加速跨境线路。

  • false:关闭跨境线路功能,不可以加速跨境线路。

false
UpgradableStatusstring

全球加速实例的可升级状态。取值:

  • notUpgradable:当前实例不需要升级。
  • upgradable:当前实例可升级至最新版本。
  • upgradeFailed:当前实例执行过升级操作且升级失败。
notUpgradable
ServiceIdstring

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

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

是否为托管实例。取值:

  • true:是托管实例。

  • false:不是托管实例。

true
ServiceManagedInfosobject []

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

说明 仅在 ServiceManaged 参数为 True 时有效。
  • 当实例处于托管状态时,用户对实例的操作会受到限制,某些操作行为会被禁止。
  • 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格式

    {
      "DdosId": "ddoscoo-cn-zz11vq7j****",
      "DnsName": "ga-bp15u1i2hmtbk8c3i****.aliyunga0019.com",
      "Description": "Accelerator",
      "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8\t",
      "InstanceChargeType": "PREPAY",
      "CreateTime": 1650643200,
      "CrossDomainBandwidthPackage": {
        "Bandwidth": 2,
        "InstanceId": "gbwp-bp1d8xk8bg139j0fw****"
      },
      "SecondDnsName": "ga-bp1f609c76zg6zuna****-1.aliyunga0047.com",
      "Name": "Accelerator",
      "BasicBandwidthPackage": {
        "Bandwidth": 2,
        "BandwidthType": "Basic",
        "InstanceId": "gbwp-bp1d8xk8bg139j0fw****"
      },
      "State": "active",
      "ExpiredTime": 1653235200,
      "CenId": "cen-hjkduu767hc****",
      "RegionId": "cn-hangzhou",
      "Spec": "1",
      "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
      "BandwidthBillingType": "CDT",
      "IpSetConfig": {
        "AccessMode": "UserDefine"
      },
      "CrossPrivateState": "false",
      "ResourceGroupId": "rg-acfmw2vwdbujqbq",
      "Tags": [
        {
          "Key": "tag-key",
          "Value": "tag-value"
        }
      ],
      "CrossBorderMode": "bpgPro",
      "CrossBorderStatus": false,
      "UpgradableStatus": "notUpgradable",
      "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 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:500
    出参OpenAPI 返回结构发生变更
    2023-06-14OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:500
    出参OpenAPI 返回结构发生变更
    2023-04-06OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    API 描述OpenAPI 描述信息更新
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:500
    出参OpenAPI 返回结构发生变更
    2023-04-06OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
    变更项变更内容
    API 描述OpenAPI 描述信息更新
    错误码OpenAPI 错误码发生变更
      删除错误码:500
      新增错误码:400
    • 本页导读 (1)
    文档反馈