Gunakan ListProvisionedProductPlans untuk mengkueri daftar rencana produk yang disediakan - Service Catalog - Alibaba Cloud - Service Catalog

Mengkueri daftar plan. Anda dapat mengkueri plan dari dimensi pengguna akhir atau dari dimensi peninjauan.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

servicecatalog:ListProvisionedProductPlans

list

*全部资源

*

servicecatalog:UserLevel
servicecatalog:ApprovalActor

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Filters	array<object>	No	Array yang terdiri dari kondisi filter.
	object	No
Key	string	No	The name of the filter condition. Valid values: ProvisionedProductPlanName: performs exact matches by plan name. Plan names are not case-sensitive. ProvisionedProductPlanApprover: performs exact matches by reviewer. You must specify a reviewer in the `RamUser/RamRole:<Name of the reviewer>` format. You can specify multiple reviewers. ProvisionedProductPlanApproverName: performs matches by reviewer name. You must specify the Resource Access Management (RAM) entity name of the reviewer. You can specify multiple reviewer names. ProvisionedProductPlanStatus: performs matches by plan status. You must specify the state of the plan. You can specify multiple states. ProvisionedProductPlanOwnerUid: performs exact matches by ID of Alibaba Cloud account to which a plan belongs. FullTextSearch: performs fuzzy full-text searches by plan name.	FullTextSearch
Value	string	No	The value of the filter condition.	ECS
SortBy	string	No	Informasi yang digunakan untuk mengurutkan hasil kueri. Tetapkan nilai ke CreateTime, yang menentukan waktu pembuatan plan.	CreateTime
SortOrder	string	No	Urutan pengurutan hasil kueri. Nilai valid: Asc: urutan menaik Desc (default): urutan menurun. Valid values: Asc : Asc. Desc : Desc.	Desc
PageNumber	integer	No	Nomor halaman yang akan dikembalikan. Halaman dimulai dari halaman 1. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri yang akan dikembalikan pada setiap halaman. Nilai valid: 1 hingga 100. Nilai minimum: 1. Nilai default: 10.	10
AccessLevelFilter	string	No	Filter akses. Nilai valid: User (default): mengkueri plan yang dibuat oleh peminta saat ini. Account: mengkueri plan yang termasuk dalam akun Alibaba Cloud saat ini. ResourceDirectory: mengkueri plan yang termasuk dalam direktori sumber daya saat ini.	User
ApprovalFilter	string	No	Filter akses dari dimensi peninjauan. Nilai valid: ReceivedRequests: mengkueri plan yang menunggu peninjauan. ApprovalHistory: mengkueri riwayat peninjauan. AccountRequests: mengkueri semua plan yang termasuk dalam akun Alibaba Cloud saat ini. AccountRequests: mengkueri semua plan yang termasuk dalam akun Alibaba Cloud saat ini.	ReceivedRequests
ProvisionedProductId	string	No	ID instans produk.	pp-bp1ddg1n2a****

Elemen respons

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	0FEEF92D-4052-5202-87D0-3D8EC16F****
PlanDetails	array<object>	An array that consists of plans.
	array<object>
PlanId	string	The ID of the plan.	plan-bp18mmdh2u****
PlanName	string	The name of the plan.	DEMO-创建ECS-637****
PlanType	string	The type of the plan. The value is fixed as Ros, which indicates Resource Orchestration Service (ROS).	Ros
PortfolioId	string	The ID of the product portfolio.	port-bp1438kf2j****
ProductId	string	The ID of the product.	prod-bp1rtrnh2c****
ProductVersionId	string	The ID of the product version.	pv-bp19udk22v****
ProvisionedProductId	string	The ID of the product instance.	pp-bp1c35162d****
Parameters	array<object>	An array that consists of the parameters in the template.
	object
ParameterKey	string	The name of the parameter in the template.	role_name
ParameterValue	string	The value of the parameter in the template.	Test-8
ProvisionedProductName	string	The name of the product instance.	rds-MYSQL-875****
StackId	string	The ID of the ROS stack.	2599090a-309e-4306-b989-17ba66a9****
StackRegionId	string	The ID of the region to which the ROS stack belongs.	cn-hangzhou
Status	string	The state of the plan. Valid values: PreviewInProgress: The plan is being prechecked. PreviewSuccess: The precheck is successful. PreviewFailed: The precheck fails. ApplicationInProgress: The plan is being reviewed. ApplicationApproved: The plan is approved. ApplicationRejected: The approval is rejected. ExecuteInProgress: The plan is being run. ExecuteSuccess: The plan is run. ExecuteFailed: The plan fails to be run. Canceled: The plan is canceled.	PreviewSuccess
StatusMessage	string	The message returned for the state. Catatan This parameter is returned only when PreviewFailed or ExecuteFailed is returned for the Status parameter.	Create stack failed: Resource CREATE failed: terraform stack sc-146611588617**-pp-bp1ddg1n2a** failure...
CreateTime	string	The time when the plan was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2022-09-13T02:01:22Z
UpdateTime	string	The last time when the task was modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2022-07-18T06:02:35.075Z
Tags	array<object>	An array that consists of custom tags.
	object
Key	string	The key of the custom tag.	k1
Value	string	The value of the custom tag.	v1
OperationType	string	The purpose of the plan. Valid values: LaunchProduct: launches the product. This is the default value. UpdateProvisionedProduct: updates the information about the product instance. TerminateProvisionedProduct: terminates the product instance.	LaunchProduct
AssignedApprovers	array<object>	An array that consists of reviewers.
	object
PrincipalType	string	The type of the RAM entity of the reviewer. Valid values: RamUser: a RAM user RamRole: a RAM role	RamUser
PrincipalName	string	The RAM entity name of the reviewer.	endUser
ProductName	string	The name of the product.	创建ECS
Description	string	The description of the plan.	开发团队使用
OwnerPrincipalType	string	The type of the RAM entity to which the plan belongs. Valid values: RamUser: a RAM user RamRole: a RAM role	RamUser
OwnerPrincipalId	string	The ID of the RAM entity to which the plan belongs.	24477111603637****
OwnerPrincipalName	string	The name of the RAM entity to which the plan belongs.	enduser
Uid	string	The ID of the Alibaba Cloud account to which the plan belongs.	146611588617****
TotalCount	integer	The total number of entries returned.	16
PageNumber	integer	The page number of the returned page. Pages start from page 1. Default value: 1.	1
PageSize	integer	The number of entries returned per page. Valid values: 1 to 100. Minimum value: 1. Default value: 10.	10

Contoh

Respons sukses

JSONformat

{
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F****",
  "PlanDetails": [
    {
      "PlanId": "plan-bp18mmdh2u****",
      "PlanName": "DEMO-创建ECS-637****",
      "PlanType": "Ros",
      "PortfolioId": "port-bp1438kf2j****",
      "ProductId": "prod-bp1rtrnh2c****",
      "ProductVersionId": "pv-bp19udk22v****",
      "ProvisionedProductId": "pp-bp1c35162d****",
      "Parameters": [
        {
          "ParameterKey": "role_name",
          "ParameterValue": "Test-8"
        }
      ],
      "ProvisionedProductName": "rds-MYSQL-875****",
      "StackId": "2599090a-309e-4306-b989-17ba66a9****",
      "StackRegionId": "cn-hangzhou",
      "Status": "PreviewSuccess",
      "StatusMessage": "Create stack failed: Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...",
      "CreateTime": "2022-09-13T02:01:22Z",
      "UpdateTime": "2022-07-18T06:02:35.075Z",
      "Tags": [
        {
          "Key": "k1",
          "Value": "v1"
        }
      ],
      "OperationType": "LaunchProduct",
      "AssignedApprovers": [
        {
          "PrincipalType": "RamUser",
          "PrincipalName": "endUser"
        }
      ],
      "ProductName": "创建ECS",
      "Description": "开发团队使用",
      "OwnerPrincipalType": "RamUser",
      "OwnerPrincipalId": "24477111603637****\n",
      "OwnerPrincipalName": "enduser",
      "Uid": "146611588617****"
    }
  ],
  "TotalCount": 16,
  "PageNumber": 1,
  "PageSize": 10
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
500	InternalError	A system error occurred.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.