すべてのプロダクト
Search
ドキュメントセンター

Microservices Engine:DeleteGatewayAuth

最終更新日:Jul 28, 2026

ゲートウェイ認証を削除します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

mse:DeleteGatewayAuth

delete

*Gateway。

acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

なし なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

Id

integer

任意

認証 ID。

120

GatewayUniqueId

string

任意

ゲートウェイの一意な ID。

gw-e2d226bba4b2445c9e29fa7f8216****

任意

返される結果の言語。有効な値: zh (デフォルト): 中国語、en: 英語。

zh

レスポンスフィールド

フィールド

型

説明

例

object

レスポンススキーマ。

RequestId

string

リクエスト ID。

316F5F64-F73D-42DC-8632-01E308B6****

HttpStatusCode

integer

HTTP 状態コード。

200

Message

string

返されたメッセージ。

OK

Code

integer

応答コード。Success が true の場合、値は 200 に固定されます。

200

Success

boolean

リクエストが成功したかどうかを示します。有効な値:

  • true: リクエストが成功しました。

  • false: リクエストが失敗しました。

true。

Data

object

返されたデータ。

Id

integer

認証 ID。

120

Name

string

認証名。

test。

GatewayUniqueId

string

ゲートウェイの一意な ID。

gw-e2d226bba4b2445c9e29fa7f8216****

GatewayId

integer

ゲートウェイ ID。

399

Type

string

認証タイプ。有効な値:

  • JWT

  • OIDC

  • IDaaS

  • ExternalAuthZ (自己管理型認証サービス)

JWT。

Issuer

string

認証タイプが JWT または OIDC の場合に使用されます。

  • JWT: JWT クレーム内の iss (issuer) で、トークンの発行者を指定します。

  • OIDC: OIDC クレーム内の iss (issuer) で、トークンの発行者を指定します。

https://example.com/auth。

Jwks

string

JSON フォーマットの JWT 公開鍵。

{ "keys": [ { "e": "AQAB", "kid": "DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ", "kty": "RSA", "n": "xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ" } ] }

IsWhite

boolean

権限付与のブラックリストおよびホワイトリストモード。有効な値:

  • true: ホワイトリストモード。リスト内のホストとパスは検証なしでアクセスできます。その他のすべてのリクエストには検証が必要です。

  • false: ブラックリストモード。リスト内のホストとパスには検証が必要です。その他のすべてのリクエストは直接アクセスできます。

true。

GmtCreate

string

作成時間。

2022-01-07 18:07:57

GmtModified

string

更新時間。

2022-01-07 18:07:57

TokenPosition

string

JWT トークンの位置。有効な値:

  • HEADER: ヘッダーを通じて送信されます。

検証対象のトークンパラメーター。デフォルトでは、トークンは Bearer プレフィックス付きで Authorization ヘッダーに配置されます。例: Authorization: Bearer token。

HEADER。

TokenName

string

検証対象のトークンパラメーターの名前。デフォルトでは、トークンは Bearer プレフィックス付きで Authorization ヘッダーに配置されます。例: Authorization: Bearer token。

Authorization。

TokenNamePrefix

string

JWT トークンのプレフィックス。

Bearer。

TokenPass

boolean

トークンがパススルーされるかどうかを示します。

true。

Status

boolean

有効化ステータス。有効な値:

  • false: 無効。

  • true: 有効。

true。

RedirectUrl

string

権限付与成功後のリダイレクト URL。OIDC/IDaaS で使用されます。この URL は OIDC/IDaaS で設定されたリダイレクト URL と一致している必要があります。

https://yourドメイン/path

ClientId

string

サービスに登録されたアプリケーション ID。OIDC/IDaaS で使用されます。

example-app。

ClientSecret

string

サービスに登録されたアプリケーションシークレット。OIDC/IDaaS で使用されます。

xxxxx。

CookieDomain

string

Cookie ドメイン名。認証成功后、ログイン状態を維持するために指定されたドメイン名に Cookie が送信されます。OIDC/IDaaS で使用されます。

test.com。

ScopesList

array

OIDC スコープ。OIDC で使用されます。

string

OIDC スコープ。OIDC で使用されます。

openid。

LoginUrl

string

IDaaS インスタンスのログインページ URL。IDaaS で使用されます。

https://daxxxxcn.aliyunidaas.com/

例

成功レスポンス

JSONJSON

{
  "RequestId": "316F5F64-F73D-42DC-8632-01E308B6****",
  "HttpStatusCode": 200,
  "Message": "OK",
  "Code": 200,
  "Success": true,
  "Data": {
    "Id": 120,
    "Name": "test",
    "GatewayUniqueId": "gw-e2d226bba4b2445c9e29fa7f8216****",
    "GatewayId": 399,
    "Type": "JWT",
    "Issuer": "https://example.com/auth",
    "Jwks": "{\n      \"keys\": [\n            {\n                  \"e\": \"AQAB\",\n                  \"kid\": \"DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ\",\n                  \"kty\": \"RSA\",\n                  \"n\": \"xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ\"\n            }\n      ]\n}",
    "IsWhite": true,
    "GmtCreate": "2022-01-07 18:07:57",
    "GmtModified": "2022-01-07 18:07:57",
    "TokenPosition": "HEADER",
    "TokenName": "Authorization",
    "TokenNamePrefix": "Bearer ",
    "TokenPass": true,
    "Status": true,
    "RedirectUrl": "https://yourdomain/path",
    "ClientId": "example-app",
    "ClientSecret": "xxxxx",
    "CookieDomain": "test.com",
    "ScopesList": [
      "openid"
    ],
    "LoginUrl": "https://daxxxxcn.aliyunidaas.com/"
  }
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 IllegalRequest Invalid request:%s
400 InvalidParameter Parameter error:%s
500 InternalError Console error. Try again later:%s
403 NoPermission You are not authorized to perform this operation:%s
404 NotFound Not found:%s

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。