ListRegions

更新时间:
复制 MD 格式

Lists the regions supported by Cloud Connector.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

iotcc:ListRegions

list

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

AcceptLanguage

string

No

Supported language. Valid values:

  • zh-CN: Chinese.

  • en-US: English.

  • ja: Japanese.

zh-CN

RegionId

string

Yes

The region ID of the Cloud Connector instance.

cn-hangzhou

Response elements

Element

Type

Description

Example

object

The response information.

RequestId

string

The request ID.

CEF72CEB-54B6-4AE8-B225-F876FF7BA984

Regions

array<object>

The list of regions.

object

The list of regions.

RegionId

string

The region ID.

cn-hangzhou

LocalName

string

The region name.

华东1(杭州)

RegionEndpoint

string

The endpoint address for the region service.

cciot.cn-hangzhou.aliyuncs.com

Examples

Success response

JSON format

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "Regions": [
    {
      "RegionId": "cn-hangzhou",
      "LocalName": "华东1(杭州)",
      "RegionEndpoint": "cciot.cn-hangzhou.aliyuncs.com"
    }
  ]
}

Error codes

HTTP status code

Error code

Error message

Description

400 Forbidden.RAM Ram user does not have permission to perform this operation. The error message returned because the RAM user does not have the permissions to perform the operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.