All Products
Search
Document Center

Global Accelerator:GetBasicAccelerator

更新時間:Jul 31, 2024

Queries the information about a basic Global Accelerator (GA) instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ga:GetBasicAcceleratorget
  • BasicAccelerator
    acs:ga:{#regionId}:{#accountId}:ga/{#BasicAcceleratorId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region to which the basic GA instance belongs. Set the value to cn-hangzhou.

cn-hangzhou
AcceleratorIdstringYes

The ID of the basic GA instance that you want to query.

ga-bp17frjjh0udz4qz****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Descriptionstring

The description of the basic GA instance.

BasicAccelerator
RequestIdstring

The ID of the request.

F591955F-5CB5-4CCE-A75D-17CF2085CE22
InstanceChargeTypestring

The billing method of the basic GA instance. Only PREPAY is returned, which indicates the subscription billing method.

PREPAY
CreateTimelong

The timestamp that indicates when the basic GA instance is created.

1637734547
CrossDomainBandwidthPackageobject

The details about the cross-border acceleration bandwidth plan that is associated with the GA instance.

This array is returned only for GA instances that are created on the international site (alibabacloud.com).

Bandwidthinteger

The bandwidth value of the cross-border acceleration bandwidth plan. Unit: Mbit/s.

2
InstanceIdstring

The ID of the cross-border acceleration bandwidth plan.

gbwp-bp1d8xk8bg139j0fw****
Namestring

The name of the basic GA instance.

BasicAccelerator
BasicBandwidthPackageobject

The details about the basic bandwidth plan that is associated with the basic GA instance.

Bandwidthinteger

The bandwidth value of the basic bandwidth plan. Unit: Mbit/s.

2
BandwidthTypestring

The type of the bandwidth that is provided by the basic bandwidth plan.

  • Basic: basic
  • Enhanced: enhanced
  • Advanced: premium
Basic
InstanceIdstring

The ID of the basic bandwidth plan.

gbwp-bp1d8xk8bg139j0fw****
Statestring

The status of the basic GA instance.

  • init: The GA instance is being initialized.
  • active: The GA instance is available.
  • configuring: The GA instance is being configured.
  • binding: The GA instance is being associated.
  • unbinding: The GA instance is being disassociated.
  • deleting: The GA instance is being deleted.
  • finacialLocked: The GA instance is locked due to overdue payments.
active
ExpiredTimelong

The timestamp that indicates when the basic GA instance expires.

The time follows the UNIX time format. It is the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

1640326547
CenIdstring

The ID of the Cloud Enterprise Network (CEN) instance to which the basic GA instance is attached.

cen-hjkduu767hc****
RegionIdstring

The ID of the region where the basic GA instance is deployed.

cn-hangzhou
AcceleratorIdstring

The ID of the basic GA instance.

ga-bp17frjjh0udz4qz****
BasicEndpointGroupIdstring

The ID of the endpoint group.

epg-bp1dmlohjjz4kqaun****
BasicIpSetIdstring

The ID of the acceleration region.

ips-bp11ilwqjdkjeg9r7****
BandwidthBillingTypestring

The bandwidth metering method.

  • BandwidthPackage: billed based on bandwidth plans.
  • CDT: billed by Cloud Data Transfer (CDT) and based on data transfer.
  • CDT95: billed by CDT and based on the 95th percentile bandwidth. This bandwidth metering method is available only to users that are included in the whitelist.
CDT
CrossPrivateStatestring

Indicates whether cross-border acceleration is enabled.

  • true: yes
  • false: no
false
CrossBorderStatusboolean

Indicates whether cross-border acceleration is enabled for the basic GA instance. Valid values:

  • true
  • false
false
ResourceGroupIdstring

The ID of the resource group to which the basic GA instance belongs.

rg-aekzrnd67gq****
Tagsarray<object>

The tags of the basic GA instance.

object

The tags of the basic GA instance.

Keystring

The tag key.

tag-key
Valuestring

The tag value.

tag-value

Examples

Sample success responses

JSONformat

{
  "Description": "BasicAccelerator",
  "RequestId": "F591955F-5CB5-4CCE-A75D-17CF2085CE22",
  "InstanceChargeType": "PREPAY",
  "CreateTime": 1637734547,
  "CrossDomainBandwidthPackage": {
    "Bandwidth": 2,
    "InstanceId": "gbwp-bp1d8xk8bg139j0fw****"
  },
  "Name": "BasicAccelerator",
  "BasicBandwidthPackage": {
    "Bandwidth": 2,
    "BandwidthType": "Basic",
    "InstanceId": "gbwp-bp1d8xk8bg139j0fw****"
  },
  "State": "active",
  "ExpiredTime": 1640326547,
  "CenId": "cen-hjkduu767hc****",
  "RegionId": "cn-hangzhou",
  "AcceleratorId": "ga-bp17frjjh0udz4qz****",
  "BasicEndpointGroupId": "epg-bp1dmlohjjz4kqaun****",
  "BasicIpSetId": "ips-bp11ilwqjdkjeg9r7****",
  "BandwidthBillingType": "CDT",
  "CrossPrivateState": "false",
  "CrossBorderStatus": false,
  "ResourceGroupId": "rg-aekzrnd67gq****",
  "Tags": [
    {
      "Key": "tag-key",
      "Value": "tag-value"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-04-06The response structure of the API has changedView Change Details