调用GetDhcpOptionsSet接口查询已创建的DHCP选项集。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 GetDhcpOptionsSet

要执行的操作，取值：GetDhcpOptionsSet。

DhcpOptionsSetId String 是 dopt-o6w0df4epg9zo8isy****

要查询DHCP选项集的ID。
RegionId String 是 cn-hangzhou

要查询DHCP选项集所在的地域。您可以通过调用DescribeRegions接口获取地域ID。

返回数据

名称 类型 示例值 描述
AssociateVpcs Array

DHCP选项集关联的VPC的信息。
AssociateStatus String InUse

DHCP选项集关联的VPC的状态。

  • InUse：使用中。
  • Pending：配置中。
VpcId String vpc-eb3b54r6otues4tjj****

DHCP选项集关联的VPC的ID。
DhcpOptions Struct

DHCP选项配置信息。
DomainName String example.com

主机名后缀。
DomainNameServers String 192.xx.xx.123

DNS服务器IP。
DhcpOptionsSetDescription String test

DHCP选项集的描述。

DhcpOptionsSetId String dopt-o6w0df4epg9zo8isy****

DHCP选项集的ID。
DhcpOptionsSetName String test

DHCP选项集的名称。
OwnerId Long 12345678

DHCP选项集所属账号ID。
RequestId String 0ED8D006-F706-4D23-88ED-E11ED28DCAC0

请求ID。
Status String Available

DHCP选项集的状态。

  • Available：可用。
  • InUse：使用中。
  • Deleted：已删除。
  • Pending：配置中。

示例

请求示例

http(s)://[Endpoint]/?Action=GetDhcpOptionsSet
&DhcpOptionsSetId=dopt-o6w0df4epg9zo8isy****
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式 

<GetDhcpOptionsSetResponse>   
      <Status>InUse</Status>
      <DhcpOptionsSetId>dopt-eb3h8s3g21rujtc7z****</DhcpOptionsSetId>
      <DhcpOptions>
            <DomainNameServers>100.100.2.136,100.100.2.138</DomainNameServers>
      </DhcpOptions>
      <RequestId>80B26920-51E9-429D-9FC1-D1CF14967B9A</RequestId>
      <OwnerId>12345678</OwnerId>
      <DhcpOptionsSetName>jj</DhcpOptionsSetName>
      <AssociateVpcs>
            <VpcId>vpc-eb3b54r6otues4tjj****</VpcId>
            <AssociateStatus>InUse</AssociateStatus>
      </AssociateVpcs>
</GetDhcpOptionsSetResponse>

JSON 格式 

{
	"Status": "InUse",
	"DhcpOptionsSetId": "dopt-eb3h8s3g21rujtc7z****",
	"DhcpOptions": {
		"DomainNameServers": "100.100.2.136,100.100.2.138"
	},
	"RequestId": "80B26920-51E9-429D-9FC1-D1CF14967B9A",
	"OwnerId": "12345678",
	"DhcpOptionsSetName": "jj",
	"AssociateVpcs": [
		{
			"VpcId": "vpc-eb3b54r6otues4tjj****",
			"AssociateStatus": "InUse"
		}
	]
}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidRegionId.NotFound The specified RegionId does not exist. 指定的RegionId不存在。请检查该参数是否正确。

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