ListProductsAsAdmin を使用した製品の管理者としてのクエリ - Service Catalog

管理者としてプロダクトをクエリします。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

servicecatalog:ListProductsAsAdmin

get

*Product

acs:servicecatalog:{#regionId}:{#accountId}:product/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PortfolioId	string	任意	プロダクトポートフォリオの ID です。	port-bp1yt7582g****
Filters	array<object>	任意	フィルター条件です。
	object	任意
Key	string	任意	フィルター条件の名前です。有効な値は以下のとおりです。 ProductName：プロダクト名による完全一致検索を行います。プロダクト名は大文字小文字を区別しません。 FullTextSearch：プロダクト名、プロダクトプロバイダー、またはプロダクト説明による全文検索を行います。あいまい検索がサポートされます。	ProductName
Value	string	任意	フィルター条件の値です。	DEMO-创建ECS
SortBy	string	任意	クエリ結果の並べ替えに使用するフィールドです。値を CreateTime に設定すると、プロダクトが作成された時刻で並べ替えられます。	CreateTime
SortOrder	string	任意	クエリ結果の並べ替え順序です。有効な値は以下のとおりです。 Asc：昇順 Desc：降順	Desc
PageNumber	integer	任意	返されるページ番号です。ページ番号は 1 から始まります。デフォルト値は 1 です。	1
PageSize	integer	任意	各ページに返されるエントリ数です。有効な値は 1～100 です。デフォルト値は 10 です。	10
Scope	string	任意	クエリ範囲です。有効な値は以下のとおりです。 Local：現在のアカウントで作成されたプロダクトです（デフォルト値）。 Import：他のアカウントからインポートされたプロダクトです。 All：利用可能なすべてのプロダクトです。	Local

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーターです。
RequestId	string	リクエストの ID です。	0FEEF92D-4052-5202-87D0-3D8EC16F81BF
ProductDetails	array<object>	プロダクト情報です。
	object	プロダクトの詳細情報です。
ProductArn	string	Alibaba Cloud リソースネーム (ARN) です。	acs:servicecatalog:cn-hangzhou:146611588617**:product/prod-bp18r7q127**
Description	string	プロダクトの説明です。	这是一个产品描述
CreateTime	string	プロダクトが作成された時刻です。 ISO 8601 標準に従った YYYY-MM-DDThh:mm:ssZ 形式で表示され、UTC 時間です。	2022-04-12T06:10:37Z
ProductId	string	プロダクト ID です。	prod-bp18r7q127****
ProductName	string	プロダクト名です。	DEMO-创建ECS
ProviderName	string	プロダクトの提供者です。	IT团队
ProductType	string	プロダクトの種類です。値は Ros に固定されており、Resource Orchestration Service (ROS) を示します。	Ros
TemplateType	string	プロダクトテンプレートの種類です。有効な値は以下のとおりです。 RosTerraformTemplate：ROS がサポートする Terraform テンプレートです。 RosStandardTemplate：標準の ROS テンプレートです。	RosTerraformTemplate
TotalCount	integer	返されたエントリの合計数です。	2
PageNumber	integer	返されたページのページ番号です。	1
PageSize	integer	1 ページあたりに返されるエントリ数です。	10

例

成功レスポンス

JSONJSON

{
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F81BF",
  "ProductDetails": [
    {
      "ProductArn": "acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****",
      "Description": "这是一个产品描述",
      "CreateTime": "2022-04-12T06:10:37Z",
      "ProductId": "prod-bp18r7q127****",
      "ProductName": "DEMO-创建ECS",
      "ProviderName": "IT团队",
      "ProductType": "Ros",
      "TemplateType": "RosTerraformTemplate"
    }
  ],
  "TotalCount": 2,
  "PageNumber": 1,
  "PageSize": 10
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
500	InternalError	A system error occurred.

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

変更履歴

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