Object Storage Service (OSS) がサポートするすべてのリージョンまたは特定のリージョンのエンドポイント (パブリックエンドポイント、内部エンドポイント、アクセラレーションエンドポイントなど) を照会します。
使用方法
リージョンのエンドポイントを照会するには、
oss:DescribeRegions権限が必要です。詳細については、「RAM ユーザーにカスタムポリシーをアタッチする」をご参照ください。DescribeRegions オペレーションの呼び出しによって開始されたリクエストには、oss-cn-hangzhou.aliyuncs.com などの第 2 レベルドメインのみを含めることができます。
リクエスト構文
サポートされているすべてのリージョンのエンドポイントを照会する
GET /?regions HTTP/1.1 Host: oss.example.com Date: GMT Date Authorization: SignatureValue特定のリージョンのエンドポイントを照会する
説明特定のリージョンのエンドポイントは、OSS リージョン ID を使用してのみ照会できます。詳細については、「パブリッククラウドのリージョンと OSS エンドポイント」をご参照ください。
GET /?regions=oss-cn-hangzhou HTTP/1.1 Host: oss.example.com Date: GMT Date Authorization: SignatureValue
リクエストヘッダー
DescribeRegions リクエストのすべてのヘッダーは、共通のリクエストヘッダーです。詳細については、「共通のリクエストヘッダー」をご参照ください。
レスポンスヘッダー
DescribeRegions リクエストへのレスポンスのすべてのヘッダーは、共通のレスポンスヘッダーです。詳細については、「共通のレスポンスヘッダー」をご参照ください。
レスポンス要素
要素 | タイプ | 例 | 説明 |
RegionInfoList | コンテナ | 該当なし | リージョンのリスト。 子ノード: RegionInfo 親ノード: なし |
RegionInfo | コンテナ | 該当なし | リージョン情報。 子ノード: Region、InternetEndpoint、InternalEndpoint、AccelerateEndpoint 親ノード: RegionInfoList |
Region | 文字列 | oss-cn-hangzhou | OSS リージョン ID。 親ノード: RegionInfo |
InternetEndpoint | 文字列 | oss-cn-hangzhou.aliyuncs.com | リージョンのパブリックエンドポイント。 親ノード: RegionInfo |
InternalEndpoint | 文字列 | oss-cn-hangzhou-internal.aliyuncs.com | リージョンの内部エンドポイント。 親ノード: RegionInfo |
AccelerateEndpoint | 文字列 | oss-accelerate.aliyuncs.com | リージョンのアクセラレーションエンドポイント。値は oss-accelerate.aliyuncs.com に固定されています。 親ノード: RegionInfo |
例
サポートされているすべてのリージョンのエンドポイントを照会する
リクエストの例
GET /?regions HTTP/1.1 Host: oss-cn-hangzhou.aliyuncs.com Date: Fri, 20 Aug 2021 06:38:30 GMT Authorization: SignatureValue成功レスポンスの例
HTTP/1.1 200 OK x-oss-request-id: 3a8f-2e2d-7965-3ff9-51c875b***** Date: Fri, 20 Aug 2021 06:38:30 GMT Content-Type: application/xml Content-Length: 344606 Server: AliyunOSS <?xml version="1.0" encoding="UTF-8"?> <RegionInfoList> <RegionInfo> <Region>oss-cn-hangzhou</Region> <InternetEndpoint>oss-cn-hangzhou.aliyuncs.com</InternetEndpoint> <InternalEndpoint>oss-cn-hangzhou-internal.aliyuncs.com</InternalEndpoint> <AccelerateEndpoint>oss-accelerate.aliyuncs.com</AccelerateEndpoint> </RegionInfo> <RegionInfo> <Region>oss-cn-shanghai</Region> <InternetEndpoint>oss-cn-shanghai.aliyuncs.com</InternetEndpoint> <InternalEndpoint>oss-cn-shanghai-internal.aliyuncs.com</InternalEndpoint> <AccelerateEndpoint>oss-accelerate.aliyuncs.com</AccelerateEndpoint> </RegionInfo> </RegionInfoList>
特定のリージョンのエンドポイントを照会する
リクエストの例
GET /?regions=oss-cn-hangzhou HTTP/1.1 Host: oss-cn-hangzhou.aliyuncs.com Date: Fri, 20 Aug 2021 06:40:30 GMT Authorization: SignatureValue成功レスポンスの例
HTTP/1.1 200 OK x-oss-request-id: 3a8f-2e2d-7965-3ff9-51c875b***** Date: Fri, 20 Aug 2021 06:40:30 GMT Content-Type: application/xml Content-Length: 3446 Server: AliyunOSS <?xml version="1.0" encoding="UTF-8"?> <RegionInfoList> <RegionInfo> <Region>oss-cn-hangzhou</Region> <InternetEndpoint>oss-cn-hangzhou.aliyuncs.com</InternetEndpoint> <InternalEndpoint>oss-cn-hangzhou-internal.aliyuncs.com</InternalEndpoint> <AccelerateEndpoint>oss-accelerate.aliyuncs.com</AccelerateEndpoint> </RegionInfo> </RegionInfoList>
ossutil
DescribeRegions オペレーションに対応する ossutil コマンドについては、「describe-regions」をご参照ください。
OSS SDK
次のプログラミング言語の OSS SDK を使用して、DescribeRegions を呼び出すことができます。
エラーコード
エラーコード | HTTP ステータスコード | 説明 |
AccessDenied | 403 | 考えられる原因:
|
InvalidArgument | 400 | 1 つ以上のパラメーターが無効です。 |
NoSuchRegion | 404 | リージョンが存在しません。 |