All Products
Search
Document Center

Service Catalog:GetProvisionedProductPlan

Last Updated:Jun 10, 2026

Mengkueri rencana produk yang telah disediakan.

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:GetProvisionedProductPlan

get

*ProvisionedProduct

acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/{#ProvisionedProductId}

  • servicecatalog:UserLevel
  • servicecatalog:ApprovalActor
None

Parameter permintaan

Parameter

Type

Required

Description

Example

PlanId

string

Yes

ID dari rencana tersebut.

plan-bp1jvmdk2k****

Elemen respons

Element

Type

Description

Example

object

Parameter respons.

RequestId

string

ID dari permintaan tersebut.

0FEEF92D-4052-5202-87D0-3D8EC16F81BF

PlanDetail

object

Detail dari rencana tersebut.

PlanId

string

ID dari rencana tersebut.

plan-bp1jvmdk2k****

PlanName

string

Nama dari rencana tersebut.

DEMO-ECS实例

PlanType

string

Jenis dari rencana tersebut.

Nilainya tetap berupa Ros, yang menunjukkan Resource Orchestration Service (ROS).

Ros

PortfolioId

string

ID dari portofolio produk.

port-bp1yt7582g****

ProductId

string

ID dari produk tersebut.

prod-bp18r7q127****

ProductVersionId

string

ID dari versi produk.

pv-bp15e79d26****

ProvisionedProductId

string

ID dari instans produk.

pp-bp1ddg1n2a****

ProvisionedProductName

string

Nama dari instans produk.

DEMO-ECS实例

Parameters

array<object>

Sebuah array yang terdiri dari parameter-parameter dalam template.

object

ParameterKey

string

The name of the input parameter for the template.

instance_type

ParameterValue

string

The value of the input parameter for the template.

ecs.s6-c1m1.small

StackId

string

ID dari stack ROS.

137e31df-3754-40b4-be2f-c793ad84****

StackRegionId

string

ID region tempat stack ROS berada.

cn-hangzhou

Status

string

Status dari rencana tersebut. Nilai yang valid:

  • PreviewInProgress: Rencana sedang dalam proses pra-pemeriksaan.

  • PreviewSuccess: Pra-pemeriksaan berhasil.

  • PreviewFailed: Pra-pemeriksaan gagal.

  • ApplicationInProgress: Rencana sedang dalam proses persetujuan.

  • ApplicationApproved: Rencana telah disetujui.

  • ApplicationRejected: Persetujuan ditolak.

  • ExecuteInProgress: Rencana sedang dijalankan.

  • ExecuteSuccess: Rencana telah dijalankan.

  • ExecuteFailed: Rencana gagal dijalankan.

  • Canceled: Rencana telah dibatalkan.

PreviewSuccess

StatusMessage

string

Pesan yang dikembalikan untuk status tersebut.

Catatan

Parameter ini hanya dikembalikan ketika nilai Status adalah PreviewFailed atau ExecuteFailed.

Create stack failed: Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...

CreateTime

string

Waktu ketika rencana tersebut dibuat.

Waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC.

2022-05-23T09:46:27Z

UpdateTime

string

Waktu terakhir ketika tugas tersebut dimodifikasi.

Waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC.

2022-05-23T09:47:29Z

Tags

array<object>

Sebuah array yang terdiri dari tag-tag kustom.

object

Key

string

The key of the custom tag.

k1

Value

string

The value of the custom tag.

v1

OperationType

string

Tujuan dari rencana tersebut. Nilai yang valid:

  • LaunchProduct: meluncurkan produk.

  • UpdateProvisionedProduct: memperbarui informasi tentang instans produk.

  • TerminateProvisionedProduct: menghentikan instans produk.

LaunchProduct

Description

string

Deskripsi dari rencana tersebut.

创建ECS。

AssignedApprovers

array<object>

Sebuah array yang terdiri dari peninjau.

object

PrincipalType

string

The type of the Resource Access Management (RAM) entity of the plan approver. Valid values:

  • RamUser: a RAM user.

  • RamRole: a RAM role.

RamUser

PrincipalName

string

The name of the RAM entity of the plan approver.

approver

OwnerPrincipalType

string

Jenis entitas RAM tempat rencana tersebut berada. Nilai yang valid:

  • RamUser: pengguna RAM

  • RamRole: peran RAM

RamUser

OwnerPrincipalId

string

ID entitas RAM tempat rencana tersebut berada.

27740196382623****

ApprovalDetail

object

Detail persetujuan dari rencana tersebut.

OperationRecords

array<object>

The operation records.

array<object>

Operator

object

The RAM entities that have performed operations on the plan.

PrincipalType

string

The type of the RAM entity. Valid values:

  • RamUser: a RAM user.

  • RamRole: a RAM role.

RamUser

PrincipalId

string

The ID of the RAM entity.

277401963826235***

PrincipalName

string

The name RAM entity that servers as the operator.

approver

Comment

string

The approval comment of the operator.

同意。

CreateTime

string

The time when the operation was performed.

2022-03-22T05:56:14Z

ApprovalAction

string

The operation that is performed by the operator on the plan. Valid values:

  • Submit: submits the plan.

  • Cancel: cancels the plan.

  • Approve: approves the plan.

  • reject: rejectes the plan.

Approve

TodoTaskActivities

array<object>

The operations that are being performed by the plan.

array<object>

ActivityName

string

The name of the operation that is being performed by the plan.

ApproverNode-1

Tasks

array<object>

The tasks that are pending for review.

array<object>

Operator

object

The RAM entities that can perform operations on the plan.

PrincipalType

string

The type of the RAM entity. Valid values:

  • RamUser: a RAM user.

  • RamRole: a RAM role.

RamUser

PrincipalName

string

The name of the RAM entity.

approver

OwnerPrincipalName

string

Nama entitas RAM tempat rencana tersebut berada.

endUser

Uid

string

ID akun Alibaba Cloud tempat rencana tersebut berada.

146611588617****

ProductDetail

object

Detail dari produk tersebut.

ProductArn

string

Alibaba Cloud Resource Name (ARN) dari produk tersebut.

acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****

Description

string

Deskripsi dari produk tersebut.

这是一个产品描述

CreateTime

string

Waktu pembuatan.

Waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC.

2022-04-12T06:10:37Z

ProductId

string

ID dari produk tersebut.

prod-bp18r7q127****

ProductName

string

Nama dari produk tersebut.

DEMO-创建ECS

ProviderName

string

Penyedia dari produk tersebut.

IT团队

ProductType

string

Jenis dari produk tersebut.

Nilainya tetap berupa Ros, yang menunjukkan ROS.

Ros

ResourceChanges

array<object>

Sebuah array yang terdiri dari sumber daya yang akan diubah dalam rencana tersebut.

object

LogicalResourceId

string

ID logis dari sumber daya tersebut.

instance

PhysicalResourceId

string

ID fisik dari sumber daya tersebut.

Catatan

Parameter ini dikembalikan jika nilai Action adalah Modify atau Remove.

i-bp13lmam3qd9q6il****

Replacement

string

Menunjukkan apakah pembaruan penggantian dilakukan pada template. Nilai yang valid:

  • True: Pembaruan penggantian dilakukan pada template.

  • False: Sebuah perubahan dilakukan pada template.

  • Conditional: Pembaruan penggantian mungkin dilakukan pada template. Anda dapat memeriksa apakah pembaruan penggantian dilakukan ketika template tersebut digunakan.

Catatan

Parameter ini dikembalikan jika nilai Action adalah Modify.

True

ResourceType

string

Jenis sumber daya.

alicloud_instance

Action

string

Tindakan yang dilakukan pada sumber daya tersebut. Nilai yang valid:

  • Add

  • Modify

  • Remove

  • None

Add

ProductVersionDetail

object

Detail dari versi produk.

Active

boolean

Menunjukkan apakah versi produk terlihat oleh pengguna akhir. Nilai yang valid:

  • true (default)

  • false

true

Description

string

Deskripsi dari versi produk.

这是一个产品版本描述

CreateTime

string

Waktu ketika versi produk dibuat.

Waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC.

2022-04-12T06:10:37Z

Guidance

string

Informasi rekomendasi. Nilai yang valid:

  • Default: Tidak ada informasi rekomendasi yang diberikan. Ini adalah nilai default.

  • Recommended: versi yang direkomendasikan.

  • Latest: versi terbaru.

  • Deprecated: versi yang akan segera tidak digunakan lagi.

Default

ProductVersionId

string

ID dari versi produk.

pv-bp15e79d26****

ProductVersionName

string

Nama untuk versi produk.

1.0.0

ProductId

string

ID produk tempat versi produk tersebut berada.

prod-bp18r7q127****

TemplateUrl

string

URL dari template tersebut.

oss://servicecatalog-cn-hangzhou/146611588617****/terraform/template/tpl-bp1217we23****/template.json

TemplateType

string

Jenis dari template tersebut.

Nilainya tetap berupa RosTerraformTemplate, yang menunjukkan bahwa template Terraform didukung oleh ROS.

RosTerraformTemplate

Contoh

Respons sukses

JSONformat

{
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F81BF",
  "PlanDetail": {
    "PlanId": "plan-bp1jvmdk2k****",
    "PlanName": "DEMO-ECS实例",
    "PlanType": "Ros",
    "PortfolioId": "port-bp1yt7582g****",
    "ProductId": "prod-bp18r7q127****",
    "ProductVersionId": "pv-bp15e79d26****",
    "ProvisionedProductId": "pp-bp1ddg1n2a****",
    "ProvisionedProductName": "DEMO-ECS实例",
    "Parameters": [
      {
        "ParameterKey": "instance_type",
        "ParameterValue": "ecs.s6-c1m1.small"
      }
    ],
    "StackId": "137e31df-3754-40b4-be2f-c793ad84****",
    "StackRegionId": "cn-hangzhou",
    "Status": "PreviewSuccess",
    "StatusMessage": "Create stack failed: Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...",
    "CreateTime": "2022-05-23T09:46:27Z",
    "UpdateTime": "2022-05-23T09:47:29Z",
    "Tags": [
      {
        "Key": "k1",
        "Value": "v1"
      }
    ],
    "OperationType": "LaunchProduct",
    "Description": "创建ECS。",
    "AssignedApprovers": [
      {
        "PrincipalType": "RamUser",
        "PrincipalName": "approver"
      }
    ],
    "OwnerPrincipalType": "RamUser",
    "OwnerPrincipalId": "27740196382623****",
    "ApprovalDetail": {
      "OperationRecords": [
        {
          "Operator": {
            "PrincipalType": "RamUser",
            "PrincipalId": "277401963826235***\n",
            "PrincipalName": "approver"
          },
          "Comment": "同意。",
          "CreateTime": "2022-03-22T05:56:14Z",
          "ApprovalAction": "Approve"
        }
      ],
      "TodoTaskActivities": [
        {
          "ActivityName": "ApproverNode-1",
          "Tasks": [
            {
              "Operator": {
                "PrincipalType": "RamUser",
                "PrincipalName": "approver"
              }
            }
          ]
        }
      ]
    },
    "OwnerPrincipalName": "endUser",
    "Uid": "146611588617****"
  },
  "ProductDetail": {
    "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"
  },
  "ResourceChanges": [
    {
      "LogicalResourceId": "instance",
      "PhysicalResourceId": "i-bp13lmam3qd9q6il****",
      "Replacement": "True",
      "ResourceType": "alicloud_instance\n",
      "Action": "Add"
    }
  ],
  "ProductVersionDetail": {
    "Active": true,
    "Description": "这是一个产品版本描述",
    "CreateTime": "2022-04-12T06:10:37Z",
    "Guidance": "Default",
    "ProductVersionId": "pv-bp15e79d26****",
    "ProductVersionName": "1.0.0",
    "ProductId": "prod-bp18r7q127****",
    "TemplateUrl": "oss://servicecatalog-cn-hangzhou/146611588617****/terraform/template/tpl-bp1217we23****/template.json",
    "TemplateType": "RosTerraformTemplate"
  }
}

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.