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

Microservices Engine:UpdateGatewayAuthConsumerStatus

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

*Gateway

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

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

GatewayUniqueId

string

必須

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

gw-685f661467b54f48b7b7a76605ce****

Id

integer

必須

コンシューマー ID。

1

ConsumerStatus

boolean

必須

コンシューマーのステータス。有効な値:

  • true:コンシューマーは有効です。

  • false:コンシューマーは無効です。

true

AcceptLanguage

string

任意

応答メッセージの言語。有効な値:

  • zh:中国語

  • en:英語

zh

レスポンスフィールド

フィールド

説明

object

RestResult<List>

RequestId

string

リクエスト ID。

56D9E600-6348-4260-B35F-583413F****

Success

boolean

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

  • true

  • false

true

Code

integer

応答コード。ステータスコード 200 は、リクエストが成功したことを示します。

200

ErrorCode

string

リクエストが失敗した場合に返されるエラーコード。

mse-100-000

HttpStatusCode

integer

HTTP ステータスコード。

200

Message

string

返されたメッセージ。

The request is successfully processed.

DynamicCode

string

エラーメッセージの動的な部分。

code

DynamicMessage

string

エラーメッセージの動的な部分。このパラメーターは、ErrMessage パラメーターの %s 変数を置き換えるために使用されます。

説明

ErrMessage パラメーターの戻り値が The Value of Input Parameter %s is not valid で、DynamicMessage パラメーターの戻り値が DtsJobId の場合、指定された DtsJobId パラメーターは無効であることを示します。

The specified parameter is invalid.

Data

boolean

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

  • true

  • false

true

成功レスポンス

JSONJSON

{
  "RequestId": "56D9E600-6348-4260-B35F-583413F****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "mse-100-000",
  "HttpStatusCode": 200,
  "Message": "The request is successfully processed.\n",
  "DynamicCode": "code",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": 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

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

変更履歴

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