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

Microservices Engine:AddGatewayDomain

最終更新日: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:AddGatewayDomain

create

*Gateway

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

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

MustHttps

boolean

任意

HTTPS を有効にするかどうかを指定します。

true

CertIdentifier

string

任意

証明書の ID。

6828169-cn-hangzhou

Name

string

必須

ドメイン名。

test.com

Protocol

string

必須

プロトコルのタイプ。有効な値は次のとおりです:

  • HTTP

  • HTTPS

HTTP

GatewayUniqueId

string

必須

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

gw-86575c0bc9f04ecfbacb92b8e392****

Http2

string

任意

HTTP/2 を有効にするかどうかを指定します。

  • openHTTP/2 を有効にします

  • closeHTTP/2 を無効にします

  • globalConfig:グローバル構成を使用します

close

TlsMax

string

任意

Transport Layer Security (TLS) の最大バージョン。

TLS 1.3

TlsMin

string

任意

TLS の最小バージョン。

TLS 1.0

AcceptLanguage

string

任意

応答の言語。有効な値は次のとおりです:

  • zh: 中国語

  • en: 英語

zh

レスポンスフィールド

フィールド

説明

object

データ構造。

RequestId

string

リクエストの ID。

16BA802F-B848-55DF-9F57-CD71B7272D1F

HttpStatusCode

integer

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

200

Message

string

エラーメッセージ。

The request is successfully processed.

Code

integer

返された状態コード。

200

Success

boolean

リクエストが成功したかどうかを示します。有効な値は次のとおりです:

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

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

true

Data

integer

返されたデータ。

100

成功レスポンス

JSONJSON

{
  "RequestId": "16BA802F-B848-55DF-9F57-CD71B7272D1F",
  "HttpStatusCode": 200,
  "Message": "The request is successfully processed.\n",
  "Code": 200,
  "Success": true,
  "Data": 100
}

エラーコード

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

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

変更履歴

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