スキルのロールバック(SMAPI)
このAPIを使用すると、スキルの再認定を手動で再申請することなく、スキルを以前に公開したバージョンに戻すことができます。このプロセスは、開発サイクル間を移動する際に役立ちます。たとえば、新しいスキルバージョンでバグやその他の意図しない動作が発生した場合に、スキルのロールバックを選択できます。
スキルのロールバックの動作の詳細については、スキルのロールバックを参照してください。スキルをロールバックするには、 開発者コンソールまたはAlexa Skills Kit(ASK)のコマンドラインインターフェース(CLI)のいずれかを使用します。
ロールバックのためにターゲットスキルを申請する
ロールバック先となるターゲットスキルバージョンを申請します。特定のskillId
に対して、一度に1回だけロールバック操作または公開操作を実行できます。スキルはロールバックの資格要件を満たしている必要があります。
リクエスト
このAPIのエンドポイントは、https://api.amazonalexa.com
です。すべてのAPIリクエストにはAuthorizationヘッダーが必要であり、その値にはLogin with Amazonから取得したアクセストークンが入ります。
POST /v1/skills/{skillId}/rollbacks
リクエストのパラメーター
フィールド | 説明 | パラメーターの型 | 必須 |
---|---|---|---|
skillId |
一意のスキルIDです。 | パス | ◯ |
リクエスト本文の構造
以下の例では、応答本文の構造を示します。
{
targetVersion : ""
}
リクエストのパラメーター
フィールド | 説明 | パラメーターの型 | 必須 |
---|---|---|---|
targetVersion |
ロールバック先となるターゲットスキルのバージョンです。 | 文字列 | ◯ |
スキルのロールバックステータスを取得する
rollbackRequestId
が関連付けられているスキルのロールバックステータスを取得します。
リクエスト
このAPIのエンドポイントは、https://api.amazonalexa.com
です。すべてのAPIリクエストにはAuthorizationヘッダーが必要であり、その値にはLogin with Amazonから取得したアクセストークンが入ります。
GET /v1/skills/{skillId}/rollbacks/{rollbackRequestId}
リクエストのパラメーター
フィールド | 説明 | パラメーターの型 | 必須 |
---|---|---|---|
skillId |
一意のスキルIDです。 | オブジェクト | ◯ |
rollbackRequestId |
一意のロールバックワークフローIDです。 | 文字列 | ◯ |
応答
201 Created
{
"rollbackRequestId": "93990bd2-afc9-48a8-94d6-862ce5db5ca5"
}
応答本文の構造
以下の例では、応答本文の構造を示します。
{
"id": "727cb65c-ef40-4c02-873f-262f4b60a0bf",
"status": "IN_PROGRESS",
"submissionTime": "Sat Jun 27 01:24:01 UTC 2020",
"targetVersion": "1"
"errors" : [
{
"code": ""
"validationDetails" : {}
"message": ""
}
]
}
応答のフィールド
フィールド | 説明 | パラメーターの型 |
---|---|---|
targetVersion |
ロールバック先となるターゲットスキルのバージョンです。 | 文字列 |
submissionTime |
申請済みのバージョンの日付と時刻です。 | 文字列 |
id |
一意のロールバックリクエストIDです。 | 文字列 |
status |
ロールバックリクエストのステータスです。 | 文字列 |
errors |
ロールバックエラーに関する情報を含むオブジェクトです。 | リスト |
errors.code |
標準化されたエラーコードのリストです。 | リスト |
errors.validationDetails |
エラー検証の詳細です。 | リスト |
errors.message |
エラーの詳細です。 | 文字列 |
エラーコード
エラーコード | 説明 |
---|---|
2XX | 成功しました。スキルのロールバック操作が開始されました。 |
4XX | 検証エラーです。ロールバック操作が開始される前にエラーが発生しました。 |
5XX | システムエラーです。ロールバック操作が開始される前にエラーが発生しました。 |
HTTP/1.1 400 Bad Request
HTTP/1.1 401 Unauthorized
HTTP/1.1 403 Forbidden
HTTP/1.1 404 Not Found
HTTP/1.1 409 Conflict with the target resource
HTTP/1.1 429 Too Many Requests
HTTP/1.1 500 Internal Server Error
HTTP/1.1 503 Service Unavailable