DescribeServiceCronScaler によるサービス CronHPA 構成の確認 - PAI

サービスの Cron Horizontal Pod Autoscaler (CronHPA) 構成を照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

eas:DescribeServiceCronScaler

get

*Service

acs:eas:{#regionId}:{#accountId}:service/{#ServiceName}

なし

リクエスト構文

GET /api/v2/services/{ClusterId}/{ServiceName}/cronscaler HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
ClusterId	string	必須	サービスのリージョン ID。	cn-shanghai
ServiceName	string	必須	サービス名。サービス名の照会方法の詳細については、「ListServices」をご参照ください。	foo

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

リクエストパラメーターは必要ありません。

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	40325405-579C-4D82****
ServiceName	string	サービス名。	foo
ExcludeDates	array	CronHPA ジョブをスケジュールする際に除外される時点。時点は cron 式を使用して指定する必要があります。
	string	cron 式。	* * * * * 0,6
ScaleJobs	array<object>	CronHPA ジョブ。
	object
Schedule	string	CronHPA ジョブの実行時間を構成するために使用される cron 式。	0 18 * * * *
TargetSize	integer	CronHPA ジョブに構成する予定のインスタンス数。	1
Name	string	CronHPA ジョブの名前。	scale-job-1
Message	string	返されたメッセージ。	"cron hpa job scale-jobs-0 executed successfully. current replicas:3, desired replicas:2."
State	string	最新の CronHPA ジョブのステータス。	Succeed
LastProbeTime	string	最新の CronHPA ジョブが実行された時間。時刻は UTC で表示されます。	2022-02-24T06:31:00Z
CreateTime	string	最新の CronHPA ジョブが作成された時間。時刻は UTC で表示されます。	2020-06-24T02:11:30Z

例

成功レスポンス

JSONJSON

{
  "RequestId": "40325405-579C-4D82****",
  "ServiceName": "foo",
  "ExcludeDates": [
    "* * * * * 0,6\n"
  ],
  "ScaleJobs": [
    {
      "Schedule": "0 18 * * * *",
      "TargetSize": 1,
      "Name": "scale-job-1",
      "Message": "\"cron hpa job scale-jobs-0 executed successfully. current replicas:3, desired replicas:2.\"",
      "State": "Succeed",
      "LastProbeTime": "2022-02-24T06:31:00Z",
      "CreateTime": "2020-06-24T02:11:30Z"
    }
  ]
}

エラーコード

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

変更履歴

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