@@ -3,7 +3,7 @@ title: URI Formats of External Storage Services
33summary : Amazon S3、GCS、Azure Blob Storage などの外部storageサービスのstorageURI 形式について説明します。
44---
55
6- ## 外部ストレージサービスの URI 形式 {#uri-formats-of-external-storage-services}
6+ ## 外部ストレージサービスのURI形式 {#uri-formats-of-external-storage-services}
77
88このドキュメントでは、Amazon S3、GCS、Azure Blob Storage などの外部storageサービスの URI 形式について説明します。
99
@@ -15,30 +15,32 @@ URI の基本的な形式は次のとおりです。
1515
1616## Amazon S3 URI 形式 {#amazon-s3-uri-format}
1717
18+ <CustomContent platform =" tidb " >
19+
1820- ` scheme ` : ` s3 `
1921- ` host ` : ` bucket name `
2022- ` parameters ` :
2123
22- - ` access-key ` : アクセスキーを指定します 。
24+ - ` access-key ` : アクセス キーを指定します 。
2325 - ` secret-access-key ` : 秘密アクセスキーを指定します。
24- - ` session-token ` : 一時セッション トークンを指定します 。BRはv7.6.0 以降でこのパラメータをサポートします 。
26+ - ` session-token ` : 一時セッショントークンを指定します 。BRはv7.6.0以降でこのパラメータをサポートしています 。
2527 - ` use-accelerate-endpoint ` : Amazon S3 の高速エンドポイントを使用するかどうかを指定します (デフォルトは` false ` )。
2628 - ` endpoint ` : S3 互換サービスのカスタムエンドポイントの URL を指定します (例: ` <https://s3.example.com/> ` )。
27- - ` force-path-style ` : 仮想ホスト形式のアクセスではなく、パス形式のアクセスを使用します (デフォルトは` true ` )。
29+ - ` force-path-style ` : 仮想ホスト スタイルのアクセスではなく、パス スタイルのアクセスを使用します (デフォルトは` true ` )。
2830 - ` storage-class ` : アップロードされたオブジェクトのstorageクラスを指定します (たとえば、 ` STANDARD ` または` STANDARD_IA ` )。
2931 - ` sse ` : アップロードされたオブジェクトの暗号化に使用されるサーバー側暗号化アルゴリズムを指定します (値のオプション: 空、 ` AES256 ` 、または` aws:kms ` )。
3032 - ` sse-kms-key-id ` : ` sse ` ` aws:kms ` に設定されている場合は KMS ID を指定します。
3133 - ` acl ` : アップロードされたオブジェクトの既定 ACL を指定します (たとえば、 ` private ` または` authenticated-read ` )。
32- - ` role-arn ` : 指定された[ IAMロール] ( https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html ) 使用してサードパーティの Amazon S3 データにアクセスする必要がある場合は 、 ` arn:aws:iam::888888888888:role/my-role ` などの` role-arn ` URL クエリパラメータを使用して、 IAMロールの対応する [ Amazon リソース名 (ARN)] ( https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ) 指定できます。IAM ロールを使用してサードパーティの Amazon S3 データにアクセスする方法の詳細については、 [ AWS ドキュメント ] ( https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_common-scenarios_third-party.html ) 参照してください。BRは、v7 .6.0 以降でこのパラメータをサポートしています。
33- - ` external-id ` : サードパーティから Amazon S3 データにアクセスする場合、正しい[ 外部ID] ( https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html ) 指定して[ IAMロール] ( https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html ) 引き受ける必要がある場合があります 。この場合、この` external-id ` URL クエリパラメータを使用して外部 ID を指定し、 IAMロールを引き受けることができることを確認できます。外部 ID は、Amazon S3 データにアクセスするためにIAMロール ARN とともにサードパーティによって提供される任意の文字列ですIAMIAMに外部 ID を必要としない場合は、このパラメータを指定せずにIAMロールを引き受け、対応する Amazon S3 データにアクセスできます。
34+ - ` role-arn ` : 指定された[ IAMロール] ( https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html ) 使用してサードパーティの Amazon S3 データにアクセスする必要がある場合 、 ` arn:aws:iam::888888888888:role/my-role ` などの` role-arn ` URL クエリパラメータで、対応する [ Amazon リソースネーム (ARN)] ( https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ) IAMロールを指定できます。IAMIAMを使用してサードパーティの Amazon S3 データにアクセスする方法の詳細については、 [ AWSドキュメント ] ( https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_common-scenarios_third-party.html ) 参照してください。BRはv7 .6.0 以降でこのパラメータをサポートしています。
35+ - ` external-id ` : サードパーティから Amazon S3 データにアクセスする場合、正しい[ 外部ID] ( https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html ) 指定して[ IAMロール] ( https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html ) 引き受けることが必要になる場合があります 。この場合、この` external-id ` URL クエリパラメータを使用して外部 ID を指定し、 IAMロールを引き受けることができることを確認できます。外部 ID は、Amazon S3 データにアクセスするためにIAMロール ARN と一緒にサードパーティによって提供される任意の文字列です。IAM ロールを引き受ける場合の外部 IDのIAMIAMに外部 ID を必要としない場合は、このパラメータを指定せずにIAMロールを引き受け、対応する Amazon S3 データにアクセスできます。
3436
35- 以下は、 TiDB LightningおよびBRの Amazon S3 URI の例です。この例では、特定のファイルパス` testfolder ` を指定する必要があります 。
37+ 以下は、 TiDB LightningおよびBRの Amazon S3 URI の例です。この例では、特定のファイルパス` testfolder ` 指定する必要があります 。
3638
3739``` shell
3840s3://external/testfolder? access-key=${access-key} & secret-access-key=${secret-access-key}
3941```
4042
41- 以下は、TiCDC ` sink-uri ` の Amazon S3 URI の例です。
43+ 以下は、 TiCDC ` sink-uri ` の Amazon S3 URI の例です。
4244
4345``` shell
4446tiup cdc:v7.5.0 cli changefeed create \
@@ -48,48 +50,92 @@ tiup cdc:v7.5.0 cli changefeed create \
4850 --config=cdc_csv.toml
4951```
5052
51- 以下は、 [ ` IMPORT INTO ` ] ( /sql-statements/sql-statement-import-into.md ) の Amazon S3 URI の例です。この例では、特定のファイル名` test.csv ` を指定する必要があります。
53+ </CustomContent >
54+
55+ <CustomContent platform =" tidb-cloud " >
56+
57+ - ` scheme ` : ` s3 `
58+ - ` host ` : ` bucket name `
59+ - ` parameters ` :
60+
61+ - ` access-key ` : アクセス キーを指定します。
62+
63+ - ` secret-access-key ` : 秘密アクセスキーを指定します。
64+
65+ - ` session-token ` : 一時セッション トークンを指定します。
66+
67+ - ` use-accelerate-endpoint ` : Amazon S3 の高速エンドポイントを使用するかどうかを指定します (デフォルトは` false ` )。
68+
69+ - ` endpoint ` : S3 互換サービスのカスタムエンドポイントの URL を指定します (例: ` <https://s3.example.com/> ` )。
70+
71+ - ` force-path-style ` : 仮想ホスト スタイルのアクセスではなく、パス スタイルのアクセスを使用します (デフォルトは` true ` )。
72+
73+ - ` storage-class ` : アップロードされたオブジェクトのstorageクラスを指定します (たとえば、 ` STANDARD ` または` STANDARD_IA ` )。
74+
75+ - ` sse ` : アップロードされたオブジェクトの暗号化に使用されるサーバー側暗号化アルゴリズムを指定します (値のオプション: 空、 ` AES256 ` 、または` aws:kms ` )。
76+
77+ - ` sse-kms-key-id ` : ` sse ` ` aws:kms ` に設定されている場合は KMS ID を指定します。
78+
79+ - ` acl ` : アップロードされたオブジェクトの既定 ACL を指定します (たとえば、 ` private ` または` authenticated-read ` )。
80+
81+ - ` role-arn ` : TiDB Cloud が特定の[ IAMロール] ( https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html ) 使用して Amazon S3 データにアクセスできるようにするには、 ` role-arn ` URL クエリパラメータにロールの[ Amazon リソースネーム (ARN)] ( https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ) 指定します。例: ` arn:aws:iam::888888888888:role/my-role ` 。
82+
83+ > ** 注記:**
84+ >
85+ > - IAMロールを自動的に作成するには、 [ TiDB Cloudコンソール] ( https://tidbcloud.com/ ) でクラスターの** [ Amazon S3 からのデータのインポート] ** ページに移動し、 ** [ フォルダー URI] ** フィールドに入力し、 ** [ ロール ARN] ** フィールドの [ ** ここをクリックして AWS CloudFormation で新しく作成] を** クリックして、 ** [ 新しいロール ARN の追加] ** ダイアログの画面上の指示に従います。
86+ > - AWS CloudFormation を使用してIAMロールを作成する際に問題が発生した場合は、 ** 「新しいロール ARN を追加」** ダイアログで** 「問題が発生した場合は、ロール ARN を手動で作成する」をクリックし** てTiDB Cloudアカウント ID とTiDB Cloud外部 ID を取得し、 [ ロール ARN を使用して Amazon S3 アクセスを構成する] ( https://docs.pingcap.com/tidbcloud/dedicated-external-storage#configure-amazon-s3-access-using-a-role-arn ) の手順に従って手動でロールを作成してください。IAMIAMを設定する際は、 ** 「アカウント ID」** フィールドにTiDB Cloudアカウント ID を入力し、 [ 混乱した副官の攻撃] ( https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html ) から保護するために** 外部 ID を要求する」** を選択してください。
87+ > - セキュリティを強化するために、** 最大セッション継続時間を** 短く設定することで、 IAMロールの有効期間を短縮できます。詳細については、AWSドキュメントの[ ロールの最大セッション期間を更新する] ( https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_update-role-settings.html#id_roles_update-session-duration ) 参照してください。
88+
89+ - ` external-id ` : TiDB Cloud がAmazon S3 データにアクセスするために必要なTiDB Cloud外部 ID を指定します。この ID は、 [ TiDB Cloudコンソール] ( https://tidbcloud.com/ ) の** 「新しいロール ARN を追加」** ダイアログから取得できます。詳細については、 [ ロール ARN を使用して Amazon S3 アクセスを構成する] ( https://docs.pingcap.com/tidbcloud/dedicated-external-storage#configure-amazon-s3-access-using-a-role-arn ) 参照してください。
90+
91+ 以下は、 [ ` BACKUP ` ] ( /sql-statements/sql-statement-backup.md ) と[ ` RESTORE ` ] ( /sql-statements/sql-statement-restore.md ) のAmazon S3 URIの例です。この例では、ファイルパス` testfolder ` を使用しています。
5292
5393``` shell
54- s3://external/test.csv ? access-key=${access-key} & secret-access-key=${secret-access-key}
94+ s3://external/testfolder ? access-key=${access-key} & secret-access-key=${secret-access-key}
5595```
5696
57- ## GCS URI 形式 {#gcs-uri-format}
97+ </ CustomContent >
5898
59- - ` scheme ` : ` gcs ` または` gs `
99+ ## GCS URI形式 {#gcs-uri-format}
100+
101+ - ` scheme ` : ` gcs ` または` gs `
60102- ` host ` : ` bucket name `
61103- ` parameters ` :
62104
63105 - ` credentials-file ` : 移行ツール ノード上の資格情報 JSON ファイルへのパスを指定します。
64- - ` storage-class ` : アップロードされたオブジェクトのstorageクラスを指定します(たとえば、 ` STANDARD ` または` COLDLINE ` )
106+ - ` storage-class ` : アップロードされたオブジェクトのstorageクラスを指定します(例: ` STANDARD ` または` COLDLINE ` )
65107 - ` predefined-acl ` : アップロードされたオブジェクトの定義済みACLを指定します(たとえば、 ` private ` または` project-private ` )
66108
67- 以下は、 TiDB LightningおよびBRの GCS URI の例です。この例では、特定のファイル パス` testfolder ` を指定する必要があります。
109+ <CustomContent platform =" tidb " >
110+
111+ 以下は、 TiDB LightningとBRのGCS URIの例です。この例では、特定のファイルパス` testfolder ` 指定する必要があります。
68112
69113``` shell
70114gcs://external/testfolder? credentials-file=${credentials-file-path}
71115```
72116
73- 以下は[ ` IMPORT INTO ` ] ( /sql-statements/sql-statement-import-into.md ) の GCS URI の例です。この例では、特定のファイル名` test.csv ` を指定する必要があります。
117+ </CustomContent >
118+
119+ 以下は[ ` IMPORT INTO ` ] ( /sql-statements/sql-statement-import-into.md ) の GCS URI の例です。この例では、特定のファイル名` test.csv ` 指定する必要があります。
74120
75121``` shell
76122gcs://external/test.csv? credentials-file=${credentials-file-path}
77123```
78124
79125## Azure Blob Storage URI 形式 {#azure-blob-storage-uri-format}
80126
81- - ` scheme ` : ` azure ` または` azblob `
127+ - ` scheme ` : ` azure ` または` azblob `
82128- ` host ` : ` container name `
83129- ` parameters ` :
84130
85131 - ` account-name ` : storage のアカウント名を指定します。
86- - ` account-key ` : アクセスキーを指定します 。
132+ - ` account-key ` : アクセス キーを指定します 。
87133 - ` sas-token ` : 共有アクセス署名 (SAS) トークンを指定します。
88- - ` access-tier ` : アップロードされたオブジェクトのアクセス層を指定します (例: ` Hot ` 、 ` Cool ` 、 ` Archive ` 。既定値は、storageアカウントの既定のアクセス層です 。
134+ - ` access-tier ` : アップロードされたオブジェクトのアクセス層を指定します(例: ` Hot ` 、 ` Cool ` 、 ` Archive ` ) 。既定値は、storageアカウントのデフォルトのアクセス層です 。
89135 - ` encryption-scope ` : サーバー側の暗号化に[ 暗号化範囲] ( https://learn.microsoft.com/en-us/azure/storage/blobs/encryption-scope-manage?tabs=powershell#upload-a-blob-with-an-encryption-scope ) 指定します。
90136 - ` encryption-key ` : AES256 暗号化アルゴリズムを使用するサーバー側暗号化の場合は[ 暗号化キー] ( https://learn.microsoft.com/en-us/azure/storage/blobs/encryption-customer-provided-keys ) 指定します。
91137
92- 以下は、 BRの Azure Blob Storage URI の例です 。この例では、特定のファイル パス ` testfolder ` を指定する必要があります 。
138+ 以下は、 BRのAzure Blob Storage URIの例です 。この例では、特定のファイルパス ` testfolder ` 指定する必要があります 。
93139
94140``` shell
95141azure://external/testfolder? account-name=${account-name} & account-key=${account-key}
0 commit comments