DescribeInstanceGrantedRules--云企业网-火山引擎

文档中心

立即注册

导航

DescribeInstanceGrantedRules

最近更新时间：2024.07.24 11:45:33首次发布时间：2022.04.28 07:28:31

调用 DescribeInstanceGrantedRules 接口，查询本账号网络实例授权给其他账号云企业网实例的信息。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	DescribeInstanceGrantedRules	要执行的操作，取值为DescribeInstanceGrantedRules。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
InstanceRegionId	String	否	cn-beijing	网络实例所在的地域。
InstanceType	String	否	VPC	网络实例的类型，取值如下： VPC：私有网络。 DCGW：专线网关
InstanceId	String	否	vpc-3rlkeggyn6tc010e****	网络实例的ID。您可以调用DescribeVpcs接口获取“VPC”类型网络实例的ID。您可以调用DescribeDirectConnectGateways接口获取“DCGW”类型网络实例的ID。
PageNumber	Integer	否	1	列表的页码。默认值为1。
PageSize	Integer	否	20	分页查询时每页的行数。取值范围为1～100，默认值为20。

返回参数

参数名称	类型	示例值	描述
TotalCount	Integer	1	满足指定条件的网络实例的跨账号授权信息总数。
PageNumber	Integer	1	列表的页码。默认值为1。
PageSize	Integer	20	分页查询时每页的行数。取值范围为1～100，默认值为20。
CenGrantRules	Array of Struct	-	网络实例的跨账号授权信息。具体请参见下表“CenGrantRule结构”。

CenGrantRule结构

参数名称	类型	示例值	描述
InstanceRegionId	String	cn-beijing	网络实例所在的地域。
InstanceType	String	VPC	网络实例的类型，取值如下： VPC：私有网络。 DCGW：专线网关
InstanceId	String	vpc-3rlkeggyn6tc010e****	网络实例的ID。
CenOwnerId	String	210000****	已被授权的云企业网实例所属账号的ID。
CenId	String	cen-9gsm1q2yh1prpt****	已被授权的云企业网实例的ID。
CreationTime	String	2019-11-15T09:26:36Z	网络实例授权时间。

请求示例

GET /?Action=DescribeInstanceGrantedRules&Version=2020-04-01&InstanceId=vpc-3rlkeggyn6tc010e****&InstanceType=VPC HTTP/1.1
Host: open.volcengineapi.com
Service: cen
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202111161611080102121461940900****",
        "Action": "DescribeInstanceGrantedRules",
        "Version": "2020-04-01",
        "Service": "cen",
        "Region": "cn-beijing"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount":1,
        "CenGrantRules": [
            {
                "CenId": "cen-9gsm1q2yh1prpt****",
                "CenOwnerId": "210000****",
                "CreationTime": "2019-11-15T09:26:36Z",
                "InstanceId": "vpc-3rlkeggyn6tc010e****",
                "InstanceType": "VPC",
                "InstanceRegionId": "cn-beijing"
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HttpCode	错误码	错误信息	描述
400	InvalidPage.Malformed	The specified page is malformed.	指定的分页参数不合法。