DescribeResourceShares - 查询共享单元--资源管理-火山引擎

文档中心

导航

DescribeResourceShares - 查询共享单元

最近更新时间：2025.03.03 16:21:37首次发布时间：2025.03.03 16:21:37

查询共享单元

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeResourceShares	要执行的操作，取值：DescribeResourceShares。
Version	String	是	2024-01-01	API的版本，取值：2024-01-01。
Name	String	否	sharexxx	资源共享的名称
ResourceOwner	String	是	SELF	查询类型，可传值 OTHER - 其他用户创建的资源共享单元；SELF - 自己创建的共享单元
PermissionTrn	String	否	trn:resource_share:::permission/RSDefaultPermissionSubnet	权限策略Trn
ResourceShareStatus	String	否	ACTIVE	共享单元状态，可传值 UNKNOWN - 未知状态；ACTIVE - 活跃状态；DELETING - 删除中；DELETED - 已删除；FAILED - 失败状态；NEW - 新建状态
NextToken	String	否	aljsakljca***asdjekdjqe	当前页的Token
MaxResults	Long	否	10	获取最大数量
ResourceShareTrns	Array of String	否	trn:resource_share:cn-beijing:2000000000:resource_share/rs-03119c96,trn:resource_share:cn-beijing:2000000000:resource_share/rs-03qoijio93j	资源共享Trn列表

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
ResourceShares	Array of Object	[ { "ResourceShareId": "rs-03119c96", "ResourceShareTrn": "trn:resource_share:cn-beijing:2000000000:resource_share/rs-03119c96", "CreateTime": "2025-02-25T13:58:54+08:00", "UpdateTime": "2025-02-25T13:58:54+08:00", "OwningAccountId": 2000000000, "ResourceShareName": "sharexxx", "AllowShareType": "ANY", "Status": "ACTIVE" } ]	共享单元列表
NextToken	String	aljsakljca***qoieq8jk	下一页的Token

请求示例

GET /?Action=DescribeResourceShares&Version=2024-01-01&Name=share-namexxx&ResourceOwner=SELF&ResourceShareTrns.1=trn:resource_share:cn-beijing:2000000000:resource_share/rs-049***400f
&ResourceShareStatus=ACTIVE&NextToken=akjdkdnj***kdjqwkd&MaxResults=10 HTTP/1.1
Host: x.y.z
X-Date: 20250225T054528Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250225/cn-beijing/resource_share/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20250225102228B1449CA5CF610464100D",
        "Action": "DescribeResourceShares",
        "Version": "2024-01-01",
        "Service": "resource_share",
        "Region": "cn-beijing"
    },
    "Result": {
        "ResourceShares": [
            {
                "ResourceShareName": "share-namexxx",
                "ResourceShareId": "rs-049***400f",
                "ResourceShareTrn": "trn:resource_share:cn-beijing:2000000000:resource_share/rs-049***400f",
                "OwningAccountId": 2000000000,
                "AllowShareType": "ANY",
                "CreateTime": "2024-12-27T16:21:39+08:00",
                "UpdateTime": "2025-02-24T21:58:30+08:00",
                "Status": "DELETED"
            }
        ],
        "NextToken": "eyJWZXJzaW9u***In0="
    }
}

错误码

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

状态码	错误码	错误信息	说明
400	InvalidParameter	Parameter [%s] is invalid, error: %v	无效的参数，具体无效的参数在会在Error Message中给出
400	MissingParameter	Required parameter[%v] is not found	参数缺失，具体缺失的参数在会在Error Message中给出
404	ResourceShareNotFound	resource-share[%v] not found	找不到共享单元，传入的共享单元Trn不存在，或已被删除
500	InternalError	Something went wrong in internal service, please try again later	服务内部系统错误，往往是由服务内部组件异常、网络异常或服务自身bug导致，请及时联系相关管理员进行排查确认