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

Microservices Engine:UpdateGatewayOption

最終更新日:Dec 16, 2025

ゲートウェイの構成を更新します。

今すぐお試しください

この 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:UpdateGatewayOption

update

*Gateway

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

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

GatewayId

integer

任意

ゲートウェイの ID。

421

GatewayOption GatewayOption

任意

ゲートウェイの詳細な構成。

  • TraceDetails:Managed Service for OpenTelemetry のサンプリング設定。TraceEnabled は Managed Service for OpenTelemetry を有効にするかどうかを示し、Sample はサンプリングレートを示します。

  • LogConfigDetails:Simple Log Service の設定。LogEnabled は Simple Log Service を有効にするかどうかを示し、ProjectName はログの配信先となる Simple Log Service プロジェクトを示し、LogStoreName は Logstore の名前を示します。

  • EnableHardwareAcceleration:ハードウェアアクセラレーションを有効にするかどうかを示します。

  • DisableHttp2Alpn:HTTP/2 プロトコルを無効にするかどうかを示します。

  • EnableWaf:Web Application Firewall (WAF) を有効にするかどうかを示します。

GatewayUniqueId

string

必須

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

gw-83b0ddb569434f82b9fe8e4c60c4****

AcceptLanguage

string

任意

レスポンスの言語。有効な値:

  • zh:中国語

  • en:英語

zh

レスポンスフィールド

フィールド

説明

object

レスポンスパラメーター。

RequestId

string

リクエストの ID。

124D02EB-DBDD-534D-A701-B4A95D3D****

HttpStatusCode

integer

返される HTTP ステータスコード。

200

Message

string

返されるメッセージ。

  • リクエストが成功した場合、成功メッセージが返されます。

  • リクエストが失敗した場合、エラーメッセージが返されます。

The request is successfully processed.

Code

integer

返される状態コード。

200

Success

boolean

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

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

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

true

Data GatewayOption

返されたデータ。

{'LogConfigDetails': {'LogEnabled': True}, 'TraceDetails': {'Sample': 17, 'TraceEnabled': True}}

成功レスポンス

JSONJSON

{
  "RequestId": "124D02EB-DBDD-534D-A701-B4A95D3D****",
  "HttpStatusCode": 200,
  "Message": "The request is successfully processed.\n",
  "Code": 200,
  "Success": true,
  "Data": {
    "TraceDetails": {
      "TraceEnabled": true,
      "Sample": 10,
      "TraceType": "XTRACE",
      "ServiceId": 10458,
      "ServicePort": "80"
    },
    "LogConfigDetails": {
      "LogEnabled": true,
      "ProjectName": "project",
      "LogStoreName": "name"
    },
    "EnableHardwareAcceleration": true,
    "DisableHttp2Alpn": true,
    "EnableWaf": true
  }
}

エラーコード

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

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

変更履歴

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