DescribeHubClusterDetails API 権限と承認 - Distributed Cloud Container Platform for Kubernetes (ACK One)

ACK One フリートの詳細を説明します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

adcp:DescribeHubClusterDetails

get

*Cluster

acs:adcp:{#regionId}:{#accountId}:cluster/{#ClusterId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ClusterId	string	必須	フリート ID。	c676decda7b8148d69a9aba751877****

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	52C1B7DF-96C1-5214-97B6-1B0859FEAFE5
Cluster	object	クラスターの詳細。
Endpoints	object	クラスターのエンドポイント。
IntranetApiServerEndpoint	string	API サーバーの内部エンドポイント。	https://172.16.6.**:6443
PublicApiServerEndpoint	string	API サーバーのパブリックエンドポイント。	https://123.57.21.***:6443
ClusterInfo	object	クラスターの詳細。
Profile	string	クラスターの構成。	Default
CreationTime	string	クラスターが作成された時刻。	2022-03-23T06:22:28Z
UpdateTime	string	クラスターが最後に更新された時刻。	2022-03-21T02:51:35.542Z
ErrorMessage	string	クラスターの作成に失敗した場合に返されるエラーメッセージ。	The specified product does not exist.
Version	string	クラスターのバージョン。	1.22.3-aliyun.1
State	string	クラスターのステータス。有効な値: initial: クラスターは初期化中です。 failed: クラスターの作成に失敗しました。 running: クラスターは実行中です。 inactive: クラスターはアクティブ化を保留中です。 deleting: クラスターは削除中です。 delete_failed: クラスターの削除に失敗しました。 deleted: クラスターは削除されました。	running
ClusterId	string	フリート ID。	cb09fda0dc2f94a8397c76638c7ecf***
Name	string	クラスターの名前。	ackone-heyuan
RegionId	string	クラスターが存在するリージョンの ID。	cn-beijing
ClusterSpec	string	クラスターの仕様。 ack.pro.small: Basic Edition	ack.pro.small
MetaData	object	メタデータ。
ACKOne	object	ACK One フリートのメタデータ。
GitOps	object	ACK One GitOps のメタデータ。
Enabled	boolean	GitOps が有効かどうかを示します。有効な値: true: GitOps は有効です。 false: GitOps は無効です。	true
HAEnabled	boolean	GitOps で高可用性 (HA) が有効かどうかを示します。有効な値: true: HA は有効です。 false: HA は無効です。	true
PublicAccessEnabled	boolean	ArgoCD コンソールのパブリックドメイン名の名前解決が有効かどうかを示します。有効な値: true: パブリックドメイン名の名前解決は有効です。 false: パブリックドメイン名の名前解決は無効です。	true
AccessControlList	array	パブリックネットワークアクセスのアクセス制御リスト (ACL)。このパラメーターは、PublicAccessEnabled が true に設定されている場合にのみ有効です。
	string	パブリックネットワークアクセスの ACL。このパラメーターは、PublicAccessEnabled が true に設定されている場合にのみ有効です。	["192.168.0.0/16"]
WorkFlow	object	ACK One ワークフローのメタデータ。
ArgoWorkflow	object	ACK One ワークフローのメタデータ。
Enabled	boolean	ワークフロー構成が有効かどうかを示します。有効な値: true: ワークフロー構成は有効です。 false: ワークフロー構成は無効です。	true
ServerEnabled	string	Argo Server UI が有効かどうかを示します。有効な値: true: Argo Server UI は有効です。 false: Argo Server UI は無効です。	true
PublicAccessEnabled	boolean	Argo Workflow コンソールのパブリックドメイン名の名前解決が有効かどうかを示します。有効な値: true: パブリックドメイン名の名前解決は有効です。 false: パブリックドメイン名の名前解決は無効です。	true
AccessControlList	array	パブリックネットワークアクセスの ACL。このパラメーターは、PublicAccessEnabled が true に設定されている場合にのみ有効です。
	string	パブリックネットワークアクセスの ACL。このパラメーターは、PublicAccessEnabled が true に設定されている場合にのみ有効です。	["192.168.0.0/16"]
ResourceGroupID	string	リソースグループ ID。	rg-2nnnd0b6q37***
Tags	array<object>	タグのリスト。
	object	タグ。
Key	string	タグのキー。	user_resource
Value	string	タグの値。	gfggfwq-697
Network	object	クラスターのネットワーク構成。
VpcId	string	VPC の ID。	vpc-f8ziib1019r9o0hdv2***
VSwitches	array	vSwitch のリスト。
	string	vSwitch ID。	["vsw-f8zubs2z9x1cjnzk29***"]
SecurityGroupIDs	array	関連付けられているセキュリティグループの ID。
	string	関連付けられているセキュリティグループの ID。	["sg-f8zubs2z9x1cj***"]
IPStack	string	サポートされている IP バージョン。有効な値: ipv4: IPv4 ipv6: IPv6 dual: IPv4 および IPv6	ipv4
ClusterDomain	string	クラスターのドメイン名。	cluster.local
ApiServer	object	API サーバーに関する情報。
EnabledPublic	boolean	API サーバーのパブリックエンドポイントが有効かどうかを示します。有効な値: true: パブリックエンドポイントは有効です。 false: パブリックエンドポイントは無効です。	true
LoadBalancerId	string	Server Load Balancer (SLB) インスタンスの ID。	lb-hp3ioqbfeq37h13rwe***
ApiServerEipId	string	EIP ID。	eip-abc****
MeshConfig	object	Service Mesh (ASM) インスタンスの構成。
EnableMesh	boolean	Service Mesh (ASM) が有効かどうかを示します。有効な値: true: ASM は有効です。 false: ASM は無効です。	false
MeshId	string	Service Mesh (ASM) インスタンスの ID。	cb09fda0dc2f94a8397c76638c7ecf***
LogConfig	object	ログ構成。
EnableLog	boolean	監査ログ機能が有効かどうかを示します。有効な値: true: 監査ログ機能は有効です。 false: 監査ログ機能は無効です。	false
LogProject	string	Simple Log Service プロジェクトの名前。	k8s-log-abc
LogStoreTTL	string	ログが保存される日数。	7
Conditions	array<object>	クラスター削除の条件のリスト。
	object	クラスター削除の条件。
Type	string	条件のタイプ。	DeletionProtection
Status	string	条件のステータス。有効な値: True: クラスターは削除できません。 False: クラスターは削除できます。 Unknown: ステータスは不明です。	True
Reason	string	条件の理由。	Successful
Message	string	削除条件に関連付けられているエラーメッセージ。	Successful
WorkflowConfig	object	ワークフロークラスターの構成。
ArgoServerEnabled	boolean	Argo Server UI が有効かどうかを示します。有効な値: true: Argo Server UI は有効です。 false: Argo Server UI は無効です。	true
WorkflowScheduleMode	string	ワークフローのスケジューリングモード。有効な値: cost-optimized: コスト優先 stock-optimized: 在庫優先	cost-optimized
PriceLimit	string	ワークフローペイロードの値幅制限。このパラメーターは、WorkflowScheduleMode が cost-optimized に設定されている場合にのみ有効です。	0.08
WorkflowUnits	array<object>	ワークフロークラスターのリージョン固有の構成のリスト。
	object	ワークフロークラスターのリージョン固有の構成。
RegionId	string	リージョン ID。	cn-beijing
VpcId	string	VPC の ID。	vpc-f8zukabbkv5aw7zkm****
VSwitches	array<object>	ワークフロークラスターの vSwitch のリスト。
	object	ワークフロークラスターの vSwitch。
VswitchId	string	vSwitch ID。	vsw-wz9sf0hsuizl7bxnj****
ZoneId	string	ゾーン ID。	cn-hangzhou-e

例

成功レスポンス

JSONJSON

{
  "RequestId": "52C1B7DF-96C1-5214-97B6-1B0859FEAFE5",
  "Cluster": {
    "Endpoints": {
      "IntranetApiServerEndpoint": "https://172.16.6.**:6443",
      "PublicApiServerEndpoint": "https://123.57.21.***:6443"
    },
    "ClusterInfo": {
      "Profile": "Default",
      "CreationTime": "2022-03-23T06:22:28Z",
      "UpdateTime": "2022-03-21T02:51:35.542Z",
      "ErrorMessage": "The specified product does not exist.",
      "Version": "1.22.3-aliyun.1",
      "State": "running",
      "ClusterId": "cb09fda0dc2f94a8397c76638c7ecf***",
      "Name": "ackone-heyuan",
      "RegionId": "cn-beijing",
      "ClusterSpec": "ack.pro.small ",
      "MetaData": {
        "ACKOne": {
          "GitOps": {
            "Enabled": true,
            "HAEnabled": true,
            "PublicAccessEnabled": true,
            "AccessControlList": [
              "[\"192.168.0.0/16\"]"
            ]
          },
          "WorkFlow": {
            "ArgoWorkflow": {
              "Enabled": true,
              "ServerEnabled": "true",
              "PublicAccessEnabled": true,
              "AccessControlList": [
                "[\"192.168.0.0/16\"]\n"
              ]
            }
          }
        }
      },
      "ResourceGroupID": "rg-2nnnd0b6q37***",
      "Tags": [
        {
          "Key": "user_resource",
          "Value": "gfggfwq-697"
        }
      ]
    },
    "Network": {
      "VpcId": "vpc-f8ziib1019r9o0hdv2***",
      "VSwitches": [
        "[\"vsw-f8zubs2z9x1cjnzk29***\"]"
      ],
      "SecurityGroupIDs": [
        "[\"sg-f8zubs2z9x1cj***\"]"
      ],
      "IPStack": "ipv4",
      "ClusterDomain": "cluster.local"
    },
    "ApiServer": {
      "EnabledPublic": true,
      "LoadBalancerId": "lb-hp3ioqbfeq37h13rwe***",
      "ApiServerEipId": "eip-abc****"
    },
    "MeshConfig": {
      "EnableMesh": false,
      "MeshId": "cb09fda0dc2f94a8397c76638c7ecf***\n"
    },
    "LogConfig": {
      "EnableLog": false,
      "LogProject": "k8s-log-abc",
      "LogStoreTTL": "7"
    },
    "Conditions": [
      {
        "Type": "DeletionProtection",
        "Status": "True",
        "Reason": "Successful",
        "Message": "Successful"
      }
    ],
    "WorkflowConfig": {
      "ArgoServerEnabled": true,
      "WorkflowScheduleMode": "cost-optimized",
      "PriceLimit": "0.08",
      "WorkflowUnits": [
        {
          "RegionId": "cn-beijing",
          "VpcId": "vpc-f8zukabbkv5aw7zkm****",
          "VSwitches": [
            {
              "VswitchId": "vsw-wz9sf0hsuizl7bxnj****",
              "ZoneId": "cn-hangzhou-e"
            }
          ]
        }
      ]
    }
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	Cluster.NotFound	Cluster Not Found

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

変更履歴

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