Estimating the Price of an Execution Plan

project_id

Yes

String

A project ID is obtained by calling an API or from the console.

Obtaining a Project ID

Minimum: 3

Maximum: 64

stack_name

Yes

String

A stack name is unique within its domain (domain_id), region, and project (project_id). It is case-sensitive and starts with a letter. Only letters, digits, underscores (_), and hyphens (-) are allowed.

Minimum: 1

Maximum: 128

execution_plan_name

Yes

String

An execution plan name is unique within its domain (domain_id), region, project (project_id), and stack (stack_id). It is case-sensitive and starts with a letter. Only letters, digits, underscores (_), and hyphens (-) are allowed.

Minimum: 1

Maximum: 128

stack_id

No

String

Unique stack ID.

It is a UUID generated by RFS when a stack is created.

Stack names are unique at one specific time, so you can create a stack named HelloWorld and another stack with the same name after deleting the first one.

For parallel development, team members may want to ensure that they are operating the stack they created, not one with the same name created by other members after deleting the previous one.

To avoid this mismatch, check the ID, since RFS ensures each stack has a unique ID that does not change with updates. If the stack_id value differs from the current stack ID, 400 is returned.

Minimum: 36

Maximum: 36

execution_plan_id

No

String

Unique execution plan ID.

A UUID is generated by RFS when an execution plan is created.

Execution plan names are unique at one specific time, so you can create an execution plan named HelloWorld and another execution plan with the same name after deleting the first one.

For parallel development, team members may want to ensure that they are operating the execution plan they created, not one with the same name created by other members after deleting the previous one.

To avoid this mismatch, check the ID, since RFS ensures each execution plan has a unique ID that does not change with updates. If the execution_plan_id value differs from the current execution plan ID, 400 is returned.

Minimum: 36

Maximum: 36

Client-Request-Id

Yes

String

A unique request ID is specified by a user to locate a request. UUID is recommended.

Minimum: 36

Maximum: 128

currency

String

Currency, which can be:

• CNY: used on Huawei Cloud Chinese Mainland website.

• USD: used on Huawei Cloud International website.

Enumeration values:

• CNY

• USD

items

Array of ItemsResponse objects

Inquiry results of all resources in an execution plan.

resource_type

String

Resource type.

For example, in the following HCL template, the value of resource_type is huaweicloud_vpc.

resource "huaweicloud_vpc" "my_hello_world_vpc" {
  name = "test_vpc"
}

In a JSON template, the value of resource_type is huaweicloud_vpc.

{
  "resource": {
    "huaweicloud_vpc": {
      "my_hello_world_vpc": {
        "name": "test_vpc"
      }
    }
  }
}

resource_name

String

Resource name. The default value is the logical name of a resource.

For example, in the following HCL template, the value of resource_name is my_hello_world_vpc.

resource "huaweicloud_vpc" "my_hello_world_vpc" {
  name = "test_vpc"
}

In a JSON template, the value of resource_name is my_hello_world_vpc.

{
  "resource": {
    "huaweicloud_vpc": {
      "my_hello_world_vpc": {
        "name": "test_vpc"
      }
    }
  }
}

index

String

Resource index. If count or for_each is used in a template, index is returned. If index appears, resource_name and index can be used to identify a resource. If count is used in a template, index is a number starting from 0.

For example, in the following HCL template, huaweicloud_vpc.my_hello_world_vpc[0] and huaweicloud_vpc.my_hello_world_vpc[1] identify two resources.

resource "huaweicloud_vpc" "my_hello_world_vpc" {
  count = 2
  name = "test_vpc"
}

In a JSON template, huaweicloud_vpc.my_hello_world_vpc[0] and huaweicloud_vpc.my_hello_world_vpc[1] identify two resources.

{
  "resource": {
    "huaweicloud_vpc": {
      "my_hello_world_vpc": {
        "name": "test_vpc",
        "count": 2
      }
    }
  }
}

If for_each is used in a template, index is a user-defined string. For example, in the following HCL template, huaweicloud_vpc.my_hello_world_vpc["vpc1"] and huaweicloud_vpc.my_hello_world_vpc["vpc2"] identify two resources.

resource "huaweicloud_vpc" "my_hello_world_vpc" {
  for_each = {
    "vpc1" = "test_vpc"
    "vpc2" = "test_vpc"
  }
  name = each.value
}

In a JSON template, huaweicloud_vpc.my_hello_world_vpc["vpc1"] and huaweicloud_vpc.my_hello_world_vpc["vpc2"] identify two resources.

{
  "resource": {
    "huaweicloud_vpc": {
      "my_hello_world_vpc": {
        "for_each": {
          "vpc1": "test_vpc",
          "vpc2": "test_vpc"
        }
        "name": "${each.value}"
      }
    }
  }
}

supported

Boolean

Whether price inquiry is supported for the resource or its variables.

unsupported_message

String

Causes for not supporting price inquiry.

resource_price

Array of ResourcePriceResponse objects

Price inquiry information of the resource.

If the resource supports yearly/monthly or pay-per-use billing, or the resource is free of charge, this field is returned. If the resource does not support price inquiry, this field is not returned.

charge_mode

String

Billing mode.

• PRE_PAID: yearly/monthly

• POST_PAID: pay-per-use

• FREE: free of charge

Enumeration values:

• PRE_PAID

• POST_PAID

• FREE

sale_price

Double

Final price of the resource (only website, commercial, and partner discounts are considered, and promotion discounts and coupons are excluded). The value is rounded up to two decimal places. The default currency is USD.

discount

Double

Total discounted price of the resource. The value is rounded up to two decimal places. The default currency is USD.

original_price

Double

Original price of the resource. The value is rounded up to two decimal places. The default currency is USD.

period_type

String

Billing unit.

If the resource supports yearly/monthly or pay-per-use billing, this field is returned. If the resource is free of charge, this field is not returned.

• HOUR: hour, unit of the pay-per-use billing mode.

• DAY: day, unit of the pay-per-use billing mode.

• MONTH: month, unit of the yearly/monthly billing mode.

• YEAR: year, unit of the yearly/monthly billing mode.

• BYTE: byte, unit of the pay-per-use billing mode.

• MB: megabyte, unit of the yearly/monthly and pay-per-use billing modes.

• GB: gigabyte, unit of the yearly/monthly and pay-per-use billing modes.

Enumeration values:

• HOUR

• DAY

• MONTH

• YEAR

• BYTE

• MB

• GB

period_count

Integer

Billed amount of the resource. This parameter must be used together with period_type.

If the resource is billed in yearly/monthly or pay-per-use mode, this field is returned. If the resource is free of charge, this field is not returned.

• For pay-per-use resources, 1 is returned by default, indicating the price of the resource in one billing unit.

• For yearly/monthly-billed resources, the value of this parameter is the same as that of the period field in the template.

error_code

String

Response code.

Minimum: 11

Maximum: 11

error_msg

String

Response message.

encoded_authorization_message

String

The message contains information about unauthorized requests.

error_code

String

Response code.

Minimum: 11

Maximum: 11

error_msg

String

Response message.

encoded_authorization_message

String

The message contains information about unauthorized requests.

error_code

String

Response code.

Minimum: 11

Maximum: 11

error_msg

String

Response message.

encoded_authorization_message

String

The message contains information about unauthorized requests.

error_code

String

Response code.

Minimum: 11

Maximum: 11

error_msg

String

Response message.

encoded_authorization_message

String

The message contains information about unauthorized requests.

error_code

String

Response code.

Minimum: 11

Maximum: 11

error_msg

String

Response message.

encoded_authorization_message

String

The message contains information about unauthorized requests.

error_code

String

Response code.

Minimum: 11

Maximum: 11

error_msg

String

Response message.

encoded_authorization_message

String

The message contains information about unauthorized requests.

200

Price inquired.

400

Invalid request.

401

Authentication failed.

403

The user does not have the permission to call this API.

404

The execution plan does not exist.

429

Too frequent requests.

500

Internal server error.