全部产品
Search
文档中心

专有网络 VPC:GetPublicIpAddressPoolServiceStatus - 查询IP地址池功能的开通状态

更新时间:Nov 13, 2024

调用GetPublicIpAddressPoolServiceStatus接口查询IP地址池功能的开通状态。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:GetPublicIpAddressPoolServiceStatusget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
123e4567-e89b-12d3-a456-426655442455
RegionIdstring

IP 地址池所属的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

54B48E3D-DF70-471B-AA93-06F82A1B457
Enabledboolean

IP 地址池功能是否开通。取值:

  • true:已开通。

  • false:未开通。您可以调用 OpenPublicIpAddressPoolService 接口开通 IP 地址池功能。

true

示例

正常返回示例

JSON格式

{
  "RequestId": "54B48E3D-DF70-471B-AA93-06F82A1B457",
  "Enabled": true
}

错误码

HTTP status code错误码错误信息描述
400Forbidden.RAMThe user is not authorized to operate on the specified resource, or the API operation does not support RAM.RAM校验不通过。

访问错误中心查看更多错误码。