DescribeInstanceSSL - ApsaraDB for OceanBase (Deprecated) - Alibaba Cloud ドキュメントセンター

OceanBase クラスターの SSL 詳細を照会します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

oceanbase:DescribeInstanceSSL

none

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	OceanBase クラスター ID。	ob317v4uif****
TenantId	string	任意	OceanBase テナント ID。

レスポンスフィールド

フィールド	型	説明	例
	object	返却データ。
RequestId	string	リクエスト ID。	EE205C00-30E4-xxxx-xxxx-87E3A8A2AA0C
InstanceSSL	object	インスタンス SSL の詳細。
InstanceId	string	OceanBase クラスター ID。	ob317v4uif****
EnableSSL	string	SSL リンク暗号化が有効かどうか。有効な値は次のとおりです。	OPEN
ValidPeriod	string	有効期限。	2024-09-20 07:55:03.0
CaUrl	string	CA 証明書の URL。	https://xxxx
Status	string	SSL のステータス。	RUNNING
ForceSSLSupport	boolean	強制 SSL がサポートされているかどうか。	false
ForceSSL	string	強制 SSL のステータス。	CLOSE
AutoUpdate	string	SSL 証明書の自動更新が有効かどうか。有効な値は次のとおりです。列挙値: CLOSE : Automatic update is disabled. OPEN : Automatic update is enabled.	OPEN
TenantId	string	OceanBase テナント ID。
CertValid	boolean	証明書が現在有効かどうか。

例

成功レスポンス

JSONJSON

{
  "RequestId": "EE205C00-30E4-xxxx-xxxx-87E3A8A2AA0C",
  "InstanceSSL": {
    "InstanceId": "ob317v4uif****",
    "EnableSSL": "OPEN",
    "ValidPeriod": "2024-09-20 07:55:03.0",
    "CaUrl": "https://xxxx",
    "Status": "RUNNING",
    "ForceSSLSupport": false,
    "ForceSSL": "CLOSE",
    "AutoUpdate": "OPEN",
    "TenantId": "",
    "CertValid": false
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
500	InternalError	The request processing has failed due to some unknown error.

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

変更履歴

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