イメージ更新の作成 URL のパラメーター
AWS S3
s3://<username>:<password>@<bucket>/<folder>/?<parameters>認証
ユーザー名 = AWS アクセスキー
パスワード = AWS シークレットアクセスキー
https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html
オプションクエリパラメーター
| 名前 | 説明 | デフォルト |
| handlers | バケットの同期に使用されるハンドラーの数を指定します | 10 |
| 地域 /region | バケットがある AWS 地域を指定します。 | eu-west-1 |
| requesttimeout | イメージをフェッチするリクエストが待機する時間を指定します (その後タイムアウトします)。 | 2m (2 分) |
Steamcmd
steam://<username>:<password>@install/<appid>/認証
ユーザー名 = Steam ユーザー名 ('anonymous' を使用できます)
パスワード = Steam パスワード (ユーザーが 'anonymous' の場合は空にすることができます)
Steam ガードコード = オプションクエリパラメーター の guardcode の使用方法に関する説明を参照してください
https://help.steampowered.com/en/faqs/view/06B0-26E6-2CF8-254C
オプションクエリパラメーター
| 名前 | 説明 | デフォルト |
| platformtype | convar @sSteamCmdForcePlatformType - 有効なオプションは windows、linux、macos です。 | ビルドボックスのプラットフォームタイプ。 以下の場合に、steam リポジトリの設定エラーがよく発生します。
|
| platformbitness | convar @sSteamCmdForcePlatformBitness - 有効なオプションは 32 と 64 です。 | ビルドボックスのプラットフォームのビット設定 (現在は一般的に 64 ビット)。 |
| guardcode | サインインコマンドに渡される Steam ガードコード | N/a |
| beta | app_update コマンドの -beta パラメーターに渡される beta | N/a |
| betapassword | app_update コマンドの -betapassword パラメーターに渡される password | N/a |
| appmod | app_set_config コマンドの mod パラメーターに渡される mod | N/a |
Google Cloud Storage
gs://<bucket>/<folder>?credentials=<creds>認証
バケットへのアクセス許可を付与する認証情報。URL エンコードされた Google Service Account JSON 認証情報であることが必要です。
https://cloud.google.com/iam/docs/keys-create-delete
オプションクエリパラメーター
| 名前 | 説明 | デフォルト |
| handlers | バケットの同期に使用されるハンドラーの数を指定します。 | 10 |
| requesttimeout | リクエストで使用されるタイムアウト値。 | 2 分 |
Tencent Cloud Object Storage
cos://<username>:<password>@<bucket>/<folder>認証
ユーザー名 = COS SecretId
パスワード = COS SecretKey
https://www.tencentcloud.com/document/product/436/45241?lang=en
オプションクエリパラメーター
| 名前 | 説明 | デフォルト |
| handlers | バケットの同期に使用されるハンドラーの数を指定します。 | 10 |
| 地域 /region | バケットがある Tencent Cloud 地域を指定します。 | ap-shanghai |
| requesttimeout | リクエストが使用するタイムアウト。 | 2m (2 分) |
URL エンコードの注意事項
ユーザー名およびパスワードの認証情報に特殊文字が含まれる場合は、それらを URL エンコードしてから、URL 全体 (エンコードされた認証情報を含む) を別にエンコードする必要があります。これは、使用可能なすべての URL タイプで同じです。URL パラメーターを使用して API を呼び出すときに行う必要があります。Clanforge WebPanel を使用する場合、エンコードを行う必要はありません。
AWS S3 の URL エンコードの例
以下の例は、Image Create Update API 呼び出しで AWS S3 URL パラメーターを使用し、エンコードを実行する方法を説明します。
例えば、s3://my%user:my%password\@bucket/key という S3 URL があるとします。ここで、ユーザー名は my%user、パスワードは my%password です。
URL エンコードの後で、認証情報のユーザーは my%25user、パスワードは my%25password になります。
- エンコードされた認証情報を含む S3 URL は
s3://my%25user:my%25password@bucket/keyのようになります。 - 事前にエンコードした認証情報を含む URL 全体をエンコードしてから、API リクエストでバケット URL を使用します。エンコード後、バケット URL 全体は
s3%3A%2F%2Fmy%25user%3Amy%25password%40bucket%2Fkeyとなります。 - 最終的に、2 ステップのエンコードプロセスを実行した後で、S3 バケット URL を API リクエストで使用できます。
https://api.multiplay.co.uk/cfp/v1/imageupdate/create?imageid=1249&machineid=95394&accountserviceid=1337&desc=alpha-build&url=s3%3A%2F%2Fmy%25user%3Amy%25password%40bucket%2Fkey.`